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

# Simulations 2.0 — Card Transactions

> Marqeta's Simulations API allows you to simulate API calls and review responses.

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 <span className={`
          method-pill rounded-lg font-semibold px-1.5 py-0.5 text-xs leading-5 ${style.bg} ${style.text}`}>
        {method?.toUpperCase()}
      </span>;
  };
  const content = <div className="group flex items-center gap-4 border border-gray-200 dark:border-gray-700 rounded-xl p-5 hover:border-gray-400 dark:hover:border-gray-500 hover:shadow-md transition-all cursor-pointer">
      {}
      <div className="shrink-0">
        <MethodBadge method={method} />
      </div>
      {}
      <div className="flex-1 min-w-0">
        <p className="font-semibold text-gray-900 dark:text-white text-sm leading-snug">{title}</p>
        {children && <p className="mt-1 text-sm text-gray-500 dark:text-gray-400 line-clamp-2">{children}</p>}
      </div>
    </div>;
  if (!href) return content;
  return <a href={href} className="block no-underline border-b-0 mb-2">
      {content}
    </a>;
};

The Marqeta platform provides you with a production environment and a sandbox. The main difference between the production and sandbox environments is that your production environment communicates with a payment card network. This communication allows your program’s cards to pay for goods and services by initiating live transactions over the card network.

There are two types of sandbox environments available:

* **Public sandbox:** A single-user environment where you can begin building your program and experiment with the Marqeta platform.

* **Private sandbox:** A multi-user environment where you can integrate your application with the Marqeta platform.

All funds and transactions are simulated in both types of sandbox environments.

Unlike the production environment, a sandbox does not communicate with a card network, so the cards you create within them cannot be used to conduct real-world transactions. Therefore, you must rely on simulated transactions in order to test all objects you create within a sandbox. The sandbox environments provide a set of endpoints that let you simulate various types of card network transactions, such as authorizations, reversals, and balance inquiries. These endpoints are available only within the sandbox, so the details on this page do not apply to production.

To use the Simulations API for card transactions:

* Create a card in your sandbox environment.

* Use the `/simulations/cardtransactions/*` endpoints to simulate transaction event types. Each endpoint is its own event type.

* Use the `/webhooks` endpoint to send optional customer notifications for system events.

To use the Simulations API for direct deposits, see [Simulations 2.0 — Direct Deposits](/core-api/simulations-direct-deposits/).

<Note>
  **Note**\
  You can use [Postman](https://www.postman.com) to run requests for [card transaction](/core-api/simulations-card-transactions/) and [direct deposit](/core-api/simulations-direct-deposits/) simulations endpoints. This collection of requests has been saved as a YAML file for your convenience. To access the YAML file, see [Postman Collection for Simulations 2.0](/core-api/postman-collection-simulations/).
</Note>

All card transaction simulations endpoints share the same request/response model, as described below.

<span id="SimulationRequestBody" />

<h2 id="simulation_request_body">
  Request body
</h2>

| Fields                                                                                                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| card\_token<br /><br />string<br /><br />Optional                                                      | Unique identifier of the card. Useful when a single account holder has multiple cards.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| amount<br /><br />decimal<br /><br />Optional                                                          | Amount of the transaction.<br /><br />**Allowable Values:**<br /><br />0 min<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| anticipated\_amount<br /><br />decimal<br /><br />Optional                                             | Anticipated amount of the transaction, as provided by the card network.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| cash\_back\_amount<br /><br />decimal<br /><br />Optional                                              | The cashback amount requested.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| is\_preauthorization<br /><br />boolean<br /><br />Optional                                            | Indicates if the transaction is a pre-authorization. Set to <code>true</code> to mark the amount as an authorization only.<br /><br />**Allowable Values:**<br /><br /><code>true</code>, <code>false</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| card\_acceptor<br /><br />object<br /><br />Optional                                                   | Contains information about the merchant.<br /><br />**Allowable Values:**<br /><br />Valid <code>card\_acceptor</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| card\_acceptor.**mid**<br /><br />string<br /><br />Optional                                           | The merchant identifier.<br /><br />**Allowable Values:**<br /><br />2–15 chars                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| card\_acceptor.**mcc**<br /><br />string<br /><br />Optional                                           | Merchant category code (MCC).<br /><br />**Allowable Values:**<br /><br />5 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| card\_acceptor.**name**<br /><br />string<br /><br />Optional                                          | Card acceptor’s name.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| card\_acceptor.**address**<br /><br />string<br /><br />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.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| card\_acceptor.**city**<br /><br />string<br /><br />Optional                                          | Card acceptor’s city.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| card\_acceptor.**state**<br /><br />string<br /><br />Optional                                         | Two-character state, provincial, territorial, or federal abbreviation.<br /><br />For a complete list of valid abbreviations, see <a href="/core-api/kyc-verification/#_valid_state_provincial_territorial_and_federal_abbreviations">Valid state, provincial, territorial, and federal abbreviations</a>.<br /><br />**Allowable Values:**<br /><br />2 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| card\_acceptor.**postal\_code**<br /><br />string<br /><br />Optional                                  | Card acceptor’s postal code.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| card\_acceptor.**country\_code**<br /><br />string<br /><br />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.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| card\_acceptor.**poi**<br /><br />object<br /><br />Optional                                           | Contains information about the point of sale, including details about how the card was presented.<br /><br />Returned if provided by the card network, and if the request uses Transaction Model v1 of the Marqeta Core API. Not returned for Transaction Model v2 requests.<br /><br />**Allowable Values:**<br /><br /><code>tid</code>, <code>partial\_approval\_capable</code>, <code>cardholder\_presence</code>, <code>card\_presence</code>, <code>pin\_present</code>, <code>special\_condition\_indicator</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| card\_acceptor.poi.**tid**<br /><br />string<br /><br />Optional                                       | Card acceptor or terminal identification number.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| card\_acceptor.poi.**partial\_approval\_capable**<br /><br />string<br /><br />Optional                | Indicates whether the card acceptor or terminal supports partial-approval transactions.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| card\_acceptor.poi.**cardholder\_presence**<br /><br />string<br /><br />Optional                      | Indicates whether the cardholder was present during the transaction.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| card\_acceptor.poi.**card\_presence**<br /><br />string<br /><br />Optional                            | Indicates whether the card was present during the transaction.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| card\_acceptor.poi.**pin\_present**<br /><br />string<br /><br />Optional                              | Indicates whether the cardholder entered a PIN during the transaction.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| card\_acceptor.poi.**special\_condition\_indicator**<br /><br />string<br /><br />Optional             | Indicates a higher-risk operation, such as a quasi-cash or cryptocurrency transaction.<br /><br />These transactions typically involve non-financial institutions.<br /><br />**Allowable Values:**<br /><br /><code>UNSPECIFIED</code>, <code>CRYPTOCURRENCY\_PURCHASE</code>, <code>QUASI\_CASH</code>, <code>DEBT\_PAYMENT</code>, <code>CENTRAL\_BANK\_DIGITAL\_CURRENCY\_PURCHASE</code>, <code>STABLECOIN\_PURCHASE</code>, <code>BLOCKCHAIN\_NATIVE\_TOKEN\_PURCHASE</code>, <code>NON\_FUNGIBLE\_TOKEN\_PURCHASE</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| force\_post<br /><br />boolean<br /><br />Optional                                                     | Set to <code>true</code> to simulate a forced clearing transaction.<br /><br />**NOTE:** If you set this field to <code>true</code>, you must also set the <code>original\_transaction\_token</code> field to an existing transaction token (the transaction does not need to be related).<br /><br />**Allowable Values:**<br /><br /><code>true</code>, <code>false</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| fees<br /><br />array of objects<br /><br />Optional                                                   | List of fees associated with the transaction.<br /><br />This array is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />Existing <code>fees</code> array                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| fees\[].**type**<br /><br />string<br /><br />Optional                                                 | The type of fee assessed by the card network.<br /><br />**Allowable Values:**<br /><br /><code>ISSUER\_FEE</code>, <code>SWITCH\_FEE</code>, <code>PINDEBIT\_ASSOC\_FEE</code>, <code>ACQUIRER\_FEE</code>, <code>INTERCHANGE\_FEE</code>, <code>CUR\_CONV\_CARDHOLDER\_FEE</code>, <code>CUR\_CONV\_ISSUER\_FEE</code>, <code>CROSS\_BORDER\_ISSUER\_FEE</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| fees\[].**amount**<br /><br />decimal<br /><br />Optional                                              | The amount of the network fee.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| fees\[].**credit\_debit**<br /><br />string<br /><br />Optional                                        | Indicates whether the fee is a credit or a debit.<br /><br />- **C** indicates a credit<br />- **D** indicates a debit<br /><br />The following table lists the default values for fee types:<br /><br />Fee Type / Default Value<br /><code>ISSUER\_FEE</code> / <code>C</code><br /><code>SWITCH\_FEE</code> / <code>D</code><br /><code>PINDEBIT\_ASSOC\_FEE</code> / <code>D</code><br /><code>ACQUIRER\_FEE</code> / <code>D</code><br /><code>INTERCHANGE\_FEE</code> / <code>C</code><br /><code>CUR\_CONV\_CARDHOLDER\_FEE</code> / <code>D</code><br /><code>CUR\_CONV\_ISSUER\_FEE</code> / <code>C</code><br /><code>CROSS\_BORDER\_ISSUER\_FEE</code> / <code>C</code><br /><br />**Allowable Values:**<br /><br /><code>C</code>, <code>D</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| card\_options<br /><br />object<br /><br />Optional                                                    | Contains attributes that govern card usage.<br /><br />**Allowable Values:**<br /><br />Valid <code>card\_options</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| card\_options.**pin**<br /><br />string<br /><br />Optional                                            | The PIN for the card.<br /><br />**Allowable Values:**<br /><br />4 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| card\_options.**cvv**<br /><br />string<br /><br />Optional                                            | The CVV2 number for the card.<br /><br />**Allowable Values:**<br /><br />3 chars                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| card\_options.**card\_present**<br /><br />boolean<br /><br />Optional                                 | A value of <code>true</code> requires that the card be present for the transaction.<br /><br />**Allowable Values:**<br /><br /><code>true</code>, <code>false</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| card\_options.**expiration**<br /><br />string<br /><br />Optional                                     | The expiration date of the card.<br /><br />**Allowable Values:**<br /><br />4 chars                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| card\_options.**billing\_address**<br /><br />object<br /><br />Optional                               | Used for Address Verification System (AVS). The address-related fields in this object are verified against known values.<br /><br />**Allowable Values:**<br /><br />Valid <code>billing\_address</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| card\_options.billing\_address.**first\_name**<br /><br />string<br /><br />Optional                   | Cardholder’s first name.<br /><br />**Allowable Values:**<br /><br />To pass AVS, the value in this field must match the first name on record.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| card\_options.billing\_address.**last\_name**<br /><br />string<br /><br />Optional                    | Cardholder’s last name.<br /><br />**Allowable Values:**<br /><br />To pass AVS, the value in this field must match the last name on record.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| card\_options.billing\_address.**address**<br /><br />string<br /><br />Optional                       | Cardholder’s address.<br /><br />**Allowable Values:**<br /><br />To pass AVS, the value in this field must match the address on record.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| card\_options.billing\_address.**zip**<br /><br />string<br /><br />Optional                           | Cardholder’s postal code.<br /><br />**Allowable Values:**<br /><br />To pass AVS, the value in this field must match the postal code on record.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| pos<br /><br />object<br /><br />Optional                                                              | Contains information about the point of sale, including details on how the card was presented. May be returned if the request uses Transaction Model v2 of the Marqeta Core API.<br /><br />Not returned for Transaction Model v1 requests.<br /><br />**Allowable Values:**<br /><br />Valid <code>pos</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| pos.**partial\_approval\_capable**<br /><br />boolean<br /><br />Optional                              | Indicates the capability of the card acceptor or terminal to handle partial approvals.<br /><br />**Allowable Values:**<br /><br /><code>true</code>, <code>false</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| pos.**special\_condition\_indicator**<br /><br />string<br /><br />Optional                            | Indicates special conditions for the transaction.<br /><br />**Allowable Values:**<br /><br /><code>UNSPECIFIED</code>, <code>CRYPTOCURRENCY\_PURCHASE</code>, <code>QUASI\_CASH</code>, <code>DEBT\_PAYMENT</code>, <code>CENTRAL\_BANK\_DIGITAL\_CURRENCY\_PURCHASE</code>, <code>STABLECOIN\_PURCHASE</code>, <code>BLOCKCHAIN\_NATIVE\_TOKEN\_PURCHASE</code>, <code>NON\_FUNGIBLE\_TOKEN\_PURCHASE</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| pos.**pan\_entry\_mode**<br /><br />string<br /><br />Optional                                         | How the card PAN was captured at the point of sale.<br /><br />The Marqeta platform supports different values, depending on which card network was specified using the <code>network</code> field. The following table lists the supported PAN capture methods per card network:<br /><br />**NOTE:** This field does not apply to the Discover card network.<br /><br />Entry Mode / Visa / Mastercard / Pulse<br /><code>MAG\_STRIPE</code> / ✓ / ✓ / ✓<br /><code>MANUAL</code> / ✓ / ✓ / ✓<br /><code>CARD\_ON\_FILE</code> / ✓ / ✓ / ✓<br /><code>CHIP\_FALLBACK</code> / ✓ / ✓ / ✓<br /><code>BAR\_CODE</code> /   /   / ✓<br /><code>OCR</code> /   /   / ✓<br /><br />**Allowable Values:**<br /><br />- **MAG\_STRIPE** – Magnetic stripe card’s swipe method was used.<br />- **MANUAL** – Card PAN was entered manually.<br />- **CARD\_ON\_FILE** – Merchant initiated the transaction using card information stored on file.<br />- **CHIP\_FALLBACK** – Chip card was processed as a magnetic stripe transaction.<br />- **BAR\_CODE** – Bar code was used.<br />- **OCR** – Optical code reader was used.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| preceding\_related\_transaction\_token<br /><br />string<br /><br />Optional                           | Unique identifier of the card. Useful when a single account holder has multiple cards.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| network<br /><br />string<br /><br />Optional                                                          | Indicates which card network was used to complete the transaction.<br /><br />**Allowable Values:**<br /><br /><code>VISA</code>, <code>MASTERCARD</code>, <code>DISCOVER</code>, <code>PULSE</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| sub\_network<br /><br />string<br /><br />Optional                                                     | Indicates which subnetwork was used to complete the transaction.<br /><br />**Allowable Values:**<br /><br /><code>VISANET</code>, <code>VISANETDEBIT</code>, <code>VISAINTERLINK</code>, <code>VISAPLUS</code>, <code>MAESTRO</code>, <code>CIRRUS</code>, <code>MASTERCARDDEBIT</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| currency\_conversion<br /><br />object<br /><br />Optional                                             | Contains information from the card network about currency conversion, including the original currency of the transaction, the amount of the transaction in the origination currency, and the conversion rate.<br /><br />Returned if the transaction involves currency conversion.<br /><br />**Allowable Values:**<br /><br />Valid <code>currency\_conversion</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| currency\_conversion.**original\_amount**<br /><br />decimal<br /><br />Optional                       | Amount of the transaction in the currency in which it originated. Returned if the transaction involves currency conversion.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| currency\_conversion.**conversion\_rate**<br /><br />decimal<br /><br />Optional                       | Conversion rate between the origination currency and the settlement currency.<br /><br />Returned when the transaction currency is different from the origination currency.<br /><br />**Allowable Values:**<br /><br />Current conversion rate<br /><br />**NOTE:** A value of <code>0</code> or <code>1</code> indicates no conversion; the currencies are the same.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| currency\_conversion.**original\_currency\_code**<br /><br />string<br /><br />Optional                | The three-digit ISO 4217 currency code.<br /><br />**Allowable Values:**<br /><br />Valid three-digit <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" rel="noopener">ISO 4217 currency code</a>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| currency\_code<br /><br />string<br /><br />Optional                                                   | Currency type of the transaction.<br /><br />**Allowable Values:**<br /><br /><code>AED</code>, <code>AFN</code>, <code>ALL</code>, <code>AMD</code>, <code>ANG</code>, <code>AOA</code>, <code>ARS</code>, <code>AUD</code>, <code>AWG</code>, <code>AZN</code>, <code>BAM</code>, <code>BBD</code>, <code>BDT</code>, <code>BGN</code>, <code>BHD</code>, <code>BIF</code>, <code>BMD</code>, <code>BND</code>, <code>BOB</code>, <code>BRL</code>, <code>BSD</code>, <code>BTN</code>, <code>BWP</code>, <code>BYR</code>, <code>BZD</code>, <code>CAD</code>, <code>CDF</code>, <code>CHF</code>, <code>CLP</code>, <code>CNY</code>, <code>COP</code>, <code>CRC</code>, <code>CUC</code>, <code>CUP</code>, <code>CVE</code>, <code>CZK</code>, <code>DJF</code>, <code>DKK</code>, <code>DOP</code>, <code>DZD</code>, <code>EGP</code>, <code>ERN</code>, <code>ETB</code>, <code>EUR</code>, <code>FJD</code>, <code>FKP</code>, <code>GBP</code>, <code>GEL</code>, <code>GGP</code>, <code>GHS</code>, <code>GIP</code>, <code>GMD</code>, <code>GNF</code>, <code>GTQ</code>, <code>GYD</code>, <code>HKD</code>, <code>HNL</code>, <code>HRK</code>, <code>HTG</code>, <code>HUF</code>, <code>IDR</code>, <code>ILS</code>, <code>IMP</code>, <code>INR</code>, <code>IQD</code>, <code>IRR</code>, <code>ISK</code>, <code>JEP</code>, <code>JMD</code>, <code>JOD</code>, <code>JPY</code>, <code>KES</code>, <code>KGS</code>, <code>KHR</code>, <code>KMF</code>, <code>KPW</code>, <code>KRW</code>, <code>KWD</code>, <code>KYD</code>, <code>KZT</code>, <code>LAK</code>, <code>LBP</code>, <code>LKR</code>, <code>LRD</code>, <code>LSL</code>, <code>LYD</code>, <code>MAD</code>, <code>MDL</code>, <code>MGA</code>, <code>MKD</code>, <code>MMK</code>, <code>MNT</code>, <code>MOP</code>, <code>MRO</code>, <code>MUR</code>, <code>MVR</code>, <code>MWK</code>, <code>MXN</code>, <code>MYR</code>, <code>MZN</code>, <code>NAD</code>, <code>NGN</code>, <code>NIO</code>, <code>NOK</code>, <code>NPR</code>, <code>NZD</code>, <code>OMR</code>, <code>PAB</code>, <code>PEN</code>, <code>PGK</code>, <code>PHP</code>, <code>PKR</code>, <code>PLN</code>, <code>PYG</code>, <code>QAR</code>, <code>RON</code>, <code>RSD</code>, <code>RUB</code>, <code>RWF</code>, <code>SAR</code>, <code>SBD</code>, <code>SCR</code>, <code>SDG</code>, <code>SEK</code>, <code>SGD</code>, <code>SHP</code>, <code>SLL</code>, <code>SOS</code>, <code>SPL</code>, <code>SRD</code>, <code>STD</code>, <code>SVC</code>, <code>SYP</code>, <code>SZL</code>, <code>THB</code>, <code>TJS</code>, <code>TMT</code>, <code>TND</code>, <code>TOP</code>, <code>TRY</code>, <code>TTD</code>, <code>TVD</code>, <code>TWD</code>, <code>TZS</code>, <code>UAH</code>, <code>UGX</code>, <code>USD</code>, <code>UYU</code>, <code>UZS</code>, <code>VEF</code>, <code>VND</code>, <code>VUV</code>, <code>WST</code>, <code>XAF</code>, <code>XCD</code>, <code>XDR</code>, <code>XOF</code>, <code>XPF</code>, <code>YER</code>, <code>ZAR</code>, <code>ZMW</code>, <code>ZWD</code> |
| account\_funding<br /><br />object<br /><br />Optional                                                 | Information used when funding an account.<br /><br />**Allowable Values:**<br /><br />Valid <code>account\_funding</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| account\_funding.**first\_name**<br /><br />string<br /><br />Required                                 | Account holder’s first name.<br /><br />**Allowable Values:**<br /><br />To pass AVS, must match the first name on record.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| account\_funding.**last\_name**<br /><br />string<br /><br />Optional                                  | Account holder’s last name.<br /><br />**Allowable Values:**<br /><br />To pass AVS, must match the last name on record.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| account\_funding.**receiver\_name**<br /><br />string<br /><br />Optional                              | Recipient’s name.<br /><br />**Allowable Values:**<br /><br />To pass AVS, must match the name on record.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| account\_funding.**funding\_source**<br /><br />string<br /><br />Required                             | Describes the source of the funding.<br /><br />**Allowable Values:**<br /><br /><code>CREDIT</code>, <code>DEBIT</code>, <code>PREPAID</code>, <code>DEPOSIT\_ACCOUNT</code>, <code>CASH</code>, <code>MOBILE\_MONEY\_ACCOUNT</code>, <code>NON\_VISA\_CREDIT</code>, <code>CHECK</code>, <code>ACH</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| account\_funding.**receiver\_account\_type**<br /><br />string<br /><br />Required                     | Identifies the account type used for the funding request.<br /><br />**Allowable Values:**<br /><br /><code>OTHER</code>, <code>RTN\_BANK\_ACCOUNT</code>, <code>IBAN</code>, <code>CARD\_ACCOUNT</code>, <code>EMAIL</code>, <code>PHONE\_NUMBER</code>, <code>BANK\_ACCOUNT\_NUMBER\_AND\_BANK\_IDENTIFICATION\_CODE</code>, <code>WALLET\_ID</code>, <code>SOCIAL\_NETWORK\_ID</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| account\_funding.**transaction\_purpose**<br /><br />string<br /><br />Optional                        | Identifies the purpose of the transaction.<br /><br />**Allowable Values:**<br /><br />- <code>FAMILY\_SUPPORT</code><br />- <code>REGULAR\_LABOR\_TRANSFERS</code><br />- <code>TRAVEL\_AND\_TOURISM</code><br />- <code>EDUCATION</code><br />- <code>MEDICAL\_TREATMENT</code><br />- <code>EMERGENCY\_NEED</code><br />- <code>SAVINGS</code><br />- <code>GIFTS</code><br />- <code>OTHER</code><br />- <code>SALARY</code><br />- <code>CROWD\_LENDING</code><br />- <code>CRYPTO\_CURRENCY</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| account\_funding.**transaction\_type**<br /><br />string<br /><br />Required                           | Describes the type of transaction.<br /><br />**Allowable Values:**<br /><br /><code>ACCOUNT\_TO\_ACCOUNT</code>, <code>PERSON\_TO\_PERSON</code>, <code>WALLET\_TRANSFER</code>, <code>MONEY\_TRANSFER\_BY\_BANK</code>, <code>BUSINESS\_TO\_BUSINESS</code>, <code>DISBURSEMENT</code>, <code>GOVERNMENT\_DISBURSEMENT</code>, <code>GAMBLING\_PAYOUT</code>, <code>LOYALTY</code>, <code>MERCHANT\_DISBURSEMENT</code>, <code>ONLINE\_GAMBLING\_PAYOUT</code>, <code>PENSION\_DISBURSEMENT</code>, <code>PREPAID\_LOADS</code>, <code>CARD\_BILL\_PAYMENT</code>, <code>BILL\_PAYMENT</code>, <code>CASH\_CLAIM</code>, <code>CASH\_IN</code>, <code>CASH\_OUT</code>, <code>MOBILE\_AIR\_TIME\_PAYMENT</code>, <code>MONEY\_TRANSFER\_BY\_MERCHANT</code>, <code>FACE\_TO\_FACE\_MERCHANT\_PAYMENT</code>, <code>GOVERNMENT\_PAYMENT</code>, <code>PAYMENTS\_GOODS\_SERVICES</code>, <code>FUNDS\_TRANSFER</code>, <code>VISA\_ACCEPT</code>, <code>GENERAL\_BUSINESS\_TO\_BUSINESS\_TRANSFER</code>, <code>BUSINESS\_TO\_BUSINESS\_TRANSFER</code>, <code>CASH\_DEPOSIT</code>, <code>PURCHASE\_REPAYMENT</code>, <code>AFT\_OR\_OCT\_ELIGIBILITY</code>, <code>CONSUMER\_BILL\_PAYMENT</code>, <code>REQUEST\_TO\_PAY</code>, <code>LIQUID\_ASSET</code>, <code>FAST\_REFUND</code>, <code>GAMING\_PAYMENT</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| original\_credit<br /><br />object<br /><br />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.<br /><br />**Allowable Values:**<br /><br />Existing <code>original\_credit</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| original\_credit.**funding\_source**<br /><br />string<br /><br />Optional                             | Describes the source of the funding.<br /><br />**Allowable Values:**<br /><br /><code>CREDIT</code>, <code>DEBIT</code>, <code>PREPAID</code>, <code>DEPOSIT\_ACCOUNT</code>, <code>CASH</code>, <code>MOBILE\_MONEY\_ACCOUNT</code>, <code>NON\_VISA\_CREDIT</code>, <code>CHECK</code>, <code>ACH</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| original\_credit.**transaction\_type**<br /><br />string<br /><br />Optional                           | Describes the type of transaction.<br /><br />**Allowable Values:**<br /><br /><code>ACCOUNT\_TO\_ACCOUNT</code>, <code>PERSON\_TO\_PERSON</code>, <code>WALLET\_TRANSFER</code>, <code>MONEY\_TRANSFER\_BY\_BANK</code>, <code>BUSINESS\_TO\_BUSINESS</code>, <code>DISBURSEMENT</code>, <code>GOVERNMENT\_DISBURSEMENT</code>, <code>GAMBLING\_PAYOUT</code>, <code>LOYALTY</code>, <code>MERCHANT\_DISBURSEMENT</code>, <code>ONLINE\_GAMBLING\_PAYOUT</code>, <code>PENSION\_DISBURSEMENT</code>, <code>PREPAID\_LOADS</code>, <code>CARD\_BILL\_PAYMENT</code>, <code>BILL\_PAYMENT</code>, <code>CASH\_CLAIM</code>, <code>CASH\_IN</code>, <code>CASH\_OUT</code>, <code>MOBILE\_AIR\_TIME\_PAYMENT</code>, <code>MONEY\_TRANSFER\_BY\_MERCHANT</code>, <code>FACE\_TO\_FACE\_MERCHANT\_PAYMENT</code>, <code>GOVERNMENT\_PAYMENT</code>, <code>PAYMENTS\_GOODS\_SERVICES</code>, <code>FUNDS\_TRANSFER</code>, <code>VISA\_ACCEPT</code>, <code>GENERAL\_BUSINESS\_TO\_BUSINESS\_TRANSFER</code>, <code>BUSINESS\_TO\_BUSINESS\_TRANSFER</code>, <code>CASH\_DEPOSIT</code>, <code>PURCHASE\_REPAYMENT</code>, <code>AFT\_OR\_OCT\_ELIGIBILITY</code>, <code>CONSUMER\_BILL\_PAYMENT</code>, <code>REQUEST\_TO\_PAY</code>, <code>GAMING\_PAYMENT</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| original\_credit.**sender\_account\_type**<br /><br />string<br /><br />Optional                       | The type of account from which the OCT draws funds.<br /><br />**Allowable Values:**<br /><br /><code>OTHER</code>, <code>RTN\_BANK\_ACCOUNT</code>, <code>IBAN</code>, <code>CARD\_ACCOUNT</code>, <code>EMAIL</code>, <code>PHONE\_NUMBER</code>, <code>BANK\_ACCOUNT\_NUMBER\_AND\_BANK\_IDENTIFICATION\_CODE</code>, <code>WALLET\_ID</code>, <code>SOCIAL\_NETWORK\_ID</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| original\_credit.**sender\_name**<br /><br />string<br /><br />Optional                                | Full name of the sender.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| original\_credit.**screening\_score**<br /><br />string<br /><br />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.<br /><br />A value of 999 means that no screening score is available.<br /><br />**Allowable Values:**<br /><br />000-100, 999                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| flex<br /><br />object<br /><br />Optional                                                             | Requests model to invoke Flexible Credential transactions.<br /><br />**Allowable Values:**<br /><br /><code>eligible</code>, <code>eligible\_products</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| flex.**eligible**<br /><br />boolean<br /><br />Optional                                               | Indicates whether the transaction is eligible for Flexible Credential transactions or not.<br /><br />**Allowable Values:**<br /><br /><code>true</code>, <code>false</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| flex.**eligible\_products**<br /><br />array of strings<br /><br />Optional                            | Specifies which of the payment instrument’s credentials is eligible for this transaction.<br /><br />**Allowable Values:**<br /><br /><code>DEBIT\_TO\_LOAN</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| account\_name\_verification<br /><br />object<br /><br />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.<br /><br />**Allowable Values:**<br /><br /><code>on\_file</code>, <code>request</code>, <code>request\_type</code>, <code>response</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| account\_name\_verification.**on\_file**<br /><br />object<br /><br />Optional                         | Contains the name of the cardholder for account name verification.<br /><br />**Allowable Values:**<br /><br /><code>first\_name</code>, <code>last\_name</code>, <code>middle\_name</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| account\_name\_verification.on\_file.**first\_name**<br /><br />string<br /><br />Optional             | First name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| account\_name\_verification.on\_file.**last\_name**<br /><br />string<br /><br />Optional              | Last name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| account\_name\_verification.on\_file.**middle\_name**<br /><br />string<br /><br />Optional            | Middle name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| account\_name\_verification.**request**<br /><br />object<br /><br />Optional                          | Contains the name of the cardholder for account name verification.<br /><br />**Allowable Values:**<br /><br /><code>first\_name</code>, <code>last\_name</code>, <code>middle\_name</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| account\_name\_verification.request.**first\_name**<br /><br />string<br /><br />Optional              | First name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| account\_name\_verification.request.**last\_name**<br /><br />string<br /><br />Optional               | Last name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| account\_name\_verification.request.**middle\_name**<br /><br />string<br /><br />Optional             | Middle name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| account\_name\_verification.**request\_type**<br /><br />string<br /><br />Optional                    | *(Mastercard only)* Indicates the type of authentication request.<br /><br />**Allowable Values:**<br /><br /><code>SENDER</code>, <code>RECEIVER</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| account\_name\_verification.**response**<br /><br />object<br /><br />Optional                         | Contains an assertion as to whether the Marqeta platform’s address verification data matches data provided by the cardholder.<br /><br />**Allowable Values:**<br /><br />Existing <code>response</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| account\_name\_verification.response.**code**<br /><br />string<br /><br />Required                    | Four-digit code corresponding with the outcome of the attempted transaction type.<br /><br />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. <code>0</code> indicates no validation was performed, <code>1</code> indicates the match was unsuccessful (unmatched), <code>2</code> indicates the match was partial, and <code>3</code> indicates the match was exact. For example:<br /><br />Code / First Name / Middle Name / Last Name / Full Name<br />0000 / Not validated / Not validated / Not validated / Not validated<br />1111 / Unmatched / Unmatched / Unmatched / Unmatched<br />3333 / Exact match / Exact match / Exact match / Exact match<br />1232 / Unmatched / Partial match / Exact match / Partial match<br /><br />**Allowable Values:**<br /><br />Four-digit code                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| account\_name\_verification.response.**memo**<br /><br />string<br /><br />Required                    | Information on the outcome of the attempted transaction type.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| account\_name\_verification.response.**additional\_information**<br /><br />string<br /><br />Optional | Provides information about the relevant velocity control for the transaction, if applicable.<br /><br />**Allowable Values:**<br /><br />The <code>additional\_information</code> field returns a string in the following format: <code>\<Velocity control name>, cumulative transaction amount is \<X></code>, where <code>X</code> is the cumulative transaction amount value calculated by Marqeta. For example: <code>500 max spend per day, cumulative transaction amount is 750</code>.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| address\_verification<br /><br />object<br /><br />Optional                                            | Contains the address of the cardholder for account address verification.<br /><br />**Allowable Values:**<br /><br /><code>postal\_code</code>, <code>street\_address</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| address\_verification.**postal\_code**<br /><br />string<br /><br />Optional                           | Postal code of the cardholder.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| address\_verification.**street\_address**<br /><br />string<br /><br />Optional                        | Street address of the cardholder.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |

<span id="SimulationResponseBody" />

<h2 id="simulation_response_body">
  Response body
</h2>

| Fields                                                                                                                                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| transaction<br /><br />object<br /><br />Optional                                                                                        | Contains information about the transaction.<br /><br />**Allowable Values:**<br /><br />Existing <code>transaction</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| transaction.**type**<br /><br />string<br /><br />Required                                                                               | Transaction event type.<br /><br />For more information about the <code>type</code> field, see <a href="/core-api/event-types/#_transaction_events">Transaction events</a>.<br /><br />**Allowable Values:**<br /><br /><code>gpa.credit</code>, <code>gpa.credit.pending</code>, <code>gpa.credit.pending.reversal</code>, <code>gpa.credit.reversal</code>, <code>gpa.credit.networkload</code>, <code>gpa.credit.networkload.reversal</code>, <code>gpa.debit.networkload</code>, <code>gpa.debit</code>, <code>gpa.debit.pending</code>, <code>gpa.debit.pending.reversal</code>, <code>gpa.grant</code>, <code>gpa.credit.issueroperator</code>, <code>gpa.debit.issueroperator</code>, <code>gpa.credit.chargeback</code>, <code>gpa.credit.chargeback.reversal</code>, <code>gpa.credit.billpayment</code>, <code>gpa.credit.authorization.billpayment</code>, <code>gpa.credit.authorization.billpayment.reversal</code>, <code>authorization</code>, <code>authorization.advice</code>, <code>authorization.reversal</code>, <code>authorization.clearing</code>, <code>authorization.reversal.issuerexpiration</code>, <code>dispute.credit</code>, <code>dispute.debit</code>, <code>authorization.clearing.chargeback</code>, <code>authorization.clearing.chargeback.reversal</code>, <code>refund</code>, <code>pindebit.atm.withdrawal</code>, <code>pindebit.balanceinquiry</code>, <code>pindebit.cashback</code>, <code>pindebit.checkavs</code>, <code>pindebit</code>, <code>programreserve.credit</code>, <code>programreserve.debit</code>, <code>fee.charge.pending</code>, <code>fee.charge</code>, <code>fee.charge.refund</code>, <code>fee.charge.reversal</code>, <code>funds.expire</code>, <code>reward.earn</code>, <code>transfer.peer</code>, <code>transfer.fee</code>, <code>account.funding.authorization</code>, <code>account.funding.authorization.reversal</code>, <code>account.funding.authorization.clearing</code>, <code>account.funding.auth\_plus\_capture</code>, <code>account.funding.auth\_plus\_capture.reversal</code>, <code>account.credit</code>, <code>account.debit</code>, <code>balanceinquiry</code>, <code>authorization.atm.withdrawal</code>, <code>authorization.pin.change</code>, <code>authorization.pin.unblock</code>, <code>authorization.clearing.atm.withdrawal</code>, <code>authorization.cashback</code>, <code>authorization.clearing.cashback</code>, <code>transfer.program</code>, <code>authorization.quasi.cash</code>, <code>authorization.clearing.quasi.cash</code>, <code>authorization.incremental</code>, <code>gpa.credit.authorization</code>, <code>gpa.credit.authorization.reversal</code>, <code>gpa.debit.authorization</code>, <code>gpa.debit.reversal</code>, <code>original.credit.authorization</code>, <code>original.credit.authorization.reversal</code>, <code>original.credit.authorization.clearing</code>, <code>original.credit.auth\_plus\_capture</code>, <code>original.credit.auth\_plus\_capture.reversal</code>, <code>refund.authorization</code>, <code>refund.authorization.advice</code>, <code>refund.authorization.clearing</code>, <code>refund.authorization.reversal</code>, <code>token.activation-request</code>, <code>token.advice</code>, <code>pindebit.authorization</code>, <code>pindebit.authorization.clearing</code>, <code>pindebit.authorization.reversal</code>, <code>pindebit.authorization.reversal.issuerexpiration</code>, <code>authorization.standin</code>, <code>authorization.clearing.chargeback.completed</code>, <code>authorization.clearing.chargeback.provisional.credit</code>, <code>authorization.clearing.chargeback.provisional.debit</code>, <code>authorization.clearing.chargeback.writeoff</code>, <code>directdeposit.credit</code>, <code>directdeposit.credit.pending</code>, <code>directdeposit.credit.reject</code>, <code>directdeposit.credit.pending.reversal</code>, <code>directdeposit.credit.reversal</code>, <code>directdeposit.debit</code>, <code>directdeposit.debit.pending</code>, <code>directdeposit.debit.reject</code>, <code>directdeposit.debit.reversal</code>, <code>pin.change.reversal</code>, <code>pin.change.reversal.advice</code>, <code>directdeposit.debit.pending.reversal</code>, <code>pindebit.chargeback</code>, <code>pindebit.chargeback.completed</code>, <code>pindebit.chargeback.provisional.credit</code>, <code>pindebit.chargeback.provisional.debit</code>, <code>pindebit.chargeback.reversal</code>, <code>pindebit.chargeback.writeoff</code>, <code>pindebit.pin.change</code>, <code>pindebit.pin.unblock</code>, <code>pindebit.credit.adjustment</code>, <code>pindebit.quasicash</code>, <code>pindebit.quasi.cash</code>, <code>pindebit.refund</code>, <code>pindebit.refund.reversal</code>, <code>pindebit.reversal</code>, <code>pindebit.transfer</code>, <code>pushtocard.debit</code>, <code>pushtocard.reversal</code>, <code>credit.adjustment</code>, <code>debit.adjustment</code>, <code>pin.change.via.api</code>, <code>product.inquiry</code>, <code>transit.offer</code>, <code>transfer.from.checking.hold</code>, <code>transfer.from.checking.clear</code>, <code>transfer.to.checking.open</code>, <code>transfer.to.checking.clear</code>, <code>transfer.to.savings.open</code>, <code>transfer.to.savings.clear</code>, <code>transfer.from.savings.hold</code>, <code>transfer.from.savings.clear</code>, <code>fps.debit.hold</code>, <code>fps.debit.clear</code>, <code>fps.debit.hold.reverse</code>, <code>fps.debit.clear.reverse</code>, <code>fps.credit.open</code>, <code>fps.credit.clear</code>, <code>fps.credit.open.reverse</code>, <code>fps.credit.clear.reverse</code>, <code>interest.posting.clear</code>, <code>interest.posting.clear.reverse</code>, <code>interest.posting.adjustment</code>, <code>unknown</code> |
| transaction.**state**<br /><br />string<br /><br />Required                                                                              | Current state of the transaction.<br /><br />For more information about the <code>state</code> field, see <a href="/developer-guides/about-transactions/#_the_transaction_lifecycle">The transaction lifecycle</a>.<br /><br />**Allowable Values:**<br /><br /><code>CLEARED</code>, <code>COMPLETION</code>, <code>DECLINED</code>, <code>ERROR</code>, <code>PENDING</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| transaction.**token**<br /><br />string<br /><br />Required                                                                              | Unique identifier of the transaction, formatted as a UUID.<br /><br />**NOTE:** For subsequent related transactions, this token value appears as the <code>preceding\_related\_transaction\_token</code>.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| transaction.**user\_token**<br /><br />string<br /><br />Optional                                                                        | Unique identifier of the user who owns the account that funded the transaction. Subsequent related transactions retain the same <code>user\_token</code>, even if the card used to complete the transaction moves to another user.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| transaction.**card\_token**<br /><br />string<br /><br />Optional                                                                        | Unique identifier of the card. Useful when a single account holder has multiple cards.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| transaction.**response**<br /><br />object<br /><br />Optional                                                                           | Contains an assertion as to whether the Marqeta platform’s address verification data matches data provided by the cardholder.<br /><br />**Allowable Values:**<br /><br />Existing <code>response</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| transaction.response.**code**<br /><br />string<br /><br />Required                                                                      | Four-digit code corresponding with the outcome of the attempted transaction type.<br /><br />For card security verification, the code indicates whether the verification check passed and can have these possible values:<br /><br />- 0000 – passed<br />- 0001 – did not pass<br /><br />**Allowable Values:**<br /><br />Four-digit code                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| transaction.response.**memo**<br /><br />string<br /><br />Required                                                                      | Information on the outcome of the attempted transaction type.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| transaction.response.**additional\_information**<br /><br />string<br /><br />Optional                                                   | Provides information about the relevant velocity control for the transaction, if applicable.<br /><br />**Allowable Values:**<br /><br />The <code>additional\_information</code> field returns a string in the following format: <code>\<Velocity control name>, cumulative transaction amount is \<X></code>, where <code>X</code> is the cumulative transaction amount value calculated by Marqeta. For example: <code>500 max spend per day, cumulative transaction amount is 750</code>.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| transaction.**created\_time**<br /><br />datetime<br /><br />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.<br /><br />**Allowable Values:**<br /><br />date-time<br /><br />**Format:**<br />yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| transaction.**user\_transaction\_time**<br /><br />datetime<br /><br />Optional                                                          | Date and time when the user initiated the transaction, in UTC. For example, when a merchant performed the original authorization for a refund.<br /><br />**Allowable Values:**<br /><br />date-time<br /><br />**Format:**<br />yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| transaction.**settlement\_date**<br /><br />datetime<br /><br />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.<br /><br />**Allowable Values:**<br /><br />date-time<br /><br />**Format:**<br />yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| transaction.**amount**<br /><br />decimal<br /><br />Required                                                                            | Amount of the transaction.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| transaction.**amount\_to\_be\_released**<br /><br />decimal<br /><br />Optional                                                          | Amount to released following a financial advice.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| transaction.**anticipated\_amount**<br /><br />decimal<br /><br />Optional                                                               | Anticipated amount of the transaction, as provided by the card network. This field applies to anticipated amount verification transactions (AAVTs).<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| transaction.**cash\_back\_amount**<br /><br />decimal<br /><br />Optional                                                                | The cashback amount requested.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| transaction.**request\_amount**<br /><br />decimal<br /><br />Optional                                                                   | Merchant-requested amount, including any fees. This includes amount and cashback amount.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| transaction.**gpa**<br /><br />object<br /><br />Optional                                                                                | Contains information about the GPA balances and pending credits.<br /><br />**Allowable Values:**<br /><br />- <code>available\_balance</code><br />- <code>balances</code><br />- <code>cached\_balance</code><br />- <code>credit\_balance</code><br />- <code>currency\_code</code><br />- <code>impacted\_amount</code><br />- <code>last\_updated\_time</code><br />- <code>ledger\_balance</code><br />- <code>pending\_credits</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| transaction.gpa.**ledger\_balance**<br /><br />decimal<br /><br />Optional                                                               | 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.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| transaction.gpa.**available\_balance**<br /><br />decimal<br /><br />Optional                                                            | 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.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| transaction.gpa.**impacted\_amount**<br /><br />decimal<br /><br />Optional                                                              | Balance change based on the amount of the transaction.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| transaction.**currency\_code**<br /><br />string<br /><br />Optional                                                                     | The three-digit ISO 4217 currency code.<br /><br />**Allowable Values:**<br /><br />Valid three-digit <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" rel="noopener">ISO 4217 currency code</a>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| transaction.**currency\_conversion**<br /><br />object<br /><br />Optional                                                               | Contains information from the card network about currency conversion, including the original currency of the transaction, the amount of the transaction in the origination currency, and the conversion rate.<br /><br />Returned if the transaction involves currency conversion.<br /><br />**Allowable Values:**<br /><br />Valid <code>currency\_conversion</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| transaction.currency\_conversion.**original\_amount**<br /><br />decimal<br /><br />Optional                                             | Amount of the transaction in the currency in which it originated. Returned if the transaction involves currency conversion.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| transaction.currency\_conversion.**conversion\_rate**<br /><br />decimal<br /><br />Optional                                             | Conversion rate between the origination currency and the settlement currency.<br /><br />Returned when the transaction currency is different from the origination currency.<br /><br />**Allowable Values:**<br /><br />Current conversion rate<br /><br />**NOTE:** A value of <code>0</code> or <code>1</code> indicates no conversion; the currencies are the same.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| transaction.currency\_conversion.**original\_currency\_code**<br /><br />string<br /><br />Optional                                      | The three-digit ISO 4217 currency code.<br /><br />**Allowable Values:**<br /><br />Valid three-digit <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" rel="noopener">ISO 4217 currency code</a>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| transaction.**preceding\_related\_transaction\_token**<br /><br />string<br /><br />Optional                                             | Returned for final transaction types.<br /><br />Unique identifier of the preceding related transaction. Useful for identifying the transaction that preceded the current one. For example, <code>authorization</code>, a temporary transaction type, precedes and is completed by <code>authorization.clearing</code>, a final transaction type.<br /><br />In this case, the <code>authorization</code> token is returned with this field. See <a href="/core-api/event-types/#_transaction_events">Transaction events</a> for details on which transaction types are temporary or final.<br /><br />**Allowable Values:**<br /><br />Format: UUID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| transaction.**network**<br /><br />string<br /><br />Optional                                                                            | Indicates which card network was used to complete the transaction.<br /><br />**Allowable Values:**<br /><br /><code>VISA</code>, <code>MASTERCARD</code>, <code>PULSE</code>, <code>DISCOVER</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| transaction.**subnetwork**<br /><br />string<br /><br />Optional                                                                         | Indicates which subnetwork used to complete the transaction.<br /><br />**Allowable Values:**<br /><br /><code>VISANET</code>, <code>VISANETDEBIT</code>, <code>VISAINTERLINK</code>, <code>VISAPLUS</code>, <code>MAESTRO</code>, <code>CIRRUS</code>, <code>MASTERCARDDEBIT</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| transaction.**acquirer\_fee\_amount**<br /><br />decimal<br /><br />Optional                                                             | Indicates the amount of the acquirer fee. Account holders are sometimes charged an acquirer fee for card use at places such as ATMs or fuel dispensers.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| transaction.**fees**<br /><br />array of objects<br /><br />Optional                                                                     | List of fees associated with the transaction.<br /><br />This array is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />Array of existing <code>fees</code> objects                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| transaction.fees\[].**type**<br /><br />string<br /><br />Optional                                                                       | The type of fee assessed by the card network.<br /><br />**Allowable Values:**<br /><br /><code>ISSUER\_FEE</code>, <code>SWITCH\_FEE</code>, <code>PINDEBIT\_ASSOC\_FEE</code>, <code>ACQUIRER\_FEE</code>, <code>INTERCHANGE\_FEE</code>, <code>CUR\_CONV\_CARDHOLDER\_FEE</code>, <code>CUR\_CONV\_ISSUER\_FEE</code>, <code>CROSS\_BORDER\_ISSUER\_FEE</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| transaction.fees\[].**amount**<br /><br />decimal<br /><br />Optional                                                                    | The amount of the network fee.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| transaction.fees\[].**credit\_debit**<br /><br />string<br /><br />Optional                                                              | Indicates whether the fee is a credit or a debit.<br /><br />- **C** indicates a credit<br />- **D** indicates a debit<br /><br />The following table lists the default values for fee types:<br /><br />Fee Type / Default Value<br /><code>ISSUER\_FEE</code> / <code>C</code><br /><code>SWITCH\_FEE</code> / <code>D</code><br /><code>PINDEBIT\_ASSOC\_FEE</code> / <code>D</code><br /><code>ACQUIRER\_FEE</code> / <code>D</code><br /><code>INTERCHANGE\_FEE</code> / <code>C</code><br /><code>CUR\_CONV\_CARDHOLDER\_FEE</code> / <code>D</code><br /><code>CUR\_CONV\_ISSUER\_FEE</code> / <code>C</code><br /><code>CROSS\_BORDER\_ISSUER\_FEE</code> / <code>C</code><br /><br />**Allowable Values:**<br /><br /><code>C</code>, <code>D</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| transaction.**flex**<br /><br />object<br /><br />Optional                                                                               | Contains information about a Flexible Credential transaction.<br /><br />**Allowable Values:**<br /><br /><code>action</code>, <code>eligible</code>, <code>eligible\_products</code>, <code>secondary\_credential\_identifier</code>, <code>selected\_product</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| transaction.flex.**action**<br /><br />string<br /><br />Optional                                                                        | Indicates whether the Flexible Credential transaction object is actionable (<code>inquiry</code>) or merely informative (<code>advice</code>).<br /><br />**Allowable Values:**<br /><br /><code>inquiry</code>, <code>advice</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| transaction.flex.**eligible**<br /><br />string<br /><br />Optional                                                                      | Indicates whether the transaction is eligible for Flexible Credential transactions or not.<br /><br />**Allowable Values:**<br /><br /><code>true</code>, <code>false</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| transaction.flex.**eligible\_products**<br /><br />array of strings<br /><br />Optional                                                  | Specifies which of the payment instrument’s credentials is eligible for this transaction:<br /><br />- A value of <code>DEBIT</code> indicates the primary credential.<br />- A value of <code>LOAN</code> indicates the secondary credential.<br /><br />**Allowable Values:**<br /><br /><code>DEBIT</code>, <code>LOAN</code>, <code>DEBIT\_TO\_LOAN</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| transaction.flex.**secondary\_credential\_identifier**<br /><br />string<br /><br />Optional                                             | Identifies the secondary credential used in the transaction, if applicable.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| transaction.flex.**selected\_product**<br /><br />string<br /><br />Optional                                                             | Indicates the eligible product that was used in the transaction.<br /><br />**Allowable Values:**<br /><br /><code>DEBIT</code>, <code>LOAN</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| transaction.**fraud**<br /><br />object<br /><br />Optional                                                                              | Contains one or more fraud determinations by the card network that apply either to the transaction or to the cardholder’s account.<br /><br />**Allowable Values:**<br /><br /><code>issuer\_processor</code>, <code>network\_fraud\_view</code>, <code>network\_account\_intelligence\_score</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| transaction.fraud.**network**<br /><br />object<br /><br />Optional                                                                      | Contains network-provided information about fraud determinations.<br /><br />**Allowable Values:**<br /><br />- <code>account\_risk\_score</code><br />- <code>account\_risk\_score\_reason\_code</code><br />- <code>transaction\_risk\_score</code><br />- <code>transaction\_risk\_score\_reason\_code</code><br />- <code>transaction\_risk\_score\_reason\_description</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| transaction.**card\_acceptor**<br /><br />object<br /><br />Optional                                                                     | Contains information about the merchant.<br /><br />**Allowable Values:**<br /><br />Valid <code>card\_acceptor</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| transaction.card\_acceptor.**mid**<br /><br />string<br /><br />Optional                                                                 | The merchant identifier.<br /><br />**Allowable Values:**<br /><br />2–15 chars                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| transaction.card\_acceptor.**mcc**<br /><br />string<br /><br />Optional                                                                 | Merchant category code (MCC).<br /><br />**Allowable Values:**<br /><br />5 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| transaction.card\_acceptor.**name**<br /><br />string<br /><br />Optional                                                                | Card acceptor’s name.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| transaction.card\_acceptor.**address**<br /><br />string<br /><br />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.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| transaction.card\_acceptor.**city**<br /><br />string<br /><br />Optional                                                                | Card acceptor’s city.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| transaction.card\_acceptor.**state**<br /><br />string<br /><br />Optional                                                               | Two-character state, provincial, territorial, or federal abbreviation.<br /><br />For a complete list of valid abbreviations, see <a href="/core-api/kyc-verification/#_valid_state_provincial_territorial_and_federal_abbreviations">Valid state, provincial, territorial, and federal abbreviations</a>.<br /><br />**Allowable Values:**<br /><br />2 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| transaction.card\_acceptor.**postal\_code**<br /><br />string<br /><br />Optional                                                        | Card acceptor’s postal code.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| transaction.card\_acceptor.**country\_code**<br /><br />string<br /><br />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.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| transaction.card\_acceptor.**poi**<br /><br />object<br /><br />Optional                                                                 | Contains information about the point of sale, including details about how the card was presented.<br /><br />Returned if provided by the card network, and if the request uses Transaction Model v1 of the Marqeta Core API. Not returned for Transaction Model v2 requests.<br /><br />**Allowable Values:**<br /><br /><code>tid</code>, <code>partial\_approval\_capable</code>, <code>cardholder\_presence</code>, <code>card\_presence</code>, <code>pin\_present</code>, <code>special\_condition\_indicator</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| transaction.card\_acceptor.poi.**tid**<br /><br />string<br /><br />Optional                                                             | Card acceptor or terminal identification number.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| transaction.card\_acceptor.poi.**partial\_approval\_capable**<br /><br />string<br /><br />Optional                                      | Indicates whether the card acceptor or terminal supports partial-approval transactions.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| transaction.card\_acceptor.poi.**cardholder\_presence**<br /><br />string<br /><br />Optional                                            | Indicates whether the cardholder was present during the transaction.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| transaction.card\_acceptor.poi.**card\_presence**<br /><br />string<br /><br />Optional                                                  | Indicates whether the card was present during the transaction.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| transaction.card\_acceptor.poi.**pin\_present**<br /><br />string<br /><br />Optional                                                    | Indicates whether the cardholder entered a PIN during the transaction.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| transaction.card\_acceptor.poi.**special\_condition\_indicator**<br /><br />string<br /><br />Optional                                   | Indicates a higher-risk operation, such as a quasi-cash or cryptocurrency transaction.<br /><br />These transactions typically involve non-financial institutions.<br /><br />**Allowable Values:**<br /><br /><code>UNSPECIFIED</code>, <code>CRYPTOCURRENCY\_PURCHASE</code>, <code>QUASI\_CASH</code>, <code>DEBT\_PAYMENT</code>, <code>CENTRAL\_BANK\_DIGITAL\_CURRENCY\_PURCHASE</code>, <code>STABLECOIN\_PURCHASE</code>, <code>BLOCKCHAIN\_NATIVE\_TOKEN\_PURCHASE</code>, <code>NON\_FUNGIBLE\_TOKEN\_PURCHASE</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| transaction.**account\_funding**<br /><br />object<br /><br />Optional                                                                   | Information used when funding an account.<br /><br />**Allowable Values:**<br /><br />Valid <code>account\_funding</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| transaction.account\_funding.**first\_name**<br /><br />string<br /><br />Required                                                       | Account holder’s first name.<br /><br />**Allowable Values:**<br /><br />To pass AVS, must match the first name on record.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| transaction.account\_funding.**last\_name**<br /><br />string<br /><br />Optional                                                        | Account holder’s last name.<br /><br />**Allowable Values:**<br /><br />To pass AVS, must match the last name on record.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| transaction.account\_funding.**receiver\_name**<br /><br />string<br /><br />Optional                                                    | Recipient’s name.<br /><br />**Allowable Values:**<br /><br />To pass AVS, must match the name on record.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| transaction.account\_funding.**funding\_source**<br /><br />string<br /><br />Required                                                   | Describes the source of the funding.<br /><br />**Allowable Values:**<br /><br /><code>CREDIT</code>, <code>DEBIT</code>, <code>PREPAID</code>, <code>DEPOSIT\_ACCOUNT</code>, <code>CASH</code>, <code>MOBILE\_MONEY\_ACCOUNT</code>, <code>NON\_VISA\_CREDIT</code>, <code>CHECK</code>, <code>ACH</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| transaction.account\_funding.**receiver\_account\_type**<br /><br />string<br /><br />Required                                           | Identifies the account type used for the funding request.<br /><br />**Allowable Values:**<br /><br /><code>OTHER</code>, <code>RTN\_BANK\_ACCOUNT</code>, <code>IBAN</code>, <code>CARD\_ACCOUNT</code>, <code>EMAIL</code>, <code>PHONE\_NUMBER</code>, <code>BANK\_ACCOUNT\_NUMBER\_AND\_BANK\_IDENTIFICATION\_CODE</code>, <code>WALLET\_ID</code>, <code>SOCIAL\_NETWORK\_ID</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| transaction.account\_funding.**transaction\_purpose**<br /><br />string<br /><br />Optional                                              | Identifies the purpose of the transaction.<br /><br />**Allowable Values:**<br /><br />- <code>FAMILY\_SUPPORT</code><br />- <code>REGULAR\_LABOR\_TRANSFERS</code><br />- <code>TRAVEL\_AND\_TOURISM</code><br />- <code>EDUCATION</code><br />- <code>MEDICAL\_TREATMENT</code><br />- <code>EMERGENCY\_NEED</code><br />- <code>SAVINGS</code><br />- <code>GIFTS</code><br />- <code>OTHER</code><br />- <code>SALARY</code><br />- <code>CROWD\_LENDING</code><br />- <code>CRYPTO\_CURRENCY</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| transaction.account\_funding.**transaction\_type**<br /><br />string<br /><br />Required                                                 | Describes the type of transaction.<br /><br />**Allowable Values:**<br /><br /><code>ACCOUNT\_TO\_ACCOUNT</code>, <code>PERSON\_TO\_PERSON</code>, <code>WALLET\_TRANSFER</code>, <code>MONEY\_TRANSFER\_BY\_BANK</code>, <code>BUSINESS\_TO\_BUSINESS</code>, <code>DISBURSEMENT</code>, <code>GOVERNMENT\_DISBURSEMENT</code>, <code>GAMBLING\_PAYOUT</code>, <code>LOYALTY</code>, <code>MERCHANT\_DISBURSEMENT</code>, <code>ONLINE\_GAMBLING\_PAYOUT</code>, <code>PENSION\_DISBURSEMENT</code>, <code>PREPAID\_LOADS</code>, <code>CARD\_BILL\_PAYMENT</code>, <code>BILL\_PAYMENT</code>, <code>CASH\_CLAIM</code>, <code>CASH\_IN</code>, <code>CASH\_OUT</code>, <code>MOBILE\_AIR\_TIME\_PAYMENT</code>, <code>MONEY\_TRANSFER\_BY\_MERCHANT</code>, <code>FACE\_TO\_FACE\_MERCHANT\_PAYMENT</code>, <code>GOVERNMENT\_PAYMENT</code>, <code>PAYMENTS\_GOODS\_SERVICES</code>, <code>FUNDS\_TRANSFER</code>, <code>VISA\_ACCEPT</code>, <code>GENERAL\_BUSINESS\_TO\_BUSINESS\_TRANSFER</code>, <code>BUSINESS\_TO\_BUSINESS\_TRANSFER</code>, <code>CASH\_DEPOSIT</code>, <code>PURCHASE\_REPAYMENT</code>, <code>AFT\_OR\_OCT\_ELIGIBILITY</code>, <code>CONSUMER\_BILL\_PAYMENT</code>, <code>REQUEST\_TO\_PAY</code>, <code>LIQUID\_ASSET</code>, <code>FAST\_REFUND</code>, <code>GAMING\_PAYMENT</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| transaction.**gpa\_order**<br /><br />object<br /><br />Optional                                                                         | Contains information about a GPA order, including fees, funding sources, and addresses. See <a href="/core-api/gpa-orders/">GPA Orders</a> for more information.<br /><br />**Allowable Values:**<br /><br />Existing <code>gpa\_order</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| transaction.gpa\_order.**amount**<br /><br />decimal<br /><br />Required                                                                 | Amount funded.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| transaction.gpa\_order.**created\_time**<br /><br />datetime<br /><br />Required                                                         | Date and time when the GPA order was created, in UTC.<br /><br />**Allowable Values:**<br /><br />date-time<br /><br />**Format:**<br />yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| transaction.gpa\_order.**currency\_code**<br /><br />string<br /><br />Required                                                          | The three-digit ISO 4217 currency code.<br /><br />**Allowable Values:**<br /><br />Valid three-digit <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" rel="noopener">ISO 4217 currency code</a>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| transaction.gpa\_order.**fees**<br /><br />array of objects<br /><br />Optional                                                          | List of fees associated with the transaction. This array is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />Array of existing <code>fees</code> objects                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| transaction.gpa\_order.fees\[].**fee**<br /><br />object<br /><br />Required                                                             | Contains details about the fee.<br /><br />**Allowable Values:**<br /><br /><code>active</code>, <code>amount</code>, <code>created\_time</code>, <code>currency\_code</code>, <code>last\_modified\_time</code>, <code>name</code>, <code>real\_time\_assessment</code>, <code>tags</code>, <code>token</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| transaction.gpa\_order.fees\[].fee.**active**<br /><br />boolean<br /><br />Required                                                     | Indicates whether the fee is active.<br /><br />**Allowable Values:**<br /><br /><code>true</code>, <code>false</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| transaction.gpa\_order.fees\[].fee.**amount**<br /><br />decimal<br /><br />Required                                                     | Amount of the fee.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| transaction.gpa\_order.fees\[].fee.**created\_time**<br /><br />datetime<br /><br />Required                                             | Date and time when the <code>fees</code> object was created, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddTHH:mm:ssZ                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| transaction.gpa\_order.fees\[].fee.**currency\_code**<br /><br />string<br /><br />Required                                              | The three-digit ISO 4217 currency code.<br /><br />**Allowable Values:**<br /><br />Valid three-digit <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" rel="noopener">ISO 4217 currency code</a>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| transaction.gpa\_order.fees\[].fee.**last\_modified\_time**<br /><br />datetime<br /><br />Required                                      | Date and time when the GPA order was last modified, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddTHH:mm:ssZ                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| transaction.gpa\_order.fees\[].fee.**name**<br /><br />string<br /><br />Required                                                        | Name of the fee.<br /><br />**Allowable Values:**<br /><br />50 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| transaction.gpa\_order.fees\[].fee.**real\_time\_assessment**<br /><br />object<br /><br />Optional                                      | Controls the assessment of real-time fees.<br /><br />**Allowable Values:**<br /><br /><code>domestic\_enabled</code>, <code>international\_enabled</code>, <code>transaction\_type</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| transaction.gpa\_order.fees\[].fee.real\_time\_assessment.**domestic\_enabled**<br /><br />boolean<br /><br />Optional                   | Enables fee assessments for cases in which the origin of the transaction acquirer is inside the US.<br /><br />**Allowable Values:**<br /><br /><code>true</code>, <code>false</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| transaction.gpa\_order.fees\[].fee.real\_time\_assessment.**international\_enabled**<br /><br />boolean<br /><br />Optional              | Enables fee assessments for cases in which the origin of the transaction acquirer is outside the US.<br /><br />**Allowable Values:**<br /><br /><code>true</code>, <code>false</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| transaction.gpa\_order.fees\[].fee.real\_time\_assessment.**transaction\_type**<br /><br />string<br /><br />Optional                    | Indicates the type of transactions for which the fee is assessed.<br /><br />**Allowable Values:**<br /><br /><code>authorization</code>, <code>pindebit.atm.withdrawal</code>, <code>pindebit</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| transaction.gpa\_order.fees\[].fee.**tags**<br /><br />string<br /><br />Optional                                                        | Descriptive metadata about the fee.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| transaction.gpa\_order.fees\[].fee.**token**<br /><br />string<br /><br />Required                                                       | Unique identifier of the <code>fees</code> object.<br /><br />**Allowable Values:**<br /><br />Existing <code>fees</code> object token                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| transaction.gpa\_order.fees\[].**memo**<br /><br />string<br /><br />Optional                                                            | Additional text that describes the fee transfer.<br /><br />**Allowable Values:**<br /><br />1–99 chars                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| transaction.gpa\_order.fees\[].**tags**<br /><br />string<br /><br />Optional                                                            | Descriptive metadata about the fee.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| transaction.gpa\_order.fees\[].**token**<br /><br />string<br /><br />Required                                                           | Unique identifier of the fee.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| transaction.gpa\_order.fees\[].**transaction\_token**<br /><br />string<br /><br />Required                                              | Unique identifier of the fee transaction.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| transaction.gpa\_order.**funding**<br /><br />object<br /><br />Required                                                                 | Contains funding information for the transaction, including funding amount, type, and time of transaction, in UTC.<br /><br />**Allowable Values:**<br /><br /><code>amount</code>, <code>gateway\_log</code>, <code>source</code>, <code>source\_address</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| transaction.gpa\_order.funding.**amount**<br /><br />decimal<br /><br />Optional                                                         | Amount of funds loaded into the GPA.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| transaction.gpa\_order.funding.**gateway\_log**<br /><br />object<br /><br />Optional                                                    | Contains information from the JIT Funding gateway in response to a funding request.<br /><br />**Allowable Values:**<br /><br /><code>duration</code>, <code>message</code>, <code>order\_number</code>, <code>response</code>, <code>timed\_out</code>, <code>transaction\_id</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| transaction.gpa\_order.funding.gateway\_log.**duration**<br /><br />integer<br /><br />Optional                                          | Length of time taken (in milliseconds) by the gateway to respond to a funding request.<br /><br />**Allowable Values:**<br /><br />Any integer                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| transaction.gpa\_order.funding.gateway\_log.**message**<br /><br />string<br /><br />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.<br /><br />**Allowable Values:**<br /><br /><code>Approved or completed successfully</code>, <code>Declined by gateway</code>, <code>Operation timeout</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| transaction.gpa\_order.funding.gateway\_log.**order\_number**<br /><br />string<br /><br />Required                                      | Customer order number, same value as <code>transaction.token</code>.<br /><br />**Allowable Values:**<br /><br />Existing <code>transaction.token</code> value                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| transaction.gpa\_order.funding.gateway\_log.**timed\_out**<br /><br />boolean<br /><br />Optional                                        | Whether the gateway sent a response (<code>true</code>) or timed out (<code>false</code>).<br /><br />**Allowable Values:**<br /><br /><code>true</code>, <code>false</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| transaction.gpa\_order.funding.gateway\_log.**transaction\_id**<br /><br />string<br /><br />Required                                    | Customer-defined identifier for the transaction.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| transaction.gpa\_order.funding.**source**<br /><br />object<br /><br />Required                                                          | Contains funding source information for the transaction, including the funding type and time of transaction, in UTC.<br /><br />**Allowable Values:**<br /><br /><code>active</code>, <code>created\_time</code>, <code>is\_default\_account</code>, <code>last\_modified\_time</code>, <code>token</code>, <code>type</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| transaction.gpa\_order.funding.source.**active**<br /><br />boolean<br /><br />Required                                                  | Whether the funding source is active.<br /><br />**Allowable Values:**<br /><br /><code>true</code>, <code>false</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| transaction.gpa\_order.funding.source.**created\_time**<br /><br />datetime<br /><br />Required                                          | Date and time when the funding source was created, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddTHH:mm:ssZ                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| transaction.gpa\_order.funding.source.**is\_default\_account**<br /><br />boolean<br /><br />Required                                    | Indicates whether the GPA order unload’s funding source is the default funding account.<br /><br />**Allowable Values:**<br /><br /><code>true</code>, <code>false</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| transaction.gpa\_order.funding.source.**last\_modified\_time**<br /><br />datetime<br /><br />Required                                   | Date and time when the funding source was last modified, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddTHH:mm:ssZ                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| transaction.gpa\_order.funding.source.**token**<br /><br />string<br /><br />Required                                                    | Unique identifier of the funding source.<br /><br />**Allowable Values:**<br /><br />Format: UUID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| transaction.gpa\_order.funding.source.**type**<br /><br />string<br /><br />Required                                                     | Funding type of the funding source.<br /><br />**Allowable Values:**<br /><br /><code>ach</code>, <code>paymentcard</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| transaction.gpa\_order.funding.**source\_address**<br /><br />object<br /><br />Optional                                                 | Contains information about the billing address of the funding source.<br /><br />**Allowable Values:**<br /><br />- <code>active</code><br />- <code>address\_1</code><br />- <code>address\_2</code><br />- <code>business\_token</code><br />- <code>city</code><br />- <code>country</code><br />- <code>created\_time</code><br />- <code>first\_name</code><br />- <code>is\_default\_address</code><br />- <code>last\_modified\_time</code><br />- <code>last\_name</code><br />- <code>phone</code><br />- <code>postal\_code</code><br />- <code>state</code><br />- <code>token</code><br />- <code>user\_token</code><br />- <code>zip</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| transaction.gpa\_order.funding.source\_address.**active**<br /><br />boolean<br /><br />Optional                                         | Whether the address is active.<br /><br />**Allowable Values:**<br /><br /><code>true</code>, <code>false</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| transaction.gpa\_order.funding.source\_address.**address\_1**<br /><br />string<br /><br />Required                                      | Street address of the funding source.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| transaction.gpa\_order.funding.source\_address.**address\_2**<br /><br />string<br /><br />Optional                                      | Additional address information for the funding source.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| transaction.gpa\_order.funding.source\_address.**business\_token**<br /><br />string<br /><br />Optional                                 | Unique identifier of the business account holder associated with the address. This field is returned if it exists in the resource. It is required if 'user\_token' is not specified.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| transaction.gpa\_order.funding.source\_address.**city**<br /><br />string<br /><br />Required                                            | City of the funding source.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| transaction.gpa\_order.funding.source\_address.**country**<br /><br />string<br /><br />Required                                         | Country of the funding source.<br /><br />**Allowable Values:**<br /><br />1–40 chars                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| transaction.gpa\_order.funding.source\_address.**created\_time**<br /><br />datetime<br /><br />Required                                 | Date and time when the address was created, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddTHH:mm:ssZ                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| transaction.gpa\_order.funding.source\_address.**first\_name**<br /><br />string<br /><br />Required                                     | First name of the account holder associated with the funding source.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| transaction.gpa\_order.funding.source\_address.**is\_default\_address**<br /><br />boolean<br /><br />Optional                           | Indicates whether this address is the default address used by the funding source.<br /><br />**Allowable Values:**<br /><br /><code>true</code>, <code>false</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| transaction.gpa\_order.funding.source\_address.**last\_modified\_time**<br /><br />datetime<br /><br />Required                          | Date and time when the address was last modified, in UTC.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddTHH:mm:ssZ                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| transaction.gpa\_order.funding.source\_address.**last\_name**<br /><br />string<br /><br />Required                                      | Last name of the account holder associated with the funding source.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| transaction.gpa\_order.funding.source\_address.**phone**<br /><br />string<br /><br />Optional                                           | Phone number of the funding source.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| transaction.gpa\_order.funding.source\_address.**postal\_code**<br /><br />string<br /><br />Required                                    | Postal code of the funding source.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| transaction.gpa\_order.funding.source\_address.**state**<br /><br />string<br /><br />Required                                           | Two-character state, provincial, territorial, or federal abbreviation.<br /><br />For a complete list of valid abbreviations, see <a href="/core-api/kyc-verification/#_valid_state_provincial_territorial_and_federal_abbreviations">Valid state, provincial, territorial, and federal abbreviations</a>.<br /><br />**Allowable Values:**<br /><br />2 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| transaction.gpa\_order.funding.source\_address.**token**<br /><br />string<br /><br />Required                                           | Unique identifier of the <code>funding\_source\_address</code> object.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| transaction.gpa\_order.funding.source\_address.**user\_token**<br /><br />string<br /><br />Optional                                     | Unique identifier of the user account holder associated with the address. This field is returned if it exists in the resource. It is required if 'business\_token' is not specified.<br /><br />**Allowable Values:**<br /><br />1–36 chars                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| transaction.gpa\_order.funding.source\_address.**zip**<br /><br />string<br /><br />Required                                             | United States ZIP code of the funding source.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| transaction.gpa\_order.**funding\_source\_address\_token**<br /><br />string<br /><br />Optional                                         | Unique identifier of the funding source address to use for this order.<br /><br />**Allowable Values:**<br /><br />Existing <code>funding\_source\_address</code> token                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| transaction.gpa\_order.**funding\_source\_token**<br /><br />string<br /><br />Required                                                  | Unique identifier of the funding source to use for this order.<br /><br />**Allowable Values:**<br /><br />Existing <code>funding\_source\_address</code> token                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| transaction.gpa\_order.**gateway\_message**<br /><br />string<br /><br />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.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br /><code>Approved or completed successfully</code>, <code>Declined by gateway</code>,<code>Operation timeout</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| transaction.gpa\_order.**gateway\_token**<br /><br />integer<br /><br />Optional                                                         | Unique identifier of the funding source to use for this order.<br /><br />**Allowable Values:**<br /><br />Existing <code>gateway\_token</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| transaction.gpa\_order.**jit\_funding**<br /><br />object<br /><br />Optional                                                            | Contains information about the JIT Funding load event, in which funds are loaded into an account.<br /><br />**Allowable Values:**<br /><br />- <code>acting\_user\_token</code><br />- <code>address\_verification</code><br />- <code>amount</code><br />- <code>balances</code><br />- <code>business\_token</code><br />- <code>decline\_reason</code><br />- <code>incremental\_authorization\_jit\_funding\_tokens</code><br />- <code>memo</code><br />- <code>method</code><br />- <code>original\_jit\_funding\_token</code><br />- <code>tags</code><br />- <code>token</code><br />- <code>user\_token</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| transaction.gpa\_order.jit\_funding.**amount**<br /><br />decimal<br /><br />Required                                                    | Requested amount of funding.<br /><br />**Allowable Values:**<br /><br />0 min                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| transaction.gpa\_order.jit\_funding.**balances**<br /><br />object<br /><br />Optional                                                   | Contains the GPA’s balance details.<br /><br />**Allowable Values:**<br /><br />Existing <code>balances</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| transaction.gpa\_order.jit\_funding.**business\_token**<br /><br />string<br /><br />Optional                                            | Holder of the business account that was funded.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| transaction.gpa\_order.jit\_funding.**decline\_reason**<br /><br />string<br /><br />Optional                                            | Reason why the transaction was declined.<br /><br />**Allowable Values:**<br /><br /><code>INVALID\_AMOUNT</code>, <code>INSUFFICIENT\_FUNDS</code>, <code>TRANSACTION\_NOT\_PERMITTED</code>, <code>SUSPECTED\_FRAUD</code>, <code>AMOUNT\_LIMIT\_EXCEEDED</code>, <code>TRANSACTION\_COUNT\_LIMIT\_EXCEEDED</code>, <code>DUPLICATE\_TRANSACTION</code>, <code>INVALID\_MERCHANT</code>, <code>INVALID\_CARD</code>, <code>NO\_CREDIT\_ACCOUNT</code>, <code>EXPIRED\_CARD</code>, <code>NO\_CHECKING\_ACCOUNT</code>, <code>NO\_SAVINGS\_ACCOUNT</code>, <code>STOP\_PAYMENT</code>, <code>REVOCATION\_AUTHORIZATION\_ORDER</code>, <code>REVOCATION\_ALL\_AUTHORIZATION\_ORDER</code>, <code>SOFT\_DECLINE\_AUTHENTICATION\_REQUIRED</code>, <code>CLOSED\_ACCOUNT</code>, <code>SOFT\_DECLINE\_PIN\_REQUIRED</code>, <code>CARD\_NOT\_ACTIVE</code>, <code>CARDHOLDER\_NOT\_ACTIVE</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| transaction.gpa\_order.jit\_funding.**incremental\_authorization\_jit\_funding\_tokens**<br /><br />array of strings<br /><br />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.<br /><br />**Allowable Values:**<br /><br />Existing incremental authorization JIT Funding tokens                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| transaction.gpa\_order.jit\_funding.**memo**<br /><br />string<br /><br />Optional                                                       | Additional information that describes the JIT Funding transaction.<br /><br />**Allowable Values:**<br /><br />99 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| transaction.gpa\_order.jit\_funding.**method**<br /><br />string<br /><br />Required                                                     | JIT Funding response type. See <a href="/core-api/gateway-jit-funding-messages/#_the_jit_funding_object">The jit\_funding object</a> for the purpose, funding event type, and description of each method.<br /><br />**Allowable Values:**<br /><br /><code>pgfs.authorization</code>, <code>pgfs.authorization.clearing</code>, <code>pgfs.authorization.advice</code>, <code>pgfs.authorization.incremental</code>, <code>pgfs.authorization.capture</code>, <code>pgfs.authorization.reversal</code>, <code>pgfs.authorization.cashback</code>, <code>pgfs.balanceinquiry</code>, <code>pgfs.auth\_plus\_capture</code>, <code>pgfs.refund</code>, <code>pgfs.refund.authorization</code>, <code>pgfs.refund.authorization.reversal</code>, <code>pgfs.refund.authorization.clearing</code>, <code>pgfs.force\_capture</code>, <code>pgfs.authorization.capture.chargeback</code>, <code>pgfs.authorization.capture.chargeback.reversal</code>, <code>pgfs.pindebit</code>, <code>pgfs.pindebit.chargeback</code>, <code>pgfs.pindebit.chargeback.reversal</code>, <code>pgfs.pindebit.cashback</code>, <code>pgfs.pindebit.refund</code>, <code>pgfs.pindebit.authorization</code>, <code>pgfs.pindebit.authorization.clearing</code>, <code>pgfs.pindebit.authorization.reversal</code>, <code>pgfs.pindebit.atm.withdrawal</code>, <code>pgfs.pindebit.balanceinquiry</code>, <code>pgfs.pindebit.quasi.cash</code>, <code>pgfs.dispute.credit</code>, <code>pgfs.dispute.debit</code>, <code>pgfs.directdeposit.credit</code>, <code>pgfs.directdeposit.debit</code>, <code>pgfs.directdeposit.credit.reversal</code>, <code>pgfs.directdeposit.debit.reversal</code>, <code>pgfs.adjustment.credit</code>, <code>pgfs.adjustment.debit</code>, <code>pgfs.auth\_plus\_capture.standin</code>, <code>pgfs.authorization.standin</code>, <code>pgfs.network.load</code>, <code>pgfs.original.credit.authorization</code>, <code>pgfs.original.credit.auth\_plus\_capture</code>, <code>pgfs.original.credit.authorization.clearing</code>, <code>pgfs.original.credit.authorization.reversal</code>, <code>pgfs.billpayment</code>, <code>pgfs.billpayment.capture</code>, <code>pgfs.billpayment.reversal</code>, <code>pgfs.atm.withdrawal</code>, <code>pgfs.atm.clearing.withdrawal</code>, <code>pgfs.authorization.quasi.cash</code>, <code>pgfs.authorization.clearing.quasi.cash</code>, <code>pgfs.authorization.account\_verification</code>, <code>pgfs.product.inquiry</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| transaction.gpa\_order.jit\_funding.**original\_jit\_funding\_token**<br /><br />string<br /><br />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.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| transaction.gpa\_order.jit\_funding.**tags**<br /><br />string<br /><br />Optional                                                       | Customer-defined tags related to the JIT Funding transaction.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| transaction.gpa\_order.jit\_funding.**token**<br /><br />string<br /><br />Required                                                      | Existing JIT Funding token matching the <code>funding.gateway\_log.transaction\_id</code> field of the associated GPA order. Note that the <code>transaction\_id</code> 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 <code>transaction\_id</code> field matches the token of the most recent message.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| transaction.gpa\_order.jit\_funding.**user\_token**<br /><br />string<br /><br />Required                                                | Holder of the user account that was funded.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| transaction.gpa\_order.**last\_modified\_time**<br /><br />datetime<br /><br />Required                                                  | Date and time when the <code>fees</code> object was last modified, in UTC.<br /><br />**Allowable Values:**<br /><br />date-time<br /><br />**Format:**<br />yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| transaction.gpa\_order.**memo**<br /><br />string<br /><br />Optional                                                                    | Additional descriptive text.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />99 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| transaction.gpa\_order.**response**<br /><br />object<br /><br />Required                                                                | Contains an assertion as to whether the Marqeta platform’s address verification data matches data provided by the cardholder.<br /><br />**Allowable Values:**<br /><br />Existing <code>response</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| transaction.gpa\_order.response.**code**<br /><br />string<br /><br />Required                                                           | Four-digit code corresponding with the outcome of the attempted transaction type.<br /><br />- 0000 – passed<br />- 0001 – did not pass<br /><br />**Allowable Values:**<br /><br />Four-digit code                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| transaction.gpa\_order.response.**memo**<br /><br />string<br /><br />Required                                                           | Information on the outcome of the attempted transaction type.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| transaction.gpa\_order.response.**additional\_information**<br /><br />string<br /><br />Optional                                        | Provides information about the relevant velocity control for the transaction, if applicable.<br /><br />**Allowable Values:**<br /><br />The <code>additional\_information</code> field returns a string in the following format: <code>\<Velocity control name>, cumulative transaction amount is \<X></code>, where <code>X</code> is the cumulative transaction amount value calculated by Marqeta. For example: <code>500 max spend per day, cumulative transaction amount is 750</code>.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| transaction.gpa\_order.**state**<br /><br />string<br /><br />Required                                                                   | Current status of the funding transaction.<br /><br />**Allowable Values:**<br /><br /><code>PENDING</code>, <code>CLEARED</code>, <code>COMPLETION</code>, <code>DECLINED</code>, <code>ERROR</code>,<code>ALL</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| transaction.gpa\_order.**tags**<br /><br />string<br /><br />Optional                                                                    | Comma-delimited list of tags describing the order.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| transaction.gpa\_order.**token**<br /><br />string<br /><br />Required                                                                   | Unique identifier of the GPA order.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| transaction.gpa\_order.**transaction\_token**<br /><br />string<br /><br />Required                                                      | Unique identifier of the transaction being funded.<br /><br />**Allowable Values:**<br /><br />Format: UUID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| transaction.gpa\_order.**user\_token**<br /><br />string<br /><br />Optional                                                             | Unique identifier of the user resource.<br /><br />This field is returned if it exists in the resource.<br /><br />**Allowable Values:**<br /><br />Existing user resource token                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| transaction.**original\_credit**<br /><br />object<br /><br />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.<br /><br />**Allowable Values:**<br /><br />Existing <code>original\_credit</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| transaction.original\_credit.**funding\_source**<br /><br />string<br /><br />Optional                                                   | Describes the source of the funding.<br /><br />**Allowable Values:**<br /><br /><code>CREDIT</code>, <code>DEBIT</code>, <code>PREPAID</code>, <code>DEPOSIT\_ACCOUNT</code>, <code>CASH</code>, <code>MOBILE\_MONEY\_ACCOUNT</code>, <code>NON\_VISA\_CREDIT</code>, <code>CHECK</code>, <code>ACH</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| transaction.original\_credit.**transaction\_type**<br /><br />string<br /><br />Optional                                                 | Describes the type of transaction.<br /><br />**Allowable Values:**<br /><br /><code>ACCOUNT\_TO\_ACCOUNT</code>, <code>PERSON\_TO\_PERSON</code>, <code>WALLET\_TRANSFER</code>, <code>MONEY\_TRANSFER\_BY\_BANK</code>, <code>BUSINESS\_TO\_BUSINESS</code>, <code>DISBURSEMENT</code>, <code>GOVERNMENT\_DISBURSEMENT</code>, <code>GAMBLING\_PAYOUT</code>, <code>LOYALTY</code>, <code>MERCHANT\_DISBURSEMENT</code>, <code>ONLINE\_GAMBLING\_PAYOUT</code>, <code>PENSION\_DISBURSEMENT</code>, <code>PREPAID\_LOADS</code>, <code>CARD\_BILL\_PAYMENT</code>, <code>BILL\_PAYMENT</code>, <code>CASH\_CLAIM</code>, <code>CASH\_IN</code>, <code>CASH\_OUT</code>, <code>MOBILE\_AIR\_TIME\_PAYMENT</code>, <code>MONEY\_TRANSFER\_BY\_MERCHANT</code>, <code>FACE\_TO\_FACE\_MERCHANT\_PAYMENT</code>, <code>GOVERNMENT\_PAYMENT</code>, <code>PAYMENTS\_GOODS\_SERVICES</code>, <code>FUNDS\_TRANSFER</code>, <code>VISA\_ACCEPT</code>, <code>GENERAL\_BUSINESS\_TO\_BUSINESS\_TRANSFER</code>, <code>BUSINESS\_TO\_BUSINESS\_TRANSFER</code>, <code>CASH\_DEPOSIT</code>, <code>PURCHASE\_REPAYMENT</code>, <code>AFT\_OR\_OCT\_ELIGIBILITY</code>, <code>CONSUMER\_BILL\_PAYMENT</code>, <code>REQUEST\_TO\_PAY</code>, <code>GAMING\_PAYMENT</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| transaction.original\_credit.**sender\_account\_type**<br /><br />string<br /><br />Optional                                             | The type of account from which the OCT draws funds.<br /><br />**Allowable Values:**<br /><br /><code>OTHER</code>, <code>RTN\_BANK\_ACCOUNT</code>, <code>IBAN</code>, <code>CARD\_ACCOUNT</code>, <code>EMAIL</code>, <code>PHONE\_NUMBER</code>, <code>BANK\_ACCOUNT\_NUMBER\_AND\_BANK\_IDENTIFICATION\_CODE</code>, <code>WALLET\_ID</code>, <code>SOCIAL\_NETWORK\_ID</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| transaction.original\_credit.**sender\_name**<br /><br />string<br /><br />Optional                                                      | Full name of the sender.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| transaction.original\_credit.**screening\_score**<br /><br />string<br /><br />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.<br /><br />A value of 999 means that no screening score is available.<br /><br />**Allowable Values:**<br /><br />000-100, 999                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| transaction.**account\_name\_verification**<br /><br />object<br /><br />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.<br /><br />**Allowable Values:**<br /><br /><code>on\_file</code>, <code>request</code>, <code>request\_type</code>, <code>response</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| transaction.account\_name\_verification.**on\_file**<br /><br />object<br /><br />Optional                                               | Contains the name of the cardholder for account name verification.<br /><br />**Allowable Values:**<br /><br /><code>first\_name</code>, <code>last\_name</code>, <code>middle\_name</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| transaction.account\_name\_verification.on\_file.**first\_name**<br /><br />string<br /><br />Optional                                   | First name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| transaction.account\_name\_verification.on\_file.**last\_name**<br /><br />string<br /><br />Optional                                    | Last name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| transaction.account\_name\_verification.on\_file.**middle\_name**<br /><br />string<br /><br />Optional                                  | Middle name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| transaction.account\_name\_verification.**request**<br /><br />object<br /><br />Optional                                                | Contains the name of the cardholder for account name verification.<br /><br />**Allowable Values:**<br /><br /><code>first\_name</code>, <code>last\_name</code>, <code>middle\_name</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| transaction.account\_name\_verification.request.**first\_name**<br /><br />string<br /><br />Optional                                    | First name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| transaction.account\_name\_verification.request.**last\_name**<br /><br />string<br /><br />Optional                                     | Last name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| transaction.account\_name\_verification.request.**middle\_name**<br /><br />string<br /><br />Optional                                   | Middle name of the cardholder.<br /><br />**Allowable Values:**<br /><br />40 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| transaction.account\_name\_verification.**request\_type**<br /><br />string<br /><br />Optional                                          | *(Mastercard only)* Indicates the type of authentication request.<br /><br />**Allowable Values:**<br /><br /><code>SENDER</code>, <code>RECEIVER</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| transaction.account\_name\_verification.**response**<br /><br />object<br /><br />Optional                                               | Contains an assertion as to whether the Marqeta platform’s address verification data matches data provided by the cardholder.<br /><br />**Allowable Values:**<br /><br />Existing <code>response</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| transaction.account\_name\_verification.response.**code**<br /><br />string<br /><br />Required                                          | Four-digit code corresponding with the outcome of the attempted transaction type.<br /><br />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. <code>0</code> indicates no validation was performed, <code>1</code> indicates the match was unsuccessful (unmatched), <code>2</code> indicates the match was partial, and <code>3</code> indicates the match was exact. For example:<br /><br />Code / First Name / Middle Name / Last Name / Full Name<br />0000 / Not validated / Not validated / Not validated / Not validated<br />1111 / Unmatched / Unmatched / Unmatched / Unmatched<br />3333 / Exact match / Exact match / Exact match / Exact match<br />1232 / Unmatched / Partial match / Exact match / Partial match<br /><br />**Allowable Values:**<br /><br />Four-digit code                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| transaction.account\_name\_verification.response.**memo**<br /><br />string<br /><br />Required                                          | Information on the outcome of the attempted transaction type.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| transaction.account\_name\_verification.response.**additional\_information**<br /><br />string<br /><br />Optional                       | Provides information about the relevant velocity control for the transaction, if applicable.<br /><br />**Allowable Values:**<br /><br />The <code>additional\_information</code> field returns a string in the following format: <code>\<Velocity control name>, cumulative transaction amount is \<X></code>, where <code>X</code> is the cumulative transaction amount value calculated by Marqeta. For example: <code>500 max spend per day, cumulative transaction amount is 750</code>.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| transaction.**address\_verification**<br /><br />object<br /><br />Optional                                                              | Contains address verification data: the postal code and street address 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.<br /><br />**Allowable Values:**<br /><br /><code>on\_file</code>, <code>request</code>, <code>response</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| transaction.address\_verification.**on\_file**<br /><br />object<br /><br />Optional                                                     | Contains the address of the cardholder for account address verification.<br /><br />**Allowable Values:**<br /><br /><code>postal\_code</code>, <code>street\_address</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| transaction.address\_verification.on\_file.**postal\_code**<br /><br />string<br /><br />Optional                                        | Postal code of the cardholder.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| transaction.address\_verification.on\_file.**street\_address**<br /><br />string<br /><br />Optional                                     | Street address of the cardholder.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| transaction.address\_verification.**request**<br /><br />object<br /><br />Optional                                                      | Contains the address of the cardholder for account address verification.<br /><br />**Allowable Values:**<br /><br /><code>postal\_code</code>, <code>street\_address</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| transaction.address\_verification.request.**postal\_code**<br /><br />string<br /><br />Optional                                         | Postal code of the cardholder.<br /><br />**Allowable Values:**<br /><br />10 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| transaction.address\_verification.request.**street\_address**<br /><br />string<br /><br />Optional                                      | Street address of the cardholder.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| transaction.address\_verification.**response**<br /><br />object<br /><br />Optional                                                     | Contains an assertion as to whether the Marqeta platform’s address verification data matches data provided by the cardholder.<br /><br />**Allowable Values:**<br /><br />Existing <code>response</code> object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| transaction.address\_verification.response.**code**<br /><br />string<br /><br />Required                                                | Four-digit code corresponding with the outcome of the attempted transaction type.<br /><br />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:<br /><br />Code / Address / Postal Code<br />0000 / Match / Match<br />0001 / Match / Unmatched<br />0100 / Unmatched / Match<br />0101 / Unmatched / Unmatched<br />0200 / Data not present / Match<br />0201 / Data not present / Unmatched<br />0002 / Match / Data not present<br />0102 / Unmatched / Data not present<br />0303 / Not validated / Not validated<br /><br />**Allowable Values:**<br /><br />Four-digit code                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| transaction.address\_verification.response.**memo**<br /><br />string<br /><br />Required                                                | Information on the outcome of the attempted transaction type.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| transaction.address\_verification.response.**additional\_information**<br /><br />string<br /><br />Optional                             | Provides information about the relevant velocity control for the transaction, if applicable.<br /><br />**Allowable Values:**<br /><br />The <code>additional\_information</code> field returns a string in the following format: <code>\<Velocity control name>, cumulative transaction amount is \<X></code>, where <code>X</code> is the cumulative transaction amount value calculated by Marqeta. For example: <code>500 max spend per day, cumulative transaction amount is 750</code>.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

<h2 id="_international_card_transactions_and_currency_conversion">
  International card transactions and currency conversion
</h2>

With Simulations 2.0, you can simulate international card transactions based on currency and location.

<h3 id="_authorization_events_with_currency_conversion">
  Authorization events with currency conversion
</h3>

You can add currency conversion when simulating an `authorization`-type transaction by including the `currency_conversion` object and related details in a `POST` request to the `/simulations/cardtransactions/authorization` endpoint. For information about the `/simulations/cardtransactions/authorization` endpoint, see [Simulate authorization](/core-api/simulations-card-transactions/#authorization_event).

The following example shows an `authorization`-type transaction, with currency conversion, for a United States card transacting in the United Kingdom.

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h4 id="_sample_request_body">
  Sample request body
</h4>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 37.50,
  "card_acceptor": {
    "mid": "11111"
  },
  "network": "VISA",
  "currency_conversion": {
    "original_amount": 30.00,
    "conversion_rate": 1.25,
    "original_currency_code": "GBP"
  }
}
```

See the full response body structure at [Response body](/core-api/simulations-card-transactions/#simulation_response_body).

<h4 id="_sample_response_body">
  Sample response body
</h4>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "authorization",
    "state": "PENDING",
    "token": "**CURRENCY_AUTHORIZATION_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": 0,
      "memo": "Approved or completed successfully"
    },
    "created_time": "2022-12-06T21:39:43.000Z",
    "user_transaction_time": "2022-12-06T21:39:43.000Z",
    "settlement_date": "2022-12-06T00:00:00.000Z",
    "amount": 37.50,
    "gpa": {
      "ledger_balance": 250.00,
      "available_balance": 212.25,
      "impacted_amount": -37.50
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 30.00,
      "conversion_rate": 1.25,
      "original_currency_code": 826
    },
    "network": "VISA",
    "subnetwork": "VISANET",
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL"
    }
  }
}
```

<h3 id="_clearing_events_with_currency_conversion">
  Clearing events with currency conversion
</h3>

You can add currency conversion when simulating an `authorization.clearing`-type transaction by including the `currency_conversion` object and related details in a `POST` request to the `/simulations/cardtransactions/authorization.clearing` endpoint. For more information about the `/simulations/cardtransactions/authorization.clearing` endpoint, see [Simulate authorization clearing](/core-api/simulations-card-transactions/#authorization_clearing_event).

The following example shows an `authorization.clearing`-type transaction, with currency conversion, for a United States card in the United Kingdom.

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h4 id="_sample_request_body_2">
  Sample request body
</h4>

```json JSON lines wrap theme={null}
{
  "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
  "amount": 37.50,
  "currency_conversion": {
    "original_amount": 30.00,
    "conversion_rate": 1.25,
    "original_currency_code": "GBP"
  }
}
```

See the full response body structure at [Response body](/core-api/simulations-card-transactions/#simulation_response_body).

<h4 id="_sample_response_body_2">
  Sample response body
</h4>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "authorization.clearing",
    "state": "COMPLETION",
    "token": "**AUTHORIZATION_CLEARING_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": 0,
      "memo": "Approved or completed successfully"
    },
    "created_time": "2022-12-06T21:41:48Z",
    "user_transaction_time": "2022-12-06T21:39:43Z",
    "settlement_date": "2022-12-06T00:00:00Z",
    "amount": 37.50,
    "gpa": {
      "ledger_balance": 212.25,
      "available_balance": 212.25,
      "impacted_amount": -37.50
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 30.00,
      "conversion_rate": 1.25,
      "original_currency_code": 826
    },
    "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
    "network": "VISA",
    "subnetwork": "VISANET",
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Card Acceptor Name",
      "city": "Seattle",
      "state": "WA",
      "country_code": "USA"
    }
  }
}
```

<h2 id="simulate_account_name_inquiry">
  Transactions with Account Name Inquiry
</h2>

Account Name Inquiry (ANI) is an account verification feature that is supported by both the Mastercard and Visa card networks. You can simulate the ANI feature with Simulations 2.0. For more information about ANI, see [About Account Name Inquiry](/developer-guides/account-name-inquiry/).

You can add account name verification when simulating an `authorization` transaction by including the `account_name_verification` object and related details in a `POST` request to the `/simulations/cardtransactions/authorization` endpoint. For information about the `/simulations/cardtransactions/authorization` endpoint, see [Simulate authorization](/core-api/simulations-card-transactions/#authorization_event).

<h3 id="_ani_for_visa">
  ANI for Visa
</h3>

The following example shows an `authorization` transaction, with account name verification, for the Visa network.

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h4 id="_sample_request_body_3">
  Sample request body
</h4>

```json JSON lines wrap theme={null}
{
    "card_token": "**CARD_TOKEN**",
    "amount": "0",
    "card_acceptor": {
        "mid": "11111"
    },
    "network": "VISA",
    "account_name_verification": {
        "request": {
            "first_name": "first",
            "middle_name": "middle",
            "last_name": "last"
        }
    }
}
```

See the full response body structure at [Response body](/core-api/simulations-card-transactions/#simulation_response_body).

<h4 id="_sample_response_body_3">
  Sample response body
</h4>

```json JSON expandable lines wrap theme={null}
{
    "transaction": {
        "type": "authorization",
        "state": "CLEARED",
        "token": "53f14f73-f830-4086-9ec6-f84ca5a30da9",
        "user_token": "89d9f7fb-f373-49a1-b28c-85539b1d0ca3",
        "card_token": "5ab74159-6346-4100-9959-c691c14b2e02",
        "response": {
            "code": "1830",
            "memo": "Card account verification success"
        },
        "created_time": "2024-02-12T20:04:25Z",
        "user_transaction_time": "2024-02-12T20:04:25Z",
        "settlement_date": "2024-02-12T00:00:00Z",
        "amount": "0.00",
        "request_amount": "0.00",
        "gpa": {
            "ledger_balance": "100.00",
            "available_balance": "100.00"
        },
        "currency_code": "USD",
        "currency_conversion": {
            "original_amount": "0.00",
            "conversion_rate": 1.0,
            "original_currency_code": "840"
        },
        "network": "VISA",
        "subnetwork": "VISANET",
        "acquirer_fee_amount": "0",
        "fraud": {
            "network": {
                "transaction_risk_score": 29,
                "account_risk_score": "3"
            }
        },
        "card_acceptor": {
            "mid": "000000000011111",
            "poi": {
                "tid": "TR100000",
                "partial_approval_capable": "0",
                "cardholder_presence": "0",
                "card_presence": "0",
                "channel": "OTHER",
                "processing_type": "MAGSTRIPE",
                "pin_present": "false"
            }
        },
        "original_credit": {},
        "account_name_verification": {
            "on_file": {
                "first_name": "First",
                "last_name": "Last",
                "middle_name": "Middle"
            },
            "request": {
                "first_name": "first",
                "last_name": "last",
                "middle_name": "middle"
            },
            "response": {
                "code": "3333",
                "memo": "First name match; Middle name match; Last name match; Full name match"
            }
        }
    }
}
```

<h3 id="_ani_for_mastercard">
  ANI for Mastercard
</h3>

The following example shows an `authorization` transaction, with account name verification, for the Mastercard network.

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h4 id="_sample_request_body_4">
  Sample request body
</h4>

```json JSON lines wrap theme={null}
{
    "card_token": "**CARD_TOKEN**",
    "amount": "0",
    "card_acceptor": {
        "mid": "11111"
    },
    "network": "MASTERCARD",
    "account_name_verification": {
        "request": {
            "first_name": "first",
            "middle_name": "middle",
            "last_name": "last"
        },
        "request_type": "SENDER"
    }
}
```

See the full response body structure at [Response body](/core-api/simulations-card-transactions/#simulation_response_body).

<h4 id="_sample_response_body_4">
  Sample response body
</h4>

```json JSON expandable lines wrap theme={null}
{
    "transaction": {
        "type": "authorization",
        "state": "CLEARED",
        "token": "044b9543-b7a0-4195-abf8-357f3b67444e",
        "user_token": "89d9f7fb-f373-49a1-b28c-85539b1d0ca3",
        "card_token": "5ab74159-6346-4100-9959-c691c14b2e02",
        "response": {
            "code": "1830",
            "memo": "Card account verification success"
        },
        "created_time": "2024-02-12T20:06:48Z",
        "user_transaction_time": "2024-02-12T20:06:48Z",
        "settlement_date": "2024-02-12T00:00:00Z",
        "amount": "0.00",
        "request_amount": "0.00",
        "gpa": {
            "ledger_balance": "100.00",
            "available_balance": "100.00"
        },
        "currency_code": "USD",
        "currency_conversion": {
            "original_amount": "0.00",
            "conversion_rate": 1.0,
            "original_currency_code": "840"
        },
        "network": "MASTERCARD",
        "acquirer_fee_amount": "0",
        "fraud": {
            "network": {
                "transaction_risk_score": 1,
                "transaction_risk_score_reason_code": "14",
                "transaction_risk_score_reason_description": "Suspicious grocery store activity"
            }
        },
        "card_acceptor": {
            "mid": "000000000011111",
            "poi": {
                "tid": "TR100000",
                "partial_approval_capable": "0",
                "cardholder_presence": "0",
                "card_presence": "1",
                "channel": "OTHER",
                "processing_type": "MAGSTRIPE",
                "pin_present": "false"
            }
        },
        "original_credit": {},
        "account_name_verification": {
            "on_file": {
                "first_name": "First",
                "last_name": "Last",
                "middle_name": "Middle"
            },
            "request": {
                "first_name": "first",
                "last_name": "last",
                "middle_name": "middle"
            },
            "response": {
                "code": "0003",
                "memo": "Full name match"
            }
        }
    }
}
```

<h2 id="_transactions_with_visa_flexible_credential">
  Transactions with Visa Flexible Credential
</h2>

The Visa Flexible Credential (VFC) feature allows cardholders to use their debit card for Buy Now, Pay Later (BNPL) credit transactions when you approve that transaction from your Just-in-Time Funding Gateway. By integrating VFC in your program, a single card product can toggle between debit and credit payment methods based on each transaction, bringing multiple funding sources to a single card.

You can simulate VFC transactions for `authorization`, `authorization.reversal`, `authorization.incremental`, and `refund.authorization transaction` by including the flex object and related details in a `POST` request to the following endpoints:

* `/simulations/cardtransactions/authorization`

* `/simulations/cardtransactions/authorization.reversal`

* `/simulations/cardtransactions/authorization.incremental`

* `/simulations/cardtransactions/refund.authorization`

For information about the `/simulations/cardtransactions/*` endpoints, see Simulate authorization.

<h3 id="_authorization_transaction_with_vfc">
  Authorization Transaction with VFC
</h3>

The following example shows an authorization transaction with VFC for the Visa network.

<h4 id="_sample_request_body_5">
  Sample request body
</h4>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

```json JSON lines wrap theme={null}
{
   "card_token": "**CARD_TOKEN**",
   "amount": "0",
   "card_acceptor": {
       "mid": "11111"
   },
   "network": "VISA",
    "flex": {
   "eligible": true,
   "eligible_products": ["DEBIT_TO_LOAN"]
   }
}
```

<h4 id="_sample_response_body_5">
  Sample response body
</h4>

```json JSON expandable lines wrap theme={null}
{
 "transaction": {
   "type": "authorization",
   "state": "PENDING",
   "token": "**TOKEN**",
   "user_token": "**USER_TOKEN**",
   "card_token": "**CARD_TOKEN**",
   "response": {
     "code": "0000",
     "memo": "Approved or completed successfully"
   },
   "created_time": "2025-08-18T22:36:10Z",
   "user_transaction_time": "2025-08-18T22:36:10Z",
   "settlement_date": "2025-08-18T00:00:00Z",
   "amount": "1.00",
   "anticipated_amount": "10.50",
   "request_amount": "1.00",
   "gpa": {
     "ledger_balance": "239.01",
     "available_balance": "0.00",
     "impacted_amount": "-1.00"
   },
   "currency_code": "USD",
   "currency_conversion": {
     "original_amount": "1.00",
     "conversion_rate": 1.0,
     "original_currency_code": "840"
   },
   "network": "VISA",
   "subnetwork": "VISANET",
   "acquirer_fee_amount": "0",
   "flex": {
     "eligible": "true",
     "selected_product": "DEBIT"
   },
   "fraud": {
     "network": {
       "transaction_risk_score": 34,
       "account_risk_score": "1"
     }
   },
   "card_acceptor": {
     "mid": "000000000011111",
     "poi": {
       "tid": "TR100000",
       "partial_approval_capable": "0",
       "cardholder_presence": "0",
       "card_presence": "0",
       "channel": "OTHER",
       "processing_type": "MANUAL",
       "pin_present": "false"
     }
   },
   "gpa_order": {
     "amount": "1.00",
     "created_time": "2025-08-18T22:36:10Z",
     "currency_code": "USD",
     "funding": {
       "amount": "1.00",
       "gateway_log": {
         "duration": 5,
         "message": "Approved or completed successfully",
         "order_number": "f1df3bf5-521f-f4r4-b063-bce75fd7bbef",
         "timed_out": false,
         "transaction_id": "eerewaee-9575-4653-te5a-fef5806b9872"
       },
       "source": {
         "active": true,
         "created_time": "2025-08-05T17:15:25Z",
         "is_default_account": false,
         "last_modified_time": "2025-08-05T17:15:25Z",
         "token": "**********2a6a",
         "type": "programgateway"
       }
     },
     "funding_source_token": "**********xxxx",
     "jit_funding": {
       "amount": "1.00",
       "balances": {},
       "method": "pgfs.authorization",
       "token": "e5bcfaee-9575-4653-883a-fe4re06b9872",
       "user_token": "3be8da9f-c5db-4052-803d-grewd976f8fb"
     },
     "last_modified_time": "2025-08-18T22:36:10Z",
     "response": {
       "code": "0000",
       "memo": "Approved or completed successfully"
     },
     "state": "PENDING",
     "token": "3er4430f-6e5e-41b0-b36f-339aea027818",
     "transaction_token": "41e45761-0a5c-46d8-bee1-dc667cfe323a",
     "user_token": "3be8da9f-vf45-4052-803d-9fec9976f8fb"
   },
   "original_credit": {}
 }
}
```

For more information about how to incorporate Visa Flexible Credential support in your program, contact your Marqeta representative.

<h2 id="authorization_event">
  Simulate authorization
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/authorization`

Authorization is the process of confirming whether a card is valid, business rules are met, and funds are sufficient, and then placing a temporary hold on those funds. Use this endpoint to simulate an `authorization` type transaction by including the `card_token` and other authorization details in your request.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body">
  Request body
</h3>

See [Authorization Event](/core-api/simulations-card-transactions/#authorization_event).

<h3 id="_sample_request_body_6">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 10,
  "card_acceptor": {
    "mid": "11111"
  },
  "network": "VISA"
}
```

<h3 id="_response_body_2">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_6">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "authorization",
    "state": "PENDING",
    "token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2024-12-06T21:39:43Z",
    "user_transaction_time": "2024-12-06T21:39:43Z",
    "settlement_date": "2024-12-06T00:00:00Z",
    "amount": 10,
    "gpa": {
      "ledger_balance": 250,
      "available_balance": 240,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": 840
    },
    "network": "VISA",
    "subnetwork": "VISANET",
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL"
    }
  }
}
```

<h2 id="authorization_advice_event">
  Simulate authorization advice
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/authorization.advice`

Authorization advice allows an amount to be decreased after the authorization. This endpoint allows you to simulate post-swipe adjustments. Simulate an `authorization.advice` transaction by including the `preceding_related_transaction_token` and other authorization details in your request.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_2">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_7">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "amount": 10,
  "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**"
}
```

<h3 id="_response_body_3">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_7">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "authorization.advice",
    "state": "PENDING",
    "token": "**AUTHORIZATION_ADVICE_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-07T18:25:28Z",
    "user_transaction_time": "2025-03-07T18:25:22Z",
    "settlement_date": "2025-03-07T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 250,
      "available_balance": 240,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 46,
        "account_risk_score": "9"
      }
    },
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="authorization_clearing_event">
  Simulate authorization clearing
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/authorization.clearing`

Clearing is the process of finalizing the hold on funds and posting the transaction on the cardholder’s account. This process is triggered by the merchant’s capture request. This endpoint simulates an `authorization.clearing` type transaction by including the `preceding_related_transaction_token` and `amount` in your request.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_3">
  Request body
</h3>

See [Authorization Clearing Event](/core-api/simulations-card-transactions/#authorization_clearing_event).

<h3 id="_sample_request_body_8">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
  "amount": 10
}
```

<h3 id="_response_body_4">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_8">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "authorization.clearing",
    "state": "COMPLETION",
    "token": "**AUTHORIZATION_CLEARING_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2024-12-06T21:41:48Z",
    "user_transaction_time": "2024-12-06T21:39:43Z",
    "settlement_date": "2024-12-06T00:00:00Z",
    "amount": 10,
    "gpa": {
      "ledger_balance": 240,
      "available_balance": 240,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": 826
    },
    "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
    "network": "VISA",
    "subnetwork": "VISANET",
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Card Acceptor Name",
      "city": "St. Petersburg",
      "state": "FL",
      "country_code": "USA"
    }
  }
}
```

<h2 id="authorization_reversal_event">
  Simulate authorization reversal
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/authorization.reversal`

A reversal releases the hold that was placed on account funds by an authorization, thus returning the funds to the account. This endpoint simulates an `authorization.reversal` type transaction by including the `original_transaction_token` and `amount` in your request.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_4">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_9">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
  "amount": 10
}
```

<h3 id="_response_body_5">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_9">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "authorization.reversal",
    "state": "CLEARED",
    "token": "**AUTHORIZATION_REVERSAL_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully",
      "created_time": "2025-03-23T19:46:23Z",
      "user_transaction_time": "2025-03-23T19:46:20Z",
      "settlement_date": "2025-03-23T00:00:00Z",
      "amount": 10,
      "request_amount": 10,
      "gpa": {
        "ledger_balance": 250,
        "available_balance": 250,
        "impacted_amount": 10
      },
      "currency_code": "USD",
      "currency_conversion": {
        "original_amount": 10,
        "conversion_rate": 1,
        "original_currency_code": "840"
      },
      "network": "VISA",
      "subnetwork": "VISANET",
      "acquirer_fee_amount": 0,
      "fraud": {
        "network": {
          "transaction_risk_score": 16,
          "account_risk_score": "4"
        }
      },
      "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
      "card_acceptor": {
        "mid": "000000000011111",
        "mcc": "6411",
        "name": "Marqeta Storefront",
        "city": "St. Petersburg",
        "state": "FL",
        "postal_code": "33705"
      }
    }
  }
}
```

<h2 id="authorization_incremental_event">
  Simulate incremental authorization
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/authorization.incremental`

Use this endpoint to simulate incremental authorization transactions. An incremental authorization is a request to add an additional dollar amount to an ongoing prior authorization. This type of transaction enables you to increase the final amount authorized as conditions change or additional charges accrue. A common use case is adding the gratuity (an incremental authorization) to the original total (a prior authorization) of a restaurant bill.

For this use case, you use two endpoints: one to create the authorization, and another to increment it.

* Create the authorization using the `/simulations/cardtransactions/authorization` endpoint:\
  **Action:** `POST`\
  **Endpoint:** `/simulations/cardtransactions/authorization`

- Increment the authorization using the `/simulations/cardtransactions/authorization.incremental` endpoint:\
  **Action:** `POST`\
  **Endpoint:** `/simulations/cardtransactions/authorization.incremental`

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_5">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_10">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "amount": 5,
  "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**"
}
```

<h3 id="_response_body_6">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_10">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "authorization.incremental",
    "state": "PENDING",
    "token": "**AUTHORIZATION_INCREMENTAL_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-02-22T18:10:12Z",
    "user_transaction_time": "2025-02-22T18:10:12Z",
    "settlement_date": "2025-02-22T00:00:00Z",
    "amount": 5,
    "request_amount": 5,
    "gpa": {
      "ledger_balance": 250,
      "available_balance": 220,
      "impacted_amount": -5
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 5,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="authorization_cashback_event">
  Simulate authorization cash back
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/authorization.cashback`

Use this endpoint to simulate `authorization.cashback` transactions, which covers authorization for cash back requested at a point-of-sale terminal. This simulation can be used to test dual-message cash back transactions.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_6">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_11">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 10,
  "card_acceptor": {
    "mid": "11111"
  },
  "network": "VISA",
  "cash_back_amount": 10
}
```

<h3 id="_response_body_7">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_11">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "authorization.cashback",
    "state": "PENDING",
    "token": "**AUTHORIZATION_CASHBACK_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-23T19:43:43Z",
    "user_transaction_time": "2025-03-23T19:43:43Z",
    "settlement_date": "2025-03-23T00:00:00Z",
    "amount": 20,
    "cash_back_amount": 10,
    "request_amount": 20,
    "gpa": {
      "ledger_balance": 250,
      "available_balance": 230,
      "impacted_amount": -20
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 20,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 85,
        "account_risk_score": "3"
      }
    },
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="authorization_atm_withdrawal_event">
  Simulate ATM withdrawal authorization
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/authorization.atm.withdrawal`

Use this endpoint to simulate `authorization.atm.withdrawal` transactions. In the EU, this includes authorization for withdrawing cash at an ATM. In the US, this event indicates that the cardholder got cash from a bank teller rather than an ATM. This simulation can be used to test dual-message ATM withdrawal transactions.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_7">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_12">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 10,
  "card_acceptor": {
    "mid": "11111"
  },
  "network": "VISA"
}
```

<h3 id="_response_body_8">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_12">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "authorization.atm.withdrawal",
    "state": "PENDING",
    "token": "**AUTHORIZATION_ATM_WITHDRAWAL_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-23T22:14:46Z",
    "user_transaction_time": "2025-03-23T22:14:46Z",
    "settlement_date": "2025-03-23T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 250,
      "available_balance": 240,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 44,
        "account_risk_score": "4"
      }
    },
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="authorization_clearing_atm_withdrawal_event">
  Simulate ATM withdrawal authorization clearing
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/authorization.clearing.atm.withdrawal`

Use this endpoint to simulate `authorization.clearing.atm.withdrawal` transactions, which completes an authorization for withdrawing cash at an ATM. This simulation can be used to test dual-message ATM withdrawal transactions.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_8">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_13">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "amount": 10,
  "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**"
}
```

<h3 id="_response_body_9">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_13">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "authorization.clearing.atm.withdrawal",
    "state": "COMPLETION",
    "token": "**AUTHORIZATION_CLEARING_ATM_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-23T22:18:31Z",
    "user_transaction_time": "2025-03-23T22:18:31Z",
    "settlement_date": "2025-03-23T00:00:00Z",
    "amount": 10,
    "amount_to_be_released": 0,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 240,
      "available_balance": 240,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705",
      "country_code": "USA"
    }
  }
}
```

<h2 id="authorization_quasi_cash_event">
  Simulate quasi-cash authorization
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/authorization.quasi.cash`

Use this endpoint to simulate `authorization.quasi.cash` transactions. This is for authorization at a point-of-sale terminal for items equivalent to cash, such as traveler’s checks, money orders, foreign currency, or gaming chips. This simulation can be used to test dual-message quasi-cash transactions.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_9">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_14">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 10,
  "card_acceptor": {
    "mid": "11111"
  },
  "network": "VISA"
}
```

<h3 id="_response_body_10">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_14">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "authorization.quasi.cash",
    "state": "PENDING",
    "token": "**AUTHORIZATION_QUASI_CASH_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-23T22:32:51Z",
    "user_transaction_time": "2025-03-23T22:32:51Z",
    "settlement_date": "2025-03-23T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 240,
      "available_balance": 240,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 17,
        "account_risk_score": "6"
      }
    },
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="authorization_clearing_quasi_cash_event">
  Simulate quasi-cash authorization clearing
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/authorization.clearing.quasi.cash`

Use this endpoint to simulate `authorization.clearing.quasi.cash` transactions, which completes an authorization at a point-of-sale terminal for items equivalent to cash, such as traveler’s checks, money orders, foreign currency, or gaming chips. This simulation can be used to test dual-message quasi-cash transactions.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_10">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_15">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "amount": 10,
  "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**"
}
```

<h3 id="_response_body_11">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_15">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "authorization.clearing.quasi.cash",
    "state": "COMPLETION",
    "token": "**AUTHORIZATION_CLEARING_QUASI_CASH_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-23T22:34:18Z",
    "user_transaction_time": "2025-03-23T22:34:18Z",
    "settlement_date": "2025-03-23T00:00:00Z",
    "amount": 10,
    "amount_to_be_released": 0,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 80,
      "available_balance": 80,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705",
      "country_code": "USA"
    }
  }
}
```

<h2 id="account_funding_authorization_event">
  Simulate AFT authorization
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/account.funding.authorization`

Use this endpoint to simulate Account Funding Transactions (AFTs) using `account.funding.authorization`.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_11">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_16">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 10,
  "network": "VISA",
  "account_funding": {
    "transaction_type": "ACCOUNT_TO_ACCOUNT",
    "funding_source": "CREDIT",
    "receiver_account_type": "CARD_ACCOUNT",
    "first_name": "FirstName",
    "last_name": "LastName"
  }
}
```

<h3 id="_response_body_12">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_16">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "account.funding.authorization",
    "state": "PENDING",
    "token": "**ACCOUNT_FUNDING_AUTHORIZATION_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-01-19T00:03:48Z",
    "user_transaction_time": "2025-01-19T00:03:48Z",
    "settlement_date": "2025-01-19T00:00:00Z",
    "amount": 10,
    "gpa": {
      "ledger_balance": 250,
      "available_balance": 240,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": 840
    },
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "card_acceptor": {
      "mid": "000984172732880",
      "mcc": 4829,
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": 33705
    },
    "account_funding": {
      "receiver_name": "FirstName LastName",
      "funding_source": "CREDIT",
      "transaction_type": "ACCOUNT_TO_ACCOUNT"
    },
    "original_credit": {
      "funding_source": "CREDIT",
      "transaction_type": "ACCOUNT_TO_ACCOUNT"
    }
  }
}
```

<h2 id="account_funding_authorization_clearing_event">
  Simulate AFT authorization clearing
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/account.funding.authorization.clearing`

Use this endpoint to simulate `account.funding.authorization.clearing` transactions.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_12">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_17">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "amount": 10,
  "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**"
}
```

<h3 id="_response_body_13">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_17">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "account.funding.authorization.clearing",
    "state": "COMPLETION",
    "token": "**ACCOUNT_FUNDING_AUTHORIZATION_CLEARING_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2024-12-06T21:47:21Z",
    "user_transaction_time": "2024-12-06T21:45:57Z",
    "settlement_date": "2024-12-06T00:00:00Z",
    "amount": 10,
    "gpa": {
      "ledger_balance": 240,
      "available_balance": 240,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": 840
    },
    "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
    "network": "VISA",
    "subnetwork": "VISANET",
    "card_acceptor": {
      "mid": "000984172732880",
      "mcc": "4829",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "country_code": "USA"
    }
  }
}
```

<h2 id="account_funding_authorization_reversal_event">
  Simulate AFT authorization reversal
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/account.funding.authorization.reversal`

Use this endpoint to simulate `account.funding.authorization.reversal` transactions.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_13">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_18">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "amount": 10,
  "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**"
}
```

<h3 id="_response_body_14">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_18">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "account.funding.authorization.reversal",
    "state": "CLEARED",
    "token": "**ACCOUNT_FUNDING_AUTHORIZATION_REVERSAL_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-23T21:31:40Z",
    "user_transaction_time": "2025-03-23T21:31:37Z",
    "settlement_date": "2025-03-23T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 250,
      "available_balance": 250,
      "impacted_amount": 10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 44,
        "account_risk_score": "2"
      }
    },
    "card_acceptor": {
      "mid": "000984172732880",
      "mcc": "4829",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="account_funding_auth_plus_capture_event">
  Simulate AFT authorization and capture
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/account.funding.auth_plus_capture`

Use this endpoint to simulate `account.funding.auth_plus_capture` transactions.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_14">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_19">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 10,
  "network": "VISA",
  "account_funding": {
    "transaction_type": "ACCOUNT_TO_ACCOUNT",
    "funding_source": "CREDIT",
    "receiver_account_type": "CARD_ACCOUNT",
    "first_name": "FirstName",
    "last_name": "LastName"
  }
}
```

<h3 id="_response_body_15">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_19">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "account.funding.auth_plus_capture",
    "state": "COMPLETION",
    "token": "**ACCOUNT_FUNDING_AUTH_PLUS_CAPTURE_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-04-05T20:23:33Z",
    "user_transaction_time": "2025-04-05T20:23:33Z",
    "settlement_date": "2025-04-05T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 240,
      "available_balance": 240,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "network": "VISA",
    "subnetwork": "VISANETDEBIT",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 15,
        "account_risk_score": "3"
      }
    },
    "card_acceptor": {
      "mid": "000984172732880",
      "mcc": "4829",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    },
    "account_funding": {
      "receiver_name": "fName lName",
      "funding_source": "CREDIT",
      "transaction_type": "ACCOUNT_TO_ACCOUNT"
    },
    "original_credit": {
      "funding_source": "CREDIT",
      "transaction_type": "ACCOUNT_TO_ACCOUNT"
    }
  }
}
```

<h2 id="account_funding_auth_plus_capture_reversal_event">
  Simulate AFT authorization and capture reversal
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/account.funding.auth_plus_capture.reversal`

Use this endpoint to simulate `account.funding.auth_plus_capture.reversal` transactions.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_15">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_20">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "amount": 10,
  "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**"
}
```

<h3 id="_response_body_16">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_20">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "account.funding.auth_plus_capture.reversal",
    "state": "COMPLETION",
    "token": "**ACCOUNT_FUNDING_AUTH_PLUS_CAPTURE_REVERSAL_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-04-05T20:59:47Z",
    "user_transaction_time": "2025-04-05T20:59:38Z",
    "settlement_date": "2025-04-05T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 250,
      "available_balance": 250,
      "impacted_amount": 10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 28,
        "account_risk_score": "1"
      }
    },
    "card_acceptor": {
      "mid": "000984172732880",
      "mcc": "4829",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="refund_event">
  Simulate refund
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/refund`

Use this endpoint to simulate an offline refund. Refunds are not associated with a token, so a `preceding_related_transaction_token` is not needed.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_16">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_21">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 10,
  "card_acceptor": {
    "mid": "11111"
  },
  "network": "VISA"
}
```

<h3 id="_response_body_17">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_21">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "refund",
    "state": "COMPLETION",
    "token": "**REFUND_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-07T21:46:29Z",
    "user_transaction_time": "2025-03-07T21:46:29Z",
    "settlement_date": "2025-03-07T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 250,
      "available_balance": 250,
      "impacted_amount": 10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "card_acceptor": {
      "mid": "11111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705",
      "country_code": "USA"
    }
  }
}
```

<h2 id="refund_authorization_event">
  Simulate refund authorization
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/refund.authorization`

Online refund refers to the `refund.authorization` messages that Visa and Mastercard merchants can send to card issuers. These refund authorizations allow merchants to notify customers of a pending refund and give card issuers the opportunity to decline a refund. Like purchase authorizations, refund authorizations are eventually cleared or completed by a `refund.authorization.clearing` event. That refund authorization clearing is automatically accepted and processed by the Marqeta platform, regardless of your funding model.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_17">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_22">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 10,
  "network": "VISA",
  "card_acceptor": {
    "mid": "11111"
  }
}
```

<h3 id="_response_body_18">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_22">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "refund.authorization",
    "state": "PENDING",
    "token": "**REFUND_AUTHORIZATION_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-07T21:48:48Z",
    "user_transaction_time": "2025-03-07T21:48:48Z",
    "settlement_date": "2025-03-07T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 250,
      "available_balance": 250,
      "impacted_amount": 10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 22,
        "account_risk_score": "2"
      }
    },
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="refund_authorization_reversal_event">
  Simulate refund authorization reversal
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/refund.authorization.reversal`

Use this endpoint to reject `refund.authorization` transactions for online refunds.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_18">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_23">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "amount": 10,
  "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**"
}
```

<h3 id="_response_body_19">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_23">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "refund.authorization.reversal",
    "state": "CLEARED",
    "token": "**REFUND_AUTHORIZATION_REVERSAL_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-07T21:52:59Z",
    "user_transaction_time": "2025-03-07T21:52:28Z",
    "settlement_date": "2025-03-07T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 250,
      "available_balance": 250,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 13,
        "account_risk_score": "4"
      }
    },
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="refund_authorization_clearing_event">
  Simulate refund authorization clearing
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/refund.authorization.clearing`

Use this endpoint to simulate online refund clearing.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_19">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_24">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "amount": 10,
  "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**"
}
```

<h3 id="_response_body_20">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_24">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "refund.authorization.clearing",
    "state": "COMPLETION",
    "token": "**REFUND_AUTHORIZATION_CLEARING_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-07T21:54:58Z",
    "user_transaction_time": "2025-03-07T21:54:58Z",
    "settlement_date": "2025-03-07T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 250,
      "available_balance": 250,
      "impacted_amount": 10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705",
      "country_code": "USA"
    }
  }
}
```

<h2 id="pindebit_event">
  Simulate PIN-debit
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/pindebit`

Use this endpoint to simulate transactions using network debit rails.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_20">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_25">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 10,
  "network": "VISA",
  "card_acceptor": {
    "mid": "11111"
  },
  "card_options": {
    "pin": "6011"
  }
}
```

<h3 id="_response_body_21">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_25">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "pindebit",
    "state": "COMPLETION",
    "token": "**PINDEBIT_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN",
    "card_token": "**CARD_TOKEN",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-14T18:03:15Z",
    "user_transaction_time": "2025-03-14T18:03:15Z",
    "settlement_date": "2025-03-14T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 240,
      "available_balance": 240,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "network": "VISA",
    "subnetwork": "VISANETDEBIT",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 72,
        "account_risk_score": "9"
      }
    },
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="pindebit_reversal_event">
  Simulate PIN-debit reversal
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/pindebit.reversal`

Use this endpoint to simulate transactions using network debit rails.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_21">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_26">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "amount": 10,
  "preceding_related_transaction_token": "**PINDEBIT_TRANSACTION_TOKEN**"
}
```

<h3 id="_response_body_22">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_26">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "pindebit.reversal",
    "state": "CLEARED",
    "token": "**PINDEBIT_REVERSAL_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN",
    "card_token": "**CARD_TOKEN",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-09-19T16:12:59Z",
    "user_transaction_time": "2025-09-19T16:12:47Z",
    "settlement_date": "2025-09-19T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 250,
      "available_balance": 250,
      "impacted_amount": 10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "preceding_related_transaction_token": "**PINDEBIT_TRANSACTION_TOKEN**",
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 75,
        "account_risk_score": "2"
      }
    },
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "5542",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="pindebit_authorization_event">
  Simulate PIN-debit authorization
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/pindebit.authorization`

Use this endpoint to simulate PIN-debit authorization transactions. The typical use case for dual-message PIN-debit transactions is automated fuel dispenser transactions. The pump sends an initial authorization message to the card issuer. When fueling completes, a clearing message is sent with the final amount.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_22">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_27">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 10,
  "network": "VISA",
  "card_acceptor": {
    "mid": "11111"
  }
}
```

<h3 id="_response_body_23">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_27">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "pindebit.authorization",
    "state": "PENDING",
    "token": "**PINDEBIT_AUTHORIZATION_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN",
    "card_token": "**CARD_TOKEN",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-07T18:09:02Z",
    "user_transaction_time": "2025-03-07T18:09:02Z",
    "settlement_date": "2025-03-07T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 250,
      "available_balance": 240,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "network": "VISA",
    "subnetwork": "VISANETDEBIT",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 87,
        "account_risk_score": "7"
      }
    },
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "5542",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="pindebit_authorization_clearing_event">
  Simulate PIN-debit authorization clearing
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/pindebit.authorization.clearing`

Use this endpoint to clear `pindebit.authorization` transactions.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_23">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_28">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "amount": 10,
  "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**"
}
```

<h3 id="_response_body_24">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_28">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "pindebit.authorization.clearing",
    "state": "COMPLETION",
    "token": "**PINDEBIT_AUTHORIZATION_CLEARING_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN",
    "card_token": "**CARD_TOKEN",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-02-22T18:08:16Z",
    "user_transaction_time": "2025-02-22T18:08:15Z",
    "settlement_date": "2025-02-22T00:00:00Z",
    "amount": 10,
    "amount_to_be_released": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 240,
      "available_balance": 240,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "5542",
      "country_code": "USA"
    }
  }
}
```

<h2 id="pindebit_authorization_reversal_event">
  Simulate PIN-debit authorization reversal
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/pindebit.authorization.reversal`

Use this endpoint to reverse `pindebit.authorization` transactions.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_24">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_29">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "amount": 10,
  "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**"
}
```

<h3 id="_response_body_25">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_29">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "pindebit.authorization.reversal",
    "state": "CLEARED",
    "token": "**PINDEBIT_AUTHORIZATION_REVERSAL_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN",
    "card_token": "**CARD_TOKEN",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-07T18:12:39Z",
    "user_transaction_time": "2025-03-07T18:12:34Z",
    "settlement_date": "2025-03-07T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 250,
      "available_balance": 250,
      "impacted_amount": 10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 75,
        "account_risk_score": "2"
      }
    },
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "5542",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="pindebit_cashback_event">
  Simulate PIN-debit cash back
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/pindebit.cashback`

Simulate a PIN-debit transaction for cash back requested at a point-of-sale terminal.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_25">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_30">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 10,
  "cash_back_amount": 5,
  "card_acceptor": {
    "mid": "11111"
  }
}
```

<h3 id="_response_body_26">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_30">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "pindebit.cashback",
    "state": "COMPLETION",
    "token": "**PINDEBIT_CASHBACK_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN",
    "card_token": "**CARD_TOKEN",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-07T18:13:49Z",
    "user_transaction_time": "2025-03-07T18:13:49Z",
    "settlement_date": "2025-03-07T00:00:00Z",
    "amount": 15,
    "cash_back_amount": 5,
    "request_amount": 15,
    "gpa": {
      "ledger_balance": 235,
      "available_balance": 235,
      "impacted_amount": -15
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 15,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "network": "VISA",
    "subnetwork": "VISANETDEBIT",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 66,
        "account_risk_score": "5"
      }
    },
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="pindebit_refund_event">
  Simulate PIN-debit refund
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/pindebit.refund`

Use this endpoint to simulate a PIN-debit transaction refund.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_26">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_31">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 10,
  "card_acceptor": {
    "mid": "11111"
  }
}
```

<h3 id="_response_body_27">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_31">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "pindebit.refund",
    "state": "COMPLETION",
    "token": "**PINDEBIT_REFUND_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN",
    "card_token": "**CARD_TOKEN",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-07T18:15:15Z",
    "user_transaction_time": "2025-03-07T18:15:15Z",
    "settlement_date": "2025-03-07T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 260,
      "available_balance": 260,
      "impacted_amount": 10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "network": "VISA",
    "subnetwork": "VISANETDEBIT",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 77,
        "account_risk_score": "7"
      }
    },
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="pindebit_atm_withdrawal_event">
  Simulate PIN-debit ATM withdrawal
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/pindebit.atm.withdrawal`

Use this endpoint to simulate a cash withdrawal at an ATM.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_27">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_32">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 10,
  "cash_back_amount": 10,
  "card_acceptor": {
    "mid": "11111"
  }
}
```

<h3 id="_response_body_28">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_32">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "pindebit.atm.withdrawal",
    "state": "COMPLETION",
    "token": "**PINDEBIT_ATM_WITHDRAWAL_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-07T18:16:25Z",
    "user_transaction_time": "2025-03-07T18:16:25Z",
    "settlement_date": "2025-03-07T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 240,
      "available_balance": 240,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "network": "VISA",
    "subnetwork": "VISANETDEBIT",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 90,
        "account_risk_score": "1"
      }
    },
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="pindebit_balance_inquiry_event">
  Simulate PIN-debit balance inquiry
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/pindebit.balanceinquiry`

Use this endpoint to simulate a balance inquiry via the card network. This is a non-financial transaction.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_28">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_33">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "account_type": "savings",
  "card_acceptor": {
    "mid": "11111",
    "partial_approval_capable": "true"
  },
  "network": "VISA"
}
```

<h3 id="_response_body_29">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_33">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "pindebit.balanceinquiry",
    "state": "CLEARED",
    "token": "**PINDEBIT_BALANCEINQUIRY_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-02-22T18:08:39Z",
    "user_transaction_time": "2025-02-22T18:08:39Z",
    "settlement_date": "2025-02-22T00:00:00Z",
    "amount": 0,
    "request_amount": 0,
    "gpa": {
      "ledger_balance": 250,
      "available_balance": 250
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 0,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "network": "VISA",
    "subnetwork": "VISANETDEBIT",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 93,
        "account_risk_score": "1"
      }
    },
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="pindebit_quasi_cash_event">
  Simulate PIN-debit quasi-cash
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/pindebit.quasi.cash`

Use this endpoint to simulate `pindebit.quasi.cash` transactions. This PIN-debit transaction occurs at a point-of-sale terminal for items equivalent to cash, such as traveler’s checks, money orders, foreign currency, or gaming chips. This simulation can be used to test single-message cash back transactions.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_29">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_34">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 10,
  "card_acceptor": {
    "mid": "11111"
  },
  "network": "VISA"
}
```

<h3 id="_response_body_30">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_34">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "pindebit.quasi.cash",
    "state": "COMPLETION",
    "token": "**PINDEBIT_QUASI_CASH_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-23T22:30:08Z",
    "user_transaction_time": "2025-03-23T22:30:08Z",
    "settlement_date": "2025-03-23T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 240,
      "available_balance": 240,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "network": "VISA",
    "subnetwork": "VISANETDEBIT",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 69,
        "account_risk_score": "8"
      }
    },
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="original_credit_authorization_event">
  Simulate OCT authorization
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/original.credit.authorization`

Use this endpoint to simulate `original.credit.authorization` transactions. This is for original credit transaction (OCT) authorization for disbursing funds to a credit card. This simulation can be used to test dual-message OCT transactions.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_30">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_35">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "amount": 10,
  "card_token": "**CARD_TOKEN**",
  "card_acceptor": {
    "mid": "11111"
  }
}
```

<h3 id="_response_body_31">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_35">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "original.credit.authorization",
    "state": "PENDING",
    "token": "**ORIGINAL_CREDIT_AUTHORIZATION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-23T23:19:25Z",
    "user_transaction_time": "2025-03-23T23:19:25Z",
    "settlement_date": "2025-03-23T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 240,
      "available_balance": 240,
      "impacted_amount": 10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 83,
        "account_risk_score": "5"
      }
    },
    "card_acceptor": {
      "mid": "000000000001234",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="original_credit_authorization_clearing_event">
  Simulate OCT authorization clearing
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/original.credit.authorization.clearing`

Use this endpoint to simulate `original.credit.authorization.clearing` transactions, which completes an original credit transaction (OCT) authorization. This simulation can be used to test dual-message OCT transactions.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_31">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_36">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "amount": 10,
  "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**"
}
```

<h3 id="_response_body_32">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_36">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "original.credit.authorization.clearing",
    "state": "CLEARED",
    "token": "**ORIGINAL_CREDIT_AUTHORIZATION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-23T23:25:44Z",
    "user_transaction_time": "2025-03-23T23:19:25Z",
    "settlement_date": "2025-03-23T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 240,
      "available_balance": 240,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 1,
        "account_risk_score": "7"
      }
    },
    "card_acceptor": {
      "mid": "000000000001234",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="original_credit_auth_plus_capture_event">
  Simulate OCT authorization and capture
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/original.credit.auth_plus_capture`

Use this endpoint to simulate `original.credit.auth_plus_capture` transactions for single-message original credit transaction (OCT) for disbursing funds to a credit card. This simulation can be used to test single-message OCT transactions.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_32">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_37">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 10,
  "card_acceptor": {
    "mid": "11111"
  },
  "network": "VISA"
}
```

<h3 id="_response_body_33">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_37">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "original.credit.auth_plus_capture",
    "state": "COMPLETION",
    "token": "**ORIGINAL_CREDIT_AUTH_PLUS_CAPTURE_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-23T23:28:03Z",
    "user_transaction_time": "2025-03-23T23:28:03Z",
    "settlement_date": "2025-03-23T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 240,
      "available_balance": 240,
      "impacted_amount": 10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "network": "VISA",
    "subnetwork": "VISANETDEBIT",
    "acquirer_fee_amount": 0,
    "fraud": {
      "network": {
        "transaction_risk_score": 50,
        "account_risk_score": "7"
      }
    },
    "card_acceptor": {
      "mid": "000000000001111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="original_credit_auth_plus_capture_reversal_event">
  Simulate OCT authorization and capture reversal
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/original.credit.auth_plus_capture.reversal`

Use this endpoint to simulate `original.credit.auth_plus_capture.reversal` transactions to reverse the financial impact of a single-message original credit transaction (OCT). This simulation can be used to reverse single-message OCT transactions.

You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/#simulation_request_body) page.

<h3 id="_request_body_33">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_38">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "amount": 10,
  "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**"
}
```

<h3 id="_response_body_34">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_38">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "original.credit.auth_plus_capture.reversal",
    "state": "COMPLETION",
    "token": "**ORIGINAL_CREDIT_AUTH_PLUS_CAPTURE_REVERSAL_TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-03-23T23:30:25Z",
    "user_transaction_time": "2025-03-23T23:28:03Z",
    "settlement_date": "2025-03-23T00:00:00Z",
    "amount": 10,
    "request_amount": 10,
    "gpa": {
      "ledger_balance": 100,
      "available_balance": 80,
      "impacted_amount": -10
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": 10,
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "preceding_related_transaction_token": "**AUTHORIZATION_TRANSACTION_TOKEN**",
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": 0,
    "fraud": {
      "description": "Contains one or more fraud determinations by the card network that apply either to the transaction or to the cardholder's account.",
      "x-allowableValues": "Existing `fraud` object",
      "network": {
        "description": "Contains network-provided information about fraud determinations.",
        "x-allowableValues": "- `account_risk_score`\n- `account_risk_score_reason_code`\n- `transaction_risk_score`\n- `transaction_risk_score_reason_code`\n- `transaction_risk_score_reason_description`",
        "transaction_risk_score": {
          "description": "Network-provided risk score for the transaction.\nA higher score indicates higher risk.\nThe risk score is useful for making decisions about authorizations.",
          "x-allowableValues": "Mastercard: 0-99\nVisa: 0-99"
        },
        "account_risk_score": "4"
      }
    },
    "card_acceptor": {
      "mid": "000000000001111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL",
      "postal_code": "33705"
    }
  }
}
```

<h2 id="product_inquiry_event">
  Simulate Product Inquiry
</h2>

**Action:** `POST`\
**Endpoint:** `/simulations/cardtransactions/product.inquiry`

Use this endpoint to simulate a `product.inquiry` type transaction.

You can view the full [request body](/core-api/simulations-card-transactions/#simulation_request_body) structure on the [Simulations 2.0 — Card Transactions](/core-api/simulations-card-transactions/) page.

<h3 id="_request_body_34">
  Request body
</h3>

See the full request body structure at [Request body](/core-api/simulations-card-transactions/#simulation_request_body).

<h3 id="_sample_request_body_39">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "card_token": "**CARD_TOKEN**",
  "amount": 0,
  "card_acceptor": {
    "mid": "11111"
  },
  "flex": {
    "eligible": true,
    "eligible_products": [
      "DEBIT_TO_LOAN"
    ]
  },
  "network": "VISA"
}
```

<h3 id="_response_body_35">
  Response body
</h3>

See [Card Transaction Simulation Response](/core-api/simulations-card-transactions/#simulation_response_body).

<h3 id="_sample_response_body_39">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "transaction": {
    "type": "product.inquiry",
    "state": "CLEARED",
    "token": "**TRANSACTION_TOKEN**",
    "user_token": "**USER_TOKEN**",
    "card_token": "**CARD_TOKEN**",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "created_time": "2025-08-05T22:11:10Z",
    "user_transaction_time": "2025-08-05T22:11:10Z",
    "settlement_date": "2025-08-05T00:00:00Z",
    "amount": "0.00",
    "request_amount": "0.00",
    "gpa": {
      "ledger_balance": "17.01",
      "available_balance": "0.00"
    },
    "currency_code": "USD",
    "currency_conversion": {
      "original_amount": "0.00",
      "conversion_rate": 1,
      "original_currency_code": "840"
    },
    "network": "VISA",
    "subnetwork": "VISANET",
    "acquirer_fee_amount": "0",
    "flex": {
      "eligible": true,
      "selected_product": "DEBIT"
    },
    "card_acceptor": {
      "mid": "000000000011111",
      "mcc": "6411",
      "name": "Marqeta Storefront",
      "city": "St. Petersburg",
      "state": "FL"
    },
    "gpa_order": {
      "amount": "0.00",
      "created_time": "2025-08-05T22:11:11Z",
      "currency_code": "USD",
      "funding": {
        "amount": "0.00",
        "gateway_log": {
          "duration": 70,
          "message": "Approved or completed successfully",
          "order_number": "**ORDER_NUMBER**",
          "timed_out": false,
          "transaction_id": "**TRANSACTION_ID**"
        },
        "source": {
          "active": true,
          "created_time": "2025-08-05T17:15:25Z",
          "is_default_account": false,
          "last_modified_time": "2025-08-05T17:15:25Z",
          "token": "**SOURCE_TOKEN**",
          "type": "programgateway"
        }
      },
      "funding_source_token": "**SOURCE_TOKEN**",
      "jit_funding": {
        "amount": "0.00",
        "balances": {},
        "method": "pgfs.product.inquiry",
        "token": "**JIT_TOKEN**",
        "user_token": "**USER_TOKEN**"
      },
      "last_modified_time": "2025-08-05T22:11:11Z",
      "response": {
        "code": "0000",
        "memo": "Approved or completed successfully"
      },
      "state": "COMPLETION",
      "token": "**GPA_ORDER_TOKEN**",
      "transaction_token": "**TRANSACTION_TOKEN**",
      "user_token": "**USER_TOKEN**"
    },
    "original_credit": {}
  }
}
```


## Related topics

- [Postman Collection for Simulations 2.0](/docs/core-api/postman-collection-simulations.md)
- [Simulations 2.0 — Direct Deposits](/docs/core-api/simulations-direct-deposits.md)
- [2023 Release Notes](/docs/developer-guides/release-notes-2023.md)
- [2024 Release Notes](/docs/developer-guides/release-notes-2024.md)
- [Gateway JIT Funding Implementation Sample Code](/docs/developer-guides/gateway-jit-funding-implementation-sample-code.md)
