openapi: 3.0.3 info: contact: email: support@marqeta.com name: Marqeta description: Marqeta's Core API endpoints, conveniently annotated to enable code generation (including SDKs), test cases, and documentation. Currently in beta. termsOfService: https://www.marqeta.com/api-terms title: Core API version: 3.0.38 servers: - url: /v3 security: - mqAppAndAccessToken: [ ] tags: - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the `/acceptedcountries` endpoint to manage the countries where you authorize your cardholders to transact. name: Accepted Countries - description: |- The account holder group is a Marqeta platform resource that allows you to configure multiple account holders (user and/or business resources) as a group. It allows certain settings to be selectively applied, depending on whether or not an account holder has passed verification (KYC). You associate an account holder with an account holder group using the optional `account_holder_group_token` field in the user or business resource. Any account holder that you do not explicitly associate with a group is automatically associated with the program's default account holder group. The default group's name is "Default account holder group", its token is `DEFAULT_AHG`, and its configuration uses the default configuration values. name: Account Holder Groups - description: |- An authorization control limits spending by specified users at specified merchants. You can limit spending at a single merchant or at a group of merchants, and you can limit spending by a single user, users with a particular card product, or all users. You can block spending at all merchants by default and then allow it for specific merchants, or you can allow spending at all merchants by default and block it at specific merchants. [TIP] See <> for a tutorial that walks you through the creation of a spend control, as well as links to more information about merchant category codes. name: Authorization Controls - description: |- Auto reload enables you to automatically load a specified amount into an account when the account balance falls below a defined threshold. Auto reloads execute only when the account balance falls below the trigger value due to spending. They do not execute due to unloading of funds or because of lack of funds when a user or business is first created. You can define auto reloads at the level of an account holder, a card product, or a program. Each auto reload draws from a single funding source. In the case of auto reloads defined at more than one level, the following order of precedence (first to last) determines which auto reload is executed: . Account holder . Card product . Program name: Auto Reload - description: |- Use the `/balances` endpoint to retrieve the following general purpose account (GPA) balance details for a user or business: * *Ledger balance* - When using standard funding: The funds that are available to spend immediately, including funds from any authorized transactions that have not yet cleared. When using Just-in-Time (JIT) Funding: Authorized funds that are currently on hold, but not yet cleared. * *Available balance* - The ledger balance minus any authorized transactions that have not yet cleared. Also known as the cardholder's purchasing power. If you are using JIT Funding, this balance is usually 0.00. * *Cached balance* - Not currently used. * *Credit balance* - Not currently used. * *Pending credits* - ACH loads that have been accepted, but for which the funding time has not yet elapsed. name: Balances - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the `/banktransfers` endpoint to move funds between your program funding or cardholder account and an external account over the ACH Network. This kind of bank transfer is also known as ACH origination. You can create the following types of transfers: * *Push* funds from your program funding or cardholder account to an external account. * *Pull* funds from your external account into your program funding or cardholder account. You must have an existing bank account at a US bank to fund or receive funds from your Marqeta account. To add an external program funding source account to the Marqeta platform, send a `POST` request to the `/fundingsources/program/ach` endpoint to PUSH or PULL money from or to the Program Funding Account. To add an external account holder funding source account to the Marqeta platform, send a `POST` request to the `/fundingsources/ach` endpoint to PUSH or PULL money from or to the Cardholder Account. For more information on ACH funding, see <>. name: Funding via ACH - name: internal - description: |- Use the `/bulkissuances` endpoint to order physical payment cards in bulk. For more information on cards, card products, and bulk card ordering, see <>. Some attributes of the `bulkissuance` object can also be defined in an associated `card` or `cardproduct` object. If you define one of these attributes in more than one object, the Marqeta platform applies an order of precedence to determine which attribute to use at fulfillment time. The order of precedence is as follows: . `card` . `bulkissuance` . `cardproduct` Defining an attribute in an object with higher precedence does not overwrite the same attribute in a lower-precedence object; the Marqeta platform ignores these lower-precedence attributes. For more information on cards, see <>. name: Bulk Card Orders - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] // This source file is used by InfoDev to generate API reference documentation. // File location in GitHub is: // https://github.marqeta.com/openapi/coreapi/blob/main/openapi/businesses/openapi.yaml A business is a type of account holder that cannot directly hold cards, but can have parent/child relationships with card-holding users. A business can monitor and control card use by a specified group of users. Every business has a general purpose account (GPA). For information on how to create a user that has a child-to-parent hierarchical relationship to the business, see <>. [NOTE] A user can simultaneously be a child of a business and a parent of other users if the user is not configured to use the parent's account balances and the user's children are configured to use the parent's account balances. For more information on account holders, see <>. name: Businesses - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the `/businesstransitions` endpoints to transition business resources between states, as well as to retrieve and list state changes for a business resource. name: Business Transitions - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] //This source file is used by InfoDev to generate API reference documentation. File location in GitHub is: //openapi/cardproducts/openapi.yaml The card products resource represents the behavior and functionality of one or more cards (either physical or virtual). For example, attributes of the card product determine whether the associated cards can be used at an ATM and/or online and whether they are currently enabled. For physical cards, the card product determines color and other printing specifications for when the cards are manufactured and personalized. You can optionally associate authorization controls and/or velocity controls with card products to restrict where and how associated cards are used. If your program is Managed by Marqeta, then Marqeta will create the card products for your production environment. Some attributes of the `cardproduct` object can also be defined in an associated `bulkissuance` or `card` object. If you define one of these attributes in more than one object, the Marqeta platform applies an order of precedence to determine which attribute to use at fulfillment time. The order of precedence is as follows: . `card` . `bulkissuance` . `cardproduct` Defining an attribute in an object with higher precedence does not overwrite the same attribute in a lower-precedence object; the Marqeta platform ignores these lower-precedence attributes. For more information on cards, see <>. name: Card Products - description: |- The `card` resource represents a payment card. Cards are derived from and controlled by the `cardproduct` resource. For more information on cards, see <>. Some attributes of the `card` resource can be defined in an associated `bulkissuance` or `cardproduct` resource. If you define one of these attributes in more than one object, the order of precedence at fulfillment time is as follows: . `card` . `bulkissuance` . `cardproduct` Defining an attribute in an object with higher precedence overrides, but does not overwrite, the attribute in a lower-precedence object. name: Cards - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] // This source file is used by InfoDev to generate API reference documentation. // File location in GitHub is: // https://github.marqeta.com/openapi/coreapi/blob/main/openapi/cardtransitions/openapi.yaml Use the `/cardtransitions` API to set the state of an existing card. name: Card Transitions - description: |- Commando Mode is a fallback measure that ensures Gateway JIT-funded cards continue to function in the event that your system fails. If your system cannot respond to the JIT Funding request, the Marqeta platform makes a decision in your place based on defined business rules. The Marqeta platform stores any unsent webhooks for later transmission, ensuring that the card state and account balances on your system correspond with activity that occurred while Commando Mode was in effect. You can identify transactions that were funded while Commando Mode was in effect by examining the `subnetwork` field of the transaction record. * A `subnetwork` value of `GATEWAY_JIT` indicates that the transaction was funded through normal Gateway JIT Funding and that Commando Mode was not in effect at the time. * A value of `MANAGED_JIT` indicates that the transaction was funded while Commando Mode was in effect. In addition, the `standin_approved_by` field has a value of `COMMANDO_AUTO` or `COMMANDO_MANUAL` when Commando Mode is enabled for a transaction. When `COMMANDO_MANUAL` is configured, all transactions are processed via Commando Mode. When `COMMANDO_AUTO` is configured, Commando Mode is enabled only when a transaction times out or encounters an error. While Commando Mode is a form of Stand-in Processing (STIP), it is different than network STIP. Network STIP occurs when the card network cannot communicate with the Marqeta platform. Transactions handled by network STIP include the `standin_approved_by` field with a value of `NETWORK`. Commando Mode and Managed JIT Funding are functionally equivalent. See <> for more information. [NOTE] Commando Mode requires additional configuration. To configure Commando Mode control sets, contact your Marqeta representative. name: Commando Mode - name: accepted countries - name: account holder groups - name: accounting - name: accounts - name: auth controls - name: authentications - name: auto reloads - name: balance APIs - name: balance caches - name: bank transfers - name: bulk issuances - name: business transitions - name: businesses - name: businessidentitycheck - name: caches - name: calculation schedules - name: card products - name: card transitions - name: cardholder balances - name: cards - name: chargebacks - name: clearing - name: commando modes - name: cron jobs - name: digital wallet provision requests - name: digital wallet token transitions - name: digital wallet tokens - name: direct deposit accounts - name: direct deposits - name: fee charges - name: fee refunds - name: fees - name: file processing - name: funding sources - name: Funds movement - name: gateways - name: Generic money transfers - name: Google VCN digital wallet tokens - name: GPA fund transfers - name: gpa orders - name: health checks - name: Internal - BIN Pools - name: kyblog - name: kyc - name: mcc groups - name: merchantgroups - name: Operations for digital wallet token requestor maps - name: peer transfers - name: ping - name: pins - name: post transactions - name: program - name: program configs - name: program reserve - name: program transfers - name: push to card - name: real time fee groups - name: simulate - name: transactions - name: user transitions - name: users - name: velocity controls - name: web push provisioning - name: webhooks - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the account cards endpoints to create and retrieve credit cards that can access the credit line on a <>. Once a credit card is created, you can use the `/cards` endpoint to <> or <>. To receive webhook notifications when card transition or card action events occur, see <> and <> in Event Types. name: Account Cards - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the account refunds endpoints to create and retrieve account refunds on Marqeta's credit platform. You can issue account refunds to your cardholders with negative account balances. The maximum refund amount is the amount that brings the account balance to $0. For example, $4000 is the maximum refund amount for a -$4000 account balance. name: Account Refunds - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the `/credit/accounts/{account_token}/rewards` endpoint to create a one-time reward on a <>. Creating a reward triggers the creation of a <> belonging to the `REWARD` group. For more on reward journal entries, see <> in the About Credit Account Journal Entries guide. For the reward programs that are associated with a reward policy on a bundle, see <> and <>. name: Account Rewards - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the account transitions endpoints to create and retrieve account transitions on Marqeta's credit platform. An account transition occurs when a <> transitions to a new status. To receive webhook notifications when account transition events occur, see <> in Event Types. name: Account Transitions - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Credit substatuses can be applied to credit accounts or credit account holders. Substatuses should be applied only after verification with Customer Support and after the cardholder request for the substatus designation has been accepted. Substatuses define specific circumstances, such as bankruptcy, hardship or fraud. They also affect account behavior or activity, including interest accrual, authorization requests, and account termination. Substatus downstream account actions are not always reversible for the cardholder, which means that substatuses should be applied with caution. Use the substatus endpoints to apply or remove a substatus for a credit account or user. Applying a substatus causes immediate downstream changes to the account. For additional information about substatuses, see <> or <> in the <> guide. [NOTE] ==== The substatus `SCRA` stands for "Servicemembers Civilian Relief Act." The substatus `MLA` stands for "Military Lending Act." ==== For more information about receiving webhook notifications when account transition events occur, see <> on the <> page. [IMPORTANT] ==== If you are a Managed by Marqeta customer, a Marqeta customer service representative will apply the appropriate substatuses. ==== name: Credit Substatuses - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the adjustments endpoints to create and retrieve account adjustments on Marqeta's credit platform. An account adjustment adjusts the amount of a <> or account balance. Creating an adjustment triggers the creation of a <> belonging to the `ADJUSTMENT` group. For more on adjustment journal entries, see <> in the About Credit Account Journal Entries guide. name: Adjustments - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the credit balance refunds endpoint to issue a credit balance refund on <>. When an account balance is negative, a balance refund can be issued to bring the balance closer to 0. Creating a balance refund triggers the creation of a <> belonging to the `BALANCE_REFUND` group. For more on balance refund journal entries, see <> in the <> guide. name: Balance Refunds - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] The bundles feature on Marqeta's credit platform enables you to create and manage bundles by choosing the specific policies that make up a bundle. A bundle must contain one document policy, credit product policy, fee policy, APR policy, and an optional reward policy. The configurations of each policy in a bundle determine the characteristics and attributes of the bundle's associated credit accounts, reward programs, disclosures, and more. For more on how to configure a policy, see <>. [IMPORTANT] ==== To create and manage bundles, you must use the link:https://app.marqeta.com/[Marqeta Dashboard, window="_blank"]. For more on bundles in the dashboard, see <>.   + The following endpoints are displayed for reference purposes only. ==== name: Bundles - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the credit accounts endpoints to create and manage accounts on Marqeta's credit platform. A credit account centers around a single line of credit that can be accessed by one or more <>. An account's attributes, such as the credit limit, APR, and fees, are inherited from the <> on its associated bundle. For more on accounts, see <>. name: Credit Accounts - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the credit account disputes endpoints to create and manage disputes on a <>. For more on disputes, see <>. Creating a dispute triggers the creation of a <> belonging to the `DISPUTE` group. For more on dispute journal entries, see <> in the About Credit Account Journal Entries guide. name: Credit Account Disputes - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] [IMPORTANT] This feature is deprecated and replaced by credit product policies, which is part of the bundles feature. For more on policies and bundles in a credit program, see <>. The credit products feature on Marqeta's credit platform enables you to create and manage a credit product and customize its characteristics, such as the credit line range and required fees or APRs. Credit product characteristics determine the behaviors and attributes of associated credit accounts. For more on credit products, see <>. To receive webhook notifications when product transition events occur, see <> in Event Types. [IMPORTANT] ==== To create and manage credit products, you must use the link:https://app.marqeta.com/[Marqeta Dashboard, window="_blank"]. For more, see <>.   + The following endpoints are displayed for reference purposes only. ==== name: Credit Products - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the delinquency endpoints to retrieve details on a credit account's delinquency state and transitions. An account's delinquency state reflects whether an account is delinquent and past due on its payments or current and up to date on its payments. To receive webhook notifications when an account transitions between delinquent and current, see <> in Event Types. name: Delinquency - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the journal entries endpoints to retrieve journal entries made on an <> on Marqeta's credit platform. A journal entry is a record of an entry made on an account journal, such as a purchase transaction, fee, adjustment, and more. For more on the different types of journal entries, see <>. Journal entries originate when a journal entry event occurs, such as a cardholder making a purchase or an account holder making a payment. To receive webhook notifications when journal entry events occur, see <> in Event Types. name: Journal Entries - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] [IMPORTANT] ==== This feature is deprecated and replaced by journal entries.   + For documentation on journal entries, see:   + * <> - Developer guide * <> - API reference * <> - Webhook notifications. ==== Use the `/credit/accounts/{account_token}/ledgerentries` endpoint to retrieve ledger entries made on an <> on Marqeta's credit platform. A ledger entry is a record of an entry made on an account ledger, such as a purchase transaction, fee, adjustment, and more. For more on the different types of ledger entries, see <>. Ledger entries originate when a ledger entry event occurs, such as a cardholder making a purchase or an account holder making a payment. To receive webhook notifications when ledger entry events occur, see <> in Event Types. name: Ledger Entries - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] The Marqeta credit platform's policies feature enables you to customize the configurations of policies for documents (such as disclosures), credit products, fees, APRs, and rewards. You can choose the specific policies to add to a bundle that contain the exact configurations needed to launch a new credit program or help manage an existing one. The configurations of each policy in a bundle determine the characteristics and attributes of the bundle's associated credit accounts, reward programs, disclosures, and more. For more on how to create a bundle, see <>. [IMPORTANT] ==== To create and manage policies, you must use the link:https://app.marqeta.com/[Marqeta Dashboard, window="_blank"]. For more on policies in the dashboard, see <>.   + The following endpoints are displayed for reference purposes only. ==== name: Policies - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the payment schedule endpoints to create and retrieve payment schedules and payment schedule transitions on a <>. A payment schedule allows you to schedule a one-time or recurring payment on a credit account. For more on payments, see <>. To receive webhook notifications when ACH payment transition events occur, see <> in Event Types. Making a payment on a payment schedule triggers the creation of a <> belonging to the `PAYMENT` group. For more on payment journal entries, see <> in the About Credit Account Journal Entries guide. name: Payment Schedules - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the payment sources endpoint to link an external payment source to an <> on Marqeta's credit platform. This enables account holders to use the linked payment source to make payments toward their account balance. name: Payment Sources - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the payments endpoints to create and retrieve payments made on a <>, release payment holds, or transition payment statuses. A payment is an amount paid toward an account balance to reduce the total amount owed on the account. For more on payments, see <>. To receive webhook notifications when ACH payment transition events occur, see <> in Event Types. Creating a payment triggers the creation of a <> belonging to the `PAYMENT` group. For more on payment journal entries, see <> in the About Credit Account Journal Entries guide. name: Payments - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the Credit Program Gateways endpoints to create, retrieve, and update Program Gateways for your credit program. A Program Gateway allows you to exchange messages with Marqeta's credit platform regarding decisions on transaction authorizations. For more on Program Gateways, see <>. name: Program Gateways - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the statements endpoints to retrieve statement information or statement files for a <>. An account statement contains a summary of account activity that occurred during a billing cycle. For more on statements, see <>. To receive a webhook notification when a statement is created, see <> in Event Types. name: Statements - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] // This source file is used by InfoDev to generate API reference documentation. // File location in GitHub is: openapi/feecharges/openapi.yaml A fee charge moves funds from the general purpose account (GPA) of an account holder to your program's fee account. The charge amount is determined by the fee that is assessed. The request returns an error if the GPA has insufficient funds to cover the fee. This behavior contrasts with assessing a fee using the `/gpaorders` endpoint, in which case the amount of the fee is loaded into the GPA from the funding source before the GPA is debited. name: Fee Charges - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] // This source file is used by InfoDev to generate API reference documentation. File location in GitHub is: // File location in GitHub is: openapi/feerefunds/openapi.yaml Use the `/feerefunds` endpoint to refund fees to your account holder's general purpose account (GPA). name: Fee Refunds - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] // This source file is used by InfoDev to generate API reference documentation. File location in GitHub is: // File location in GitHub is: openapi/fees/openapi.yaml A `fees` resource represents a monetary assessment against an account holder's general purpose account (GPA). Assessing a fee transfers funds from the account holder's GPA account to your program's fee account. By default, every account has a GPA account used for the funding of transfers. You can assess fees either post-transaction or in real time. Real-time fee assessment ensures the account has sufficient funds available to cover both the transaction amount and the fee before authorization of the transaction. To assess fees in real time, you must create a real-time fee group using the `/realtimefeegroups` endpoint. When assessing a post-transaction fee, you can either debit existing GPA funds, or pull in new funds from a funding source. To use existing GPA funds, use the `/feetransfers` endpoint. To pull in new funds, use the fees array in `/gpaorders`. [NOTE] If your program uses Gateway JIT Funding, you cannot assess fees. name: Fees - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] The address resource is your billing address. An active address is required in order to use a payment card funding source. To associate an address with a funding source, use the same `user_token` or `business_token` for both resources. [NOTE] The `/users` and `/businesses` resources also have address fields. Those are used for other purposes, such as KYC identity verification or as shipping addresses for physical cards. name: Addresses - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the `/fundingsources/ach`, `/fundingsources/ach/partner`, and `/fundingsources/paymentcard` endpoints to create account holder funding sources. A funding source enables access to funds outside of the Marqeta platform. For more information on users and businesses, see <>. name: Account Holder Funding Sources - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the `/fundingsources/program` endpoint to create a program funding source. A program funding source represents a bank account from which funds are drawn for Managed Just-in-Time (JIT) Funding transactions. For more information about JIT Funding, see <>. In the sandbox environment, each program funding source you create simulates funds for use in test transactions. In production environments, program funding sources are created by Marqeta and draw funds from a bank account you set up in conjunction with Marqeta. [NOTE] Your program funding source must be approved by Marqeta and the issuing bank. If you are using a third-party service to collect user funds, Marqeta and the issuing bank require specific reporting to ensure compliance with applicable rules and regulations. Contact Marqeta for more information. name: Program Funding Sources - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the `/fundingsources/programgateway` endpoint to create a program gateway funding source. A program gateway funding source represents a bank account from which funds are drawn for Gateway Just-in-Time (JIT) Funding transactions. For more information about JIT Funding, see <>. In a sandbox environment, you can create a program gateway funding source that simulates funds for use in test transactions. In a production environment, you must work with a Marqeta representative to define the bank account from which the program gateway funding source draws funds. [NOTE] If you are using a third-party service to collect user funds, Marqeta and the issuing bank require specific reporting to ensure compliance with applicable rules and regulations. Contact Marqeta for more information. name: Program Gateway Funding Sources - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] The `/gpaorders` endpoint moves funds from a funding source into an account holder's general-purpose account (GPA). GPA orders can also be used to move funds from an account holder's funding source into your program's fee account. GPA orders can be funded by the account holder or your program. name: GPA Orders - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] // This source file is used by InfoDev to generate API reference documentation. // File location in GitHub is: // https://github.marqeta.com/openapi/coreapi/blob/main/openapi/kycjcard/openapi.yaml Use the `/kyc` endpoint to perform Know Your Customer (KYC) verification tasks for your account holders. This endpoint can only be used to perform KYC verification for individuals or businesses in the United States. For more information about KYC verification, see <>. For more information about account holders, see <>. name: KYC Verification - description: |- A merchant category code (MCC) is a four-digit number assigned by card networks to a business based on the goods or services offered by the business. On the Marqeta platform, an MCC group defines a set of MCCs. You can include an MCC group within a spend control to limit user spending at a set of merchants. An MCC group also allows you to automatically increase authorization amounts and to control the expiration of authorizations for the specified MCCs. By default, these controls apply to all cards in your program. An MCC group authorization control can have exceptions defined at the card product level. See <> for a tutorial that walks you through the creation of a spend control, as well as links to more information about merchant category codes. name: MCC Groups - description: |- Use the `/merchantgroups` endpoint to create, update, and retrieve groups of merchant identifiers (MIDs). You can use merchant groups for authorization controls and in card product configurations. For example, use a merchant group to create a <> for a group of merchants rather than an individual merchant. name: Merchant Groups - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the `/pins` endpoint to create, update, or reveal a personal identification number (PIN) for a card. name: PINs - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Use the Program Reserve API to retrieve program reserve account balances and transactions. name: Program Reserve - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] A program transfer moves funds from an account holder's general purpose account (GPA) to a program funding source. In contrast to a fee transfer, the program transfer amount is specified by the transfer itself and can therefore be set dynamically. An auto reload is triggered if the GPA has insufficient funds to cover the transfer amount and auto reload is enabled. [NOTE] The `/programtransfers` endpoint is only available for specific, pre-approved use cases. For more information about this endpoint, contact your Marqeta representative. name: Program Transfers - description: |- Marqeta enables you to assess fees in real time through the use of real-time fee groups. A real-time fee group is a collection of fees associated with an account holder group (and thereby associated with the users and businesses that are part of that account holder group). Real-time fee assessment ensures that associated accounts have sufficient funds available to cover both the transaction amount and the fee before authorization of a transaction. Before you create a real-time fee group, you must create the individual fees (using the `/fees` endpoint) and the account holder group with which you will associate the real-time fee group (using the `/accountholdergroups` endpoint). Each fee in the group must be applicable to a different transaction type. For example, one fee could assess $1 on authorization transactions while another assesses $2 on PIN-debit transactions. Use of real-time fee groups requires prior approval by Marqeta. If you are interested in using this feature for your card program, contact your Marqeta representative for more information. [NOTE] If your program uses Gateway JIT Funding, you cannot assess fees. name: Real-Time Fee Groups - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] The Marqeta platform facilitates the use of digital wallets for storing tokenized cards and making payments. The API provides endpoints that enable mobile applications to provision tokens into a digital wallet. It also provides endpoints for retrieving digital wallet tokens and for managing their lifecycle through state transitions. For an overview of digital wallet tokens, see <>. name: Digital Wallets Management - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] // This source file is used by InfoDev to generate API reference documentation. // File location in GitHub is: // https://github.marqeta.com/openapi/coreapi/blob/main/openapi/transactions/openapi.yaml The `/transactions` resource represents the electronic messages that carry information used for payment processing. A transaction usually originates when a cardholder attempts to make a payment, either online or at a physical point of sale. You can receive information about transactions as they occur by configuring webhooks. Learn about configuring webhooks in the <> guide. See the transaction events for which you can set up webhooks in the <> API reference page. You can also retrieve transactions associated with specific cards, merchants, and account holders using the endpoints described here. For an overview of transactions and the `transaction` object, including the complete list of <>, see <>. [TIP] Use the `/transactions` endpoint to retrieve smaller datasets (up to one page). For best performance when requesting larger datasets, use the <>. name: Transactions - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] // This source file is used by InfoDev to generate API reference documentation. // File location in GitHub is: // https://github.marqeta.com/openapi/coreapi/blob/main/openapi/users/openapi.yaml The `users` resource represents a person who accesses Marqeta-administered funds via a Marqeta card (whether physical or virtual). This endpoint enables you to create and manage users on the Marqeta platform. This resource stores user attributes such as name, address, and date of birth, as well as financial information such as balances. By default, every user automatically has a general purpose account (GPA) that is used for the funding of transfers and is therefore an `account holder`. Note that account balances reside at the account holder level — there are no separate `account` or `balance` objects. You can use the `/users` endpoint to create parent-child relationships between two users (where one user is the parent and the other is the child) or between a business and a user (where the business is the parent and the user is the child). This relationship provides reporting to the parent about how cards of children are used and enables the parent to monitor and even restrict card usage. [NOTE] A user can simultaneously be a child of a business and a parent of other users if the user is not configured to use a parent's account balances and the user's child is configured to use a parent's account balances. For more information on account holders, see <>. name: Users - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] // This source file is used by InfoDev to generate API reference documentation. // File location in GitHub is: // https://github.marqeta.com/openapi/coreapi/blob/main/openapi/usertransitions/openapi.yaml Use the `/usertransitions` endpoints to transition user resources between statuses, as well as to retrieve and list status changes for a user resource. name: User Transitions - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] A velocity control limits how much users can spend. You can configure velocity controls to limit how much users can spend and the number of transactions they can make in a given span of time. You can apply velocity controls to a single user, to all users associated with a particular card product, or to all users in your program. Only Program Managers can create or modify program-wide velocity controls. A `POST` or `PUT` call from a role that does not have Program Manager permissions will receive a 403 error if its `association` field is null, or if it includes all of the fields in the request body. Avoid this by passing a valid `user_token` or `card_product_token` in the velocity control's `association` object, indicating that the request is specific to a user or card product, and not program-wide. You should also only include the specific fields you want to update, because a `PUT` or `POST` with values for all fields is interpreted as a change that requires Program Manager permissions. See <> for a tutorial that walks you through the creation of a spend control. [NOTE] Each program supports a maximum of 90 spend controls (velocity controls and <> combined). The limit of 90 spend controls applies at the program level only; it does not affect the number of user-level spend controls you can use. name: Velocity Controls - description: |- // Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] Webhooks are notifications about API events, sent as they occur. The Marqeta platform sends these notifications to an endpoint that is hosted in your environment and configured to receive and process them. Create a webhook object to represent your webhook endpoint. Configure it with the URL of your webhook endpoint and a set of credentials for accessing that endpoint. You can configure it to send notifications for a single event, a group of events by type, or all event types. To set up multiple webhook endpoints and route different types of event notifications to each, create multiple webhook objects and configure each to send a specific type of event notification to a specific endpoint. See <> for information on notifications and a tutorial that walks you through the configuration of your webhook endpoint. See <> for reference documentation on the types of events that the Marqeta platform supports. [NOTE] Webhooks URLs are cached. Changes made on your webhook endpoint can take up to one hour to be applied. name: Webhooks paths: /acceptedcountries: get: operationId: getAcceptedcountries parameters: - description: Number of accepted countries to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Name explode: true in: query name: name required: false schema: type: string style: form - description: Whitelist explode: true in: query name: whitelist required: false schema: type: boolean style: form - description: Search type explode: true in: query name: search_type required: false schema: type: string style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/AcceptedCountriesListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server failure summary: Lists all accepted countries tags: - accepted countries /acceptedcountries/{token}: get: operationId: getAcceptedcountriesToken parameters: - description: Accepted country token explode: false in: path name: token required: true schema: type: string style: simple - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/accepted_countries_model' description: Success '400': content: { } description: Bad request '404': content: { } description: Accepted country not found '500': content: { } description: Server failure summary: Returns a specific accepted country tags: - accepted countries /accountholdergroups: get: operationId: getAccountholdergroups parameters: - description: Number of items to retrieve. Count can be between 1 - 10 items. explode: true in: query name: count required: false schema: default: 10 format: int32 type: integer style: form - description: Indicates from what row to start returning data. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Field by which to sort the returned items. Use any field in the model, or system fields lastModifiedTime or createdTime. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountHolderGroupListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists account holder groups tags: - account holder groups post: operationId: postAccountholdergroups requestBody: content: application/json: schema: $ref: '#/components/schemas/account_holder_group_request' description: Account holder group object required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/account_holder_group_response' description: Created '400': content: { } description: Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Creates an account holder group object tags: - account holder groups /accountholdergroups/{token}: get: operationId: getAccountholdergroupsToken parameters: - description: Account holder group token explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/account_holder_group_response' description: Success '400': content: { } description: Bad request '404': content: { } description: Auto reload not found '500': content: { } description: Server error summary: Returns a specific account holder group object tags: - account holder groups put: operationId: putAccountholdergroupsToken parameters: - explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/account_holder_group_update_request' description: Account holder group update object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/account_holder_group_response' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Updates an account holder group object tags: - account holder groups /accounts: get: description: |- Retrieve an array of credit accounts. This endpoint supports <>. operationId: listAccounts parameters: - description: Unique identifier of the credit card associated with the account. explode: true in: query name: card_token required: false schema: type: string x-allowableValues: Existing card token style: form - description: Number of credit account resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form - description: If `true`, returns a lightweight response without any balances and usages. explode: true in: query name: light_response required: false schema: default: false type: boolean x-allowableValues: '`true`, `false`' style: form - description: |- Unique identifier of an existing secured account. This field is required when policy product subtype is `SECURED`. explode: true in: query name: secured_account_token required: false schema: type: string x-allowableValues: Existing secured account token style: form - description: Unique identifier of the user by which to filter accounts. explode: true in: query name: user_token required: false schema: type: string x-allowableValues: Existing user token style: form responses: '200': content: application/json: example: count: 1 data: - activation_time: 2025-08-26T22:55:52.302Z available_credit: 3232 business_token: business_token123 config: billing_cycle_day: 1 card_level: TRADITIONAL e_disclosure_active: true fees: - active: true created_date: 2025-08-26T22:55:52.124Z schedule: - effective_date: 2025-08-26T22:55:52.124Z method: FLAT value: 25 type: LATE_PAYMENT_FEE updated_date: 2025-08-26T22:55:52.124Z - active: true created_date: 2025-09-03T19:06:27.946Z schedule: - effective_date: 2025-09-03T19:06:27.946Z method: FLAT value: 10 type: RETURNED_PAYMENT_FEE updated_date: 2025-09-03T19:06:27.946Z - active: true created_date: 2025-09-03T19:06:27.946Z schedule: - method: PERCENTAGE value: 12.5 type: FOREIGN_TRANSACTION_FEE updated_date: 2025-09-03T19:06:27.946Z payment_due_day: 31 payment_holds: ach_hold_days: 0 check_hold_days: 0 rewards: [ ] created_time: 2025-08-26T22:55:52.100Z credit_limit: 6000 credit_product_token: credit_product_token1234 currency_code: USD current_balance: 0 description: Consumer credit account for John Jacob external_offer_id: external-offer-11 latest_statement_cycle_type: TRANSACTING max_apr_schedules: [ ] name: John Jacob remaining_min_payment_due: 25 remaining_statement_balance: 2768 status: ACTIVE substatuses: [ ] token: credit_account_token1234 type: CONSUMER updated_time: 2025-08-26T22:55:52.304Z usages: - aprs: - active: true created_date: 2025-08-26T22:55:52.106Z schedule: - effective_date: 2025-08-26T22:55:52.106Z value: 14.99 type: GO_TO updated_date: 2025-08-26T22:55:52.106Z fees: [ ] type: PURCHASE user_substatuses: [ ] user_token: user_token1234 end_index: 4 is_more: true start_index: 0 schema: $ref: '#/components/schemas/AccountsPage' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List accounts tags: - Credit Accounts /accounts/{account_token}: get: description: Retrieve a credit account. operationId: retrieveAccount parameters: - description: Display the effective fee schedule only. explode: true in: query name: effective_fee_schedule_only required: false schema: default: false type: boolean x-allowableValues: '`true`, `false`' style: form - description: |- Unique identifier of the credit account to retrieve. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: If true, returns a lightweight response without any balances and usages. explode: true in: query name: light_response required: false schema: default: false type: boolean x-allowableValues: '`true`, `false`' style: form responses: '200': content: application/json: example: activation_time: 2021-08-26T22:55:52.302Z available_credit: 3232 config: billing_cycle_day: 1 card_level: TRADITIONAL e_disclosure_active: true fees: - active: true created_date: 2021-08-26T22:55:52.124Z schedule: - effective_date: 2021-08-26T22:55:52.124Z method: FLAT value: 25 type: LATE_PAYMENT_FEE updated_date: 2021-08-26T22:55:52.124Z - active: true created_date: 2021-09-03T19:06:27.946Z schedule: - effective_date: 2021-09-03T19:06:27.946Z method: FLAT value: 10 type: RETURNED_PAYMENT_FEE updated_date: 2021-09-03T19:06:27.946Z - active: true created_date: 2021-09-03T19:06:27.946Z schedule: - method: PERCENTAGE value: 12.5 type: FOREIGN_TRANSACTION_FEE updated_date: 2021-09-03T19:06:27.946Z payment_due_day: 31 payment_holds: ach_hold_days: 0 check_hold_days: 0 rewards: [ ] created_time: 2021-08-26T22:55:52.100Z credit_limit: 6000 credit_product_token: credit_product_token1234 currency_code: USD current_balance: 0 description: Consumer credit account for John Jacob external_offer_id: external-offer-11 latest_statement_cycle_type: TRANSACTING name: John Jacob remaining_min_payment_due: 25 remaining_statement_balance: 2768 status: ACTIVE token: credit_account_token1234 type: CONSUMER updated_time: 2021-08-26T22:55:52.304Z usages: - aprs: - active: true created_date: 2021-08-26T22:55:52.106Z schedule: - effective_date: 2021-08-26T22:55:52.106Z value: 14.99 type: GO_TO updated_date: 2021-08-26T22:55:52.106Z fees: [ ] type: PURCHASE user_token: user_token1234 schema: $ref: '#/components/schemas/AccountResponse' description: A JSON object containing account information default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve account tags: - Credit Accounts put: description: Update a credit account. operationId: updateAccount parameters: - description: |- Unique identifier of the credit account to update. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple requestBody: content: application/json: example: config: payment_holds: ach_hold_days: 3 check_hold_days: 5 credit_limit: value: 6000 latest_statement_cycle_type: TRANSACTING schema: $ref: '#/components/schemas/AccountUpdateReq' required: true responses: '200': content: application/json: example: activation_time: 2021-08-26T22:55:52.302Z available_credit: 3232 config: billing_cycle_day: 1 card_level: TRADITIONAL e_disclosure_active: true fees: - active: true created_date: 2021-08-26T22:55:52.124Z schedule: - method: FLAT value: 25 type: LATE_PAYMENT_FEE updated_date: 2021-08-26T22:55:52.124Z - active: true created_date: 2021-09-03T19:06:27.946Z schedule: - effective_date: 2021-09-03T19:06:27.946Z method: FLAT value: 10 type: RETURNED_PAYMENT_FEE updated_date: 2021-09-03T19:06:27.946Z - active: true created_date: 2021-09-03T19:06:27.946Z schedule: - method: PERCENTAGE value: 12.5 type: FOREIGN_TRANSACTION_FEE updated_date: 2021-09-03T19:06:27.946Z payment_due_day: 31 payment_holds: ach_hold_days: 3 check_hold_days: 5 rewards: [ ] created_time: 2021-08-26T22:55:52.100Z credit_limit: 6000 credit_product_token: credit_product_token1234 currency_code: USD current_balance: 0 description: Consumer credit account for John Jacob external_offer_id: external-offer-11 latest_statement_cycle_type: TRANSACTING max_apr_schedules: [ ] name: John Jacob remaining_min_payment_due: 25 remaining_statement_balance: 2768 status: ACTIVE substatuses: [ ] token: credit_account_token1234 type: CONSUMER updated_time: 2021-08-26T22:55:52.304Z usages: - aprs: - active: true created_date: 2021-08-26T22:55:52.106Z schedule: - effective_date: 2021-08-26T22:55:52.106Z value: 14.99 type: GO_TO updated_date: 2021-08-26T22:55:52.106Z fees: [ ] type: PURCHASE user_substatuses: [ ] user_token: user_token1234 schema: $ref: '#/components/schemas/AccountResponse' description: A JSON object containing account information. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Update account tags: - Credit Accounts /accounts/{account_token}/accounttransitions: get: description: |- Retrieve an array of transitions on a credit account. This endpoint supports <>. operationId: listAccountTransitions parameters: - description: |- Unique identifier of the credit account for which you want to retrieve transitions. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: Number of account transition resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `createdTime`, and not by the field names appearing in response bodies such as `created_time`. explode: true in: query name: sort_by required: false schema: default: -createdTime enum: - createdTime - -createdTime type: string style: form responses: '200': content: application/json: example: count: 1 data: - account_token: my_account_token_12 created_time: 2023-09-03T19:22:45.290Z original_status: UNACTIVATED status: ACTIVE token: my_account_transition_token1234 end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/AccountTransitionsPage' description: A list of JSON objects containing paginated account transitions information. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List account transitions tags: - Account Transitions post: description: Transition a credit account to a new status. operationId: transitionAccount parameters: - description: |- Unique identifier of the credit account for which to transition a status. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple requestBody: content: application/json: example: status: ACTIVE schema: $ref: '#/components/schemas/AccountTransitionReq' required: true responses: '201': content: application/json: example: account_token: my_account_token_12 created_time: 2021-09-03T19:22:45.290Z original_status: UNACTIVATED status: ACTIVE token: my_account_transition_token1234 schema: $ref: '#/components/schemas/AccountTransitionResponse' description: A JSON object containing transition information. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Transition account status tags: - Account Transitions /accounts/{account_token}/accounttransitions/{token}: get: description: Retrieve a transition for a credit account. operationId: getAccountTransition parameters: - description: |- Unique identifier of the credit account for which you want to retrieve a transition. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the account transition you want to retrieve. Send a `GET` request to `/credit/accounts/{account_token}/accounttransitions` to retrieve existing account transition tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing account transition token style: simple responses: '200': content: application/json: example: account_token: my_account_token_12 created_time: 2021-09-03T19:22:45.290Z original_status: UNACTIVATED status: ACTIVE token: my_account_transition_token1234 schema: $ref: '#/components/schemas/AccountTransitionResponse' description: A JSON object containing account transition record. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve account transition tags: - Account Transitions /accounts/{account_token}/adjustments: get: description: |- Retrieve an array of adjustments for a credit account. This endpoint supports <>. operationId: getAdjustmentsByAccount parameters: - description: |- Unique identifier of the credit account for which you want to retrieve adjustments. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: Number of account adjustment resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form responses: '200': content: application/json: example: count: 2 data: - account_token: my_account_token_12 adjustment_detail_object: null amount: -25 currency_code: USD description: Waived late payment fee detail_token: null external_adjustment_id: null note: null original_ledger_entry_token: a0216141-13d6-e2e2-7227-abcd12345678 reason: OTHER related_detail_object: null related_detail_token: null source_account_type: PROGRAM_FUNDING token: my_account_adjustment_token1234 type: FEE - account_token: my_account_token_12 adjustment_detail_object: account_token: my_account_token_12 average_daily_balance: 181.67 created_date: 2024-08-01T07:00:19.755Z currency_code: USD daily_periodic_rate: 4.1068E-4 days_in_billing_cycle: 31 goto_apr: 14.99 interest_amount: 2.31 statement_balance: 208.93 statement_closing_date: 2024-08-01T03:59:59.999Z statement_opening_date: 2024-07-01T04:00:00 statement_token: statement_token_75b token: interest_detail_token1234 updated_date: 2024-08-01T07:00:19.755Z amount: -100 currency_code: USD description: interest adjustment detail_token: interest_detail_token1234 external_adjustment_id: e37e27a1-ad70-382e-846d-a31ab59d00f9 note: interest adjustment for dispute original_ledger_entry_token: a0216141-13d6-e2e2-7227-abcd12345678 reason: OTHER related_detail_object: account_token: account_token_12 amount: 500 category: FRAUD created_time: 2025-07-01T00:27:09Z ledger_entry_token: journal_entry_token1222 notes: string resolved_at: 2025-07-01T00:27:09Z status: ACTIVE token: dispute_token_1234 updated_time: 2025-07-01T00:27:09Z related_detail_token: dispute_token1234 source_account_type: PROGRAM_FUNDING token: my_account_adjustment_token1234 type: INTEREST end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/AccountAdjustmentPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List account adjustments tags: - Adjustments post: description: Create an adjustment for an existing credit account. operationId: createAdjustmentForAccount parameters: - description: |- Unique identifier of the credit account for which you want to create an adjustment. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple requestBody: content: application/json: example: amount: -25 currency_code: USD description: Waived late payment fee original_ledger_entry_token: 2384f927-e4fe-47af-8ff6-0712ee41a2eb source_account_type: SPONSOR_BANK schema: $ref: '#/components/schemas/AccountAdjustmentReq' required: true responses: '201': content: application/json: example: account_token: my_account_token_12 adjustment_detail_object: null amount: -25 created_time: 2025-04-01T23:41:58.802Z currency_code: USD description: Waived late payment fee detail_token: null external_adjustment_id: null note: null original_ledger_entry_token: a0216141-13d6-e2e2-7227-abcd12345678 reason: OTHER related_detail_object: null related_detail_token: null source_account_type: SPONSOR_BANK token: my_account_adjustment_token1234 type: FEE schema: $ref: '#/components/schemas/AccountAdjustmentResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Create account adjustment tags: - Adjustments /accounts/{account_token}/adjustments/{adjustment_token}: get: description: Retrieve an adjustment for a credit account. operationId: retrieveAdjustment parameters: - description: |- Unique identifier of the credit account for which you want to retrieve an adjustment. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the adjustment to retrieve. Send a `GET` request to `/credit/accounts/{account_token}/adjustments` to retrieve existing account adjustment tokens. explode: false in: path name: adjustment_token required: true schema: type: string x-allowableValues: Existing adjustment token style: simple responses: '200': content: application/json: example: account_token: my_account_token_12 adjustment_detail_object: null amount: -25 currency_code: USD description: Waived late payment fee detail_token: null external_adjustment_id: null note: null original_ledger_entry_token: a0216141-13d6-e2e2-7227-abcd12345678 reason: OTHER related_detail_object: null related_detail_token: null source_account_type: SPONSOR_BANK token: my_account_adjustment_token1234 type: FEE schema: $ref: '#/components/schemas/AccountAdjustmentResponse' description: A JSON object containing account_adjustment information default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Retrieve account adjustment tags: - Adjustments /accounts/{account_token}/billingcycle: get: description: Retrieves the billing cycle details for a specific account token. operationId: retrieveBillingCycleForAccount parameters: - description: |- Unique identifier of the credit account for which you want to retrieve delinquency state details. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountBillingCycleResponse' description: Successful response '404': description: Billing cycle not found default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Get billing cycle by account token tags: - Account /accounts/{account_token}/cards: get: description: |- Retrieve an array of cards for a credit account. This endpoint supports <>. operationId: getCardsByAccount parameters: - description: |- Unique identifier of the credit account for which to retrieve credit cards. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: Status of the credit cards to retrieve. explode: true in: query name: status required: false schema: type: string x-allowableValues: Valid credit card status style: form - description: Number of credit card resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 2 data: - account_token: my_account_token_12 created_time: 2024-09-03T19:39:53.719Z token: credit_card_token1234 updated_time: 2024-09-03T19:39:53.719Z user_token: user1234 - account_token: my_account_token_13 created_time: 2024-09-13T19:19:51.412Z token: credit_card_token5678 updated_time: 2024-09-13T19:19:51.421Z user_token: user5678 end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/AccountCardsPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error. security: - zionToken: [ ] summary: List account cards tags: - Account Cards post: description: |- Create a credit card for an existing credit account. [NOTE] You can ship cards to an address different from the <> address. After creating a card, send a `PUT` request to the `/cards` endpoint with the new address in the `fulfillment.shipping` object. For more, see <>. operationId: createCardForAccount parameters: - description: |- Unique identifier of the credit account for which to create a credit card. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple requestBody: content: application/json: example: card_product_token: my-card-product1234 user_token: user1234 schema: type: object description: |- Expected request body to create a credit card for an existing credit account. Refer to <> for the complete list of fields. required: true responses: '201': content: application/json: example: account_token: my_account_token_12 created_time: 2024-09-03T19:39:53.719Z token: my_credit_card_token1234 updated_time: 2024-09-03T19:39:53.719Z user_token: user1234 schema: $ref: '#/components/schemas/CardResponse' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create account card tags: - Account Cards /accounts/{account_token}/cards/{card_token}: get: description: Retrieve a credit card for a credit account. operationId: getCardByAccount parameters: - description: |- Unique identifier of the credit account for which to retrieve a credit card. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the credit card to retrieve. Send a `GET` request to `/credit/accounts/{account_token}/cards` to retrieve existing credit card tokens. explode: false in: path name: card_token required: true schema: type: string x-allowableValues: Existing card token style: simple responses: '200': content: application/json: example: account_token: my_account_token_12 created_time: 2024-09-03T19:39:53.719Z token: my_credit_card_token1234 updated_time: 2024-09-03T19:39:53.719Z user_token: user1234 schema: $ref: '#/components/schemas/CardResponse' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve account card tags: - Account Cards /accounts/{account_token}/creditbalancerefunds: post: description: Create a new balance refund, which can be issued to the account holder if their credit account balance is negative. operationId: createBalanceRefund parameters: - description: |- Unique identifier of the credit account for which you want to create a balance refund. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple requestBody: content: application/json: example: amount: 500 currency_code: USD description: credit balance refund method: CHECK schema: $ref: '#/components/schemas/AccountCreditBalanceRefundReq' required: true responses: '201': content: application/json: example: account_token: my_account_token_12 amount: 0 created_time: 2025-07-14T20:17:28Z description: credit balance refund method: CHECK status: COMPLETED token: credit_balance_refund_token1234 updated_time: 2025-07-14T20:17:28Z schema: $ref: '#/components/schemas/AccountCreditBalanceRefundResponse' description: Expected response. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create balance refund tags: - Balance Refunds /accounts/{account_token}/delinquencystate: get: description: |- Retrieve details of the current delinquency state of a credit account. An account is delinquent when it is past due on payments and current when it is up to date on payments. operationId: retrieveDelinquencyState parameters: - description: |- Unique identifier of the credit account for which you want to retrieve delinquency state details. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple responses: '200': content: application/json: examples: current_example: summary: The following code block shows details of a current account. value: account_token: account_token_111 buckets: [ ] current_due: 100 date_account_current: 2024-01-01T04:59:59.999Z date_account_delinquent: null is_delinquent: false total_days_past_due: 0 total_due: 100 total_past_due: 0 delinquent_example: summary: The following code block shows details of a delinquent account. value: account_token: account_token_123 buckets: - bucket_number: 1 current_due: 40 days_past_due: 30 past_due_carried_forward: 60 payment_due_date: 2023-05-01T03:59:59.999Z total_due: 100 - bucket_number: 2 current_due: 40 days_past_due: 60 past_due_carried_forward: 20 payment_due_date: 2024-04-01T03:59:59.999Z total_due: 60 - bucket_number: 3 current_due: 20 days_past_due: 91 past_due_carried_forward: 0 payment_due_date: 2024-03-01T04:59:59.999Z total_due: 20 current_due: 40 date_account_current: null date_account_delinquent: 2024-03-01T04:59:59.999Z is_delinquent: true total_days_past_due: 91 total_due: 140 total_past_due: 100 schema: $ref: '#/components/schemas/DelinquencyStateResponse' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve delinquency state tags: - Delinquency /accounts/{account_token}/delinquencystate/transitions: get: description: |- Retrieve an array of delinquency state transitions for a credit account. A delinquency state transition occurs when an account's delinquency state transitions between delinquent and current. An account becomes delinquent when it falls behind on payments and becomes current when payments are made up to date. operationId: retrieveDelinquencyTransitions parameters: - description: |- Unique identifier of the credit account whose delinquency state transitions you want to retrieve. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: Number of resources to retrieve. explode: true in: query name: count required: false schema: default: 5 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `impactTime`, and not by the field names appearing in response bodies such as `impact_time`. explode: true in: query name: sort_by required: false schema: default: -impactTime enum: - impactTime - -impactTime type: string style: form responses: '200': content: application/json: example: count: 2 data: - account_token: account_token_1 bucket_count: 0 created_time: 2023-03-28T00:52:17.566Z current_due: 221.53 impact_time: 2023-12-02T23:13:48.281Z is_rolled_back: false oldest_payment_due_date: 2024-01-01T04:59:59.999Z original_status: DELINQUENT status: CURRENT token: delinquency_transition_token_2 total_due: 221.53 total_past_due: 0 transition_trigger_reason: PAYMENT transition_trigger_time: 2023-12-02T23:13:48.284Z updated_time: 2023-03-28T00:52:17.566Z - account_token: account_token_1 bucket_count: 1 created_time: 2024-03-28T00:52:17.398Z current_due: 231.35 impact_time: 2023-12-01T04:59:59.999Z is_rolled_back: false oldest_payment_due_date: 2023-12-01T04:59:59.999Z original_status: CURRENT status: DELINQUENT token: delinquency_transition_token_1 total_due: 271.53 total_past_due: 40.18 transition_trigger_reason: STATEMENT_GENERATION transition_trigger_time: 2022-12-01T08:01:29.201Z updated_time: 2024-03-28T00:52:17.398Z end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/DelinquencyTransitionsResponsePage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List delinquency state transitions tags: - Delinquency /accounts/{account_token}/delinquencystate/transitions/{delinquency_transition_token}: get: description: |- Retrieve a specific delinquency state transition on a credit account. A delinquency state transition occurs when an account's delinquency state transitions between delinquent and current. An account becomes delinquent when it falls behind on payments and becomes current when payments are made up to date. operationId: retrieveDelinquencyTransition parameters: - description: |- Unique identifier of the credit account whose delinquency state transition you want to retrieve. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: Unique identifier of the delinquency state transition. explode: false in: path name: delinquency_transition_token required: true schema: type: string x-allowableValues: Existing delinquency transition token style: simple responses: '200': content: application/json: example: account_token: account_token_1 bucket_count: 4 created_time: 2023-05-01T09:23:36.910Z current_due: 41.58 impact_time: 2023-05-01T03:59:59.999Z is_rolled_back: false oldest_payment_due_date: 2023-02-01T04:59:59.999Z original_status: DELINQUENT status: DELINQUENT token: delinquency_transition_token_1 total_due: 201.58 total_past_due: 160 transition_trigger_reason: STATEMENT_GENERATION transition_trigger_time: 2023-05-01T09:23:36.046Z updated_time: 2023-05-01T09:23:36.910Z schema: $ref: '#/components/schemas/DelinquencyTransitionResponse' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve delinquency state transition tags: - Delinquency /accounts/{account_token}/disputes: get: description: |- Retrieve an array of disputes on a credit account. This endpoint supports <>. operationId: getDisputesByAccount parameters: - description: |- Unique identifier of the credit account for which to retrieve the disputes. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: Number of disputes resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form - description: |- Unique identifier of the journal entry in dispute. This type of identifier can only be used for `authorization.clearing`-type journal entries. explode: true in: query name: ledger_entry_tokens required: false schema: items: type: string type: array x-allowableValues: Existing `authorization.clearing`-type journal entry token style: form - description: Status of the dispute. explode: true in: query name: statuses required: false schema: items: $ref: '#/components/schemas/DisputeStatus' type: array x-allowableValues: Valid dispute status style: form responses: '200': content: application/json: example: count: 1 data: - account_token: account_token_12 amount: 500 category: FRAUD created_time: 2021-07-01T00:27:09Z ledger_entry_token: journal_entry_token1222 notes: fraudulent purchase resolved_at: 2021-07-01T00:27:09Z status: ACTIVE token: dispute_token_1234 updated_time: 2021-07-01T00:27:09Z end_index: 0 is_more: true start_index: 0 schema: $ref: '#/components/schemas/DisputeResponsePage' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List account disputes tags: - Credit Account Disputes post: description: Create a dispute of a journal entry on a credit account. operationId: createDisputeForAccount parameters: - description: |- Unique identifier of the credit account for which to create a dispute. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple requestBody: content: application/json: example: amount: 500 category: FRAUD ledger_entry_token: journal_entry_token1222 token: dispute_token_1234 schema: $ref: '#/components/schemas/DisputeCreateReq' required: true responses: '201': content: application/json: example: account_token: account_token_12 amount: 500 category: FRAUD created_time: 2023-07-01T00:27:09Z ledger_entry_token: journal_entry_token1222 notes: fraudulent purchase resolved_at: 2023-07-01T00:27:09Z status: ACTIVE token: dispute_token_1234 updated_time: 2023-07-01T00:27:09Z schema: $ref: '#/components/schemas/DisputeResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Create account dispute tags: - Credit Account Disputes /accounts/{account_token}/disputes/{dispute_token}: get: description: Retrieve a dispute from a credit account. operationId: retrieveDispute parameters: - description: |- Unique identifier of the credit account from which to retrieve a dispute. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the dispute to retrieve. Send a `GET` request to `/credit/accounts/{account_token}/disputes` to retrieve existing dispute tokens. explode: false in: path name: dispute_token required: true schema: type: string x-allowableValues: Existing dispute token style: simple responses: '200': content: application/json: example: account_token: account_token_12 amount: 500 category: FRAUD created_time: 2023-07-01T00:27:09Z ledger_entry_token: journal_entry_token1222 notes: string resolved_at: 2023-07-01T00:27:09Z status: ACTIVE token: dispute_token_1234 updated_time: 2023-07-01T00:27:09Z schema: $ref: '#/components/schemas/DisputeResponse' description: Transaction Dispute object default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve account dispute tags: - Credit Account Disputes /accounts/{account_token}/disputes/{dispute_token}/transitions: post: description: Update the amount or status of a dispute on a credit account. operationId: transitionDispute parameters: - description: |- Unique identifier of the credit account from which to update a dispute. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the dispute to update. Send a `GET` request to `/credit/accounts/{account_token}/disputes` to retrieve existing credit account tokens. explode: false in: path name: dispute_token required: true schema: type: string x-allowableValues: Existing dispute token style: simple requestBody: content: application/json: example: amount: 500 status: AH_WON schema: $ref: '#/components/schemas/DisputeTransitionReq' required: true responses: '201': content: application/json: example: account_token: my_account_token_12 amount: 500 created_time: 2023-07-01T00:27:09Z notes: account holder evidence accepted status: AH_WON token: dispute_update_token1234 schema: $ref: '#/components/schemas/DisputeTransitionResponse' description: Transitioned transaction dispute object. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Update account dispute tags: - Credit Account Disputes /accounts/{account_token}/documents: get: description: Retrieve an array of documents on a credit account. operationId: getAccountDocuments parameters: - description: |- Unique identifier of the credit account for which you want to get documents. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountDocumentsResponse' description: Account documents default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List documents tags: - Account Documents /accounts/{account_token}/documents/{document_type}: get: description: Retrieve a specific type of document on a credit account. operationId: getDocumentByAccountAndType parameters: - description: |- Unique identifier of the credit account for which to retrieve a specific type of document. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string style: simple - explode: false in: path name: document_type required: true schema: $ref: '#/components/schemas/AccountAndDocumentAssetType' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountDocumentResponse' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve document tags: - Account Documents /accounts/{account_token}/documents/{document_type}/history: get: description: Retrieve the history of a specific type of document on a credit account. operationId: getDocumentHistoryByAccountAndType parameters: - description: |- Unique identifier of the credit account for which to get document history. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string style: simple - explode: false in: path name: document_type required: true schema: $ref: '#/components/schemas/AccountAndDocumentAssetType' style: simple - description: Number of account document resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `effectiveDate`, and not by the field names appearing in response bodies such as `effective_date`. explode: true in: query name: sort_by required: false schema: default: -effectiveDate enum: - effectiveDate - -effectiveDate type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountDocumentsPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve document history tags: - Account Documents /accounts/{account_token}/fees: get: description: |- Retrieve an array of fees for a credit account. This endpoint supports <>. operationId: getFeesByAccount parameters: - description: |- Unique identifier of the credit account for which you want to retrieve fees. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: Number of account fee resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form responses: '200': content: application/json: example: count: 2 data: - account_token: my_account_token_12 amount: 10 applied_to_amount: null channel: API created_time: 2025-04-01T23:41:58.802Z currency_code: USD description: Account was opened journal_tokens: - journal_token1 method: FLAT status: POSTED subtype: ACCOUNT_OPENING_FEE token: my_account_fee_token1234 type: ACCOUNT_FEE value: 10 - account_token: my_account_token_12 amount: 19 applied_to_amount: null channel: API created_time: 2022-04-05T18:25:47.751Z currency_code: USD description: Metal card requested journal_tokens: - journal_token2 method: FLAT status: POSTED subtype: UPGRADE_FEE token: my_account_fee_token456 type: ACCOUNT_FEE value: 19 end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/AccountFeePage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List account fees tags: - Fees post: description: Create a fee for an existing credit account. operationId: createFee parameters: - description: |- Unique identifier of the credit account for which you want to create a fee. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple requestBody: content: application/json: example: amount: 10 currency_code: USD description: Account was opened subtype: ACCOUNT_OPENING_FEE type: ACCOUNT_FEE schema: $ref: '#/components/schemas/AccountFeeReq' required: true responses: '201': content: application/json: example: account_token: my_account_token_12 amount: 10 applied_to_amount: null channel: API created_time: 2025-04-01T23:41:58.802Z currency_code: USD description: Account was opened journal_tokens: - journal_token123 method: FLAT status: POSTED subtype: ACCOUNT_OPENING_FEE token: my_account_fee_token1234 type: ACCOUNT_FEE value: 10 schema: $ref: '#/components/schemas/AccountFeeResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Create fee for an account tags: - Fees /accounts/{account_token}/fees/{fee_token}: get: description: Retrieve a fee for a credit account. operationId: retrieveFee parameters: - description: |- Unique identifier of the credit account for which you want to retrieve the fee. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the fee to retrieve. Send a `GET` request to `/credit/accounts/{account_token}/fees` to retrieve existing account fee tokens. explode: false in: path name: fee_token required: true schema: type: string x-allowableValues: Existing fee token style: simple responses: '200': content: application/json: example: account_token: my_account_token_12 amount: 10 applied_to_amount: null channel: API created_time: 2025-04-01T23:41:58.802Z currency_code: USD description: Account was opened journal_tokens: - journal_token123 method: FLAT status: POSTED subtype: ACCOUNT_OPENING_FEE token: my_account_fee_token1234 type: ACCOUNT_FEE value: 10 schema: $ref: '#/components/schemas/AccountFeeResponse' description: A JSON object containing account_fee information default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Retrieve account fee tags: - fees /accounts/{account_token}/journalentries: get: description: |- Retrieve an array of journal entries on a credit account. This endpoint supports <> and <>. operationId: ListAccountJournalEntries parameters: - description: |- Unique identifier of the credit account for which you want to retrieve journal entries. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: Number of journal entry resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: Starting date of the date range from which to return journal entries. explode: true in: query name: start_date required: false schema: type: string x-allowableValues: 'Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ' style: form - description: Ending date of the date range from which to return journal entries. explode: true in: query name: end_date required: false schema: type: string x-allowableValues: 'Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ' style: form - description: Starting `impact_time` of the date range from which to return journal entries. explode: true in: query name: start_impact_time required: false schema: type: string x-allowableValues: 'Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ' style: form - description: Ending `impact_time` of the date range from which to return journal entries. explode: true in: query name: end_impact_time required: false schema: type: string x-allowableValues: 'Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ' style: form - description: Starting `created_date` of the date range from which to return journal entries. explode: true in: query name: start_created_time required: false schema: type: string x-allowableValues: 'Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ' style: form - description: Ending `created_date` of the date range from which to return journal entries. explode: true in: query name: end_created_time required: false schema: type: string x-allowableValues: 'Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ' style: form - description: Array of statuses by which to filter journal entries. explode: true in: query name: statuses required: false schema: items: enum: - POSTED - PENDING type: string type: array style: form - description: Detail token of the journal entries to return. explode: true in: query name: detail_token required: false schema: type: string x-allowableValues: 36 char max style: form - description: |- Array of groups by which to filter journal entries. To return all journal entry groups, do not include this query parameter. explode: true in: query name: groups required: false schema: items: enum: - PURCHASE - ORIGINAL_CREDIT - FEE - BALANCE_REFUND - PAYMENT - INTEREST - DISPUTE - REFUND - ADJUSTMENT - REWARD type: string type: array style: form - description: Embeds the specified object into the response. explode: true in: query name: expand required: false schema: items: enum: - detailObject - originalCurrency type: string type: array style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `createdTime`, and not by the field names appearing in response bodies such as `created_time`. explode: true in: query name: sort_by required: false schema: default: -createdTime enum: - createdTime - -createdTime - impactTime - -impactTime type: string style: form - description: |- Array of card tokens by which to filter journal entries. Returns journal entries associated with the specified card tokens. Send a `GET` request to `/credit/accounts/{account_token}/cards/` to retrieve existing card tokens. explode: true in: query name: card_tokens required: false schema: items: type: string type: array x-allowableValues: Existing card token style: form - description: |- Array of user tokens by which to filter journal entries. Returns journal entries associated with the specified user tokens. Send a `GET` request to `/users` to retrieve existing user tokens. explode: true in: query name: user_tokens required: false schema: items: type: string type: array x-allowableValues: Existing user token style: form - description: |- Array of <> by which to filter journal entries. To return all event types, do not include this query parameter. explode: true in: query name: types required: false schema: items: enum: - authorization - authorization.advice - authorization.incremental - authorization.reversal - authorization.reversal.issuerexpiration - authorization.clearing - refund - refund.authorization - refund.authorization.advice - refund.authorization.reversal - refund.authorization.clearing - refund.authorization.reversal.issuerexpiration - originalcredit.authorization - originalcredit.authorization.clearing - originalcredit.authorization.reversal - originalcredit.authpluscapture - originalcredit.authpluscapture.reversal - originalcredit.authorization.reversal.issuerexpiration - account.balancerefund - account.reward.cashback - account.reward.auto.cashback - account.reward.auto.cashback.reversal - account.payment - account.payment.completed - account.payment.returned - account.payment.canceled - account.payment.refunded - account.payment.completed.hold.released - account.payment.completed.hold - account.interest - account.fee.payment.late - account.fee.payment.returned - account.fee.interest.minimum - account.dispute - account.dispute.reversal - account.dispute.won - account.dispute.lost - account.dispute.lost.graceperiod - account.adjustment - account.adjustment.purchase - account.adjustment.fee - account.adjustment.interest - account.adjustment.reward - pindebit - pindebit.authorization.clearing - pindebit.refund type: string type: array style: form responses: '200': content: application/json: example: count: 2 data: - account_token: my_account_token_12 amount: 2.31 card_token: my_credit_card_token7794 created_time: 2023-08-01T07:00:19.756Z currency_code: USD detail_object: account_token: my_account_token_12 average_daily_balance: 181.67 created_date: 2023-08-01T07:00:19.755Z currency_code: USD daily_periodic_rate: 4.1068E-4 days_in_billing_cycle: 31 goto_apr: 14.99 interest_amount: 2.31 statement_balance: 208.93 statement_closing_date: 2023-08-01T03:59:59.999Z statement_opening_date: 2023-07-01T04:00:00 statement_token: statement_token_75b token: detail_token_96749 updated_date: 2023-08-01T07:00:19.755Z detail_token: detail_token_96749 group: INTEREST id: '11112222' impact_time: 2023-08-01T03:59:59.999Z memo: Interest charge on purchases request_time: 2023-08-01T03:59:59.999Z status: POSTED token: interest_journal_entry_token1111 type: account.interest user_token: user_token4632 - account_token: my_account_token_12 amount: 15 card_token: my_credit_card_token7794 created_time: 2023-07-01T07:00:24.240Z currency_code: USD detail_object: account_token: my_account_token_12 amount: 15 created: 2023-07-01T07:00:24.239Z currency_code: USD description: Late Payment Fee method: FLAT token: detail_token_11221 type: LATE_PAYMENT_FEE value: 25 detail_token: detail_token_11221 group: FEE id: '44445678' impact_time: 2023-07-01T03:59:59.999Z memo: Late payment fee request_time: 2023-07-01T03:59:59.999Z status: POSTED token: fee_journal_entry_token2121 type: account.fee.payment.late user_token: user_token4632 - account_token: my_account_token_12 amount: 9.11 card_token: my_credit_card_token7794 created_time: 2023-09-26T11:53:48.228Z currency_code: USD detail_object: acquirer: system_trace_audit_number: 0 acquirer_fee_amount: 0 acquirer_reference_data: 4.355106395860054E22 acting_user_token: user_token4632 amount: 9.11 approval_code: 946791 batch_number: 2021048291031352 card: last_four: 4489 metadata: { } card_acceptor: city: OAKLAND country_code: US mcc: 5814 mid: 555600244811 name: SWEET TREATS 0484 postal_code: 94612 state: CA card_token: my_credit_card_token7794 clearing_record_sequence_number: 0 created_time: 2023-09-26T11:53:46Z currency_code: USD currency_conversion: network: conversion_rate: 1 original_amount: 9.11 original_currency_code: 840 duration: 378 fees: amount: 0.19131 credit_debit: C type: INTERCHANGE_FEE gpa: available_balance: 0 balances: USD: available_balance: 0 credit_balance: 0 currency_code: USD impacted_amount: -9.11 ledger_balance: 61.7 pending_credits: 0 credit_balance: 0 currency_code: USD impacted_amount: -9.11 ledger_balance: 61.7 pending_credits: 0 gpa_order: amount: 9.11 created_time: 2023-09-25T20:59:43Z currency_code: USD funding: amount: 9.11 source: active: true created_time: 2023-06-22T18:41:14Z is_default_account: false last_modified_time: 2023-06-22T18:41:14Z name: My Funding Source token: funding_source_token6789 type: programgateway funding_source_token: funding_source_token6789 jit_funding: acting_user_token: user_token4632 amount: 9.11 method: pgfs.authorization.capture original_jit_funding_token: jit_funding_token4be7 token: jit_funding_token43a3 user_token: user_token4632 last_modified_time: 2023-09-26T11:53:47Z response: code: 0 memo: Approved or completed successfully state: COMPLETION token: gpa_order_token2c2c5 transaction_token: transaction_token42352a user_token: user_token4632 identifier: 6457 issuer_interchange_amount: 0.19131 issuer_payment_node: 042f97a3458b59e3cce0269f66e864d8 issuer_received_time: 2023-09-26T11:53:46.886Z network: VISA network_metadata: product_id: VISA_TRADITIONAL program_id: '' network_reference_id: 218552461989029 pos: is_installment: false is_recurring: false partial_approval_capable: false pin_present: false purchase_amount_only: false terminal_id: 101 preceding_related_transaction_token: journal_entry_token2460 request_amount: 9.11 response: code: 0 memo: Approved or completed successfully settlement_date: 2023-09-26T00:00:00Z state: COMPLETION subnetwork: VISANET token: detail_token_645736 transaction_metadata: payment_channel: OTHER type: authorization.clearing user: metadata: notification_email: hello@myemail.com user_token: user_token4632 user_transaction_time: 2023-09-25T20:59:43Z detail_token: detail_token_645736 group: PURCHASE id: '12345678' impact_time: 2023-09-26T11:53:48.228Z memo: SWEET TREATS 0484 original_currency: amount: 11.53 code: CAD related_token: journal_entry_token2460 request_time: 2023-09-25T20:59:43 root_token: journal_entry_token2460 status: POSTED token: purchase_journal_entry_token6789 type: authorization.clearing user_token: user_token4632 end_index: 4 is_more: true start_index: 0 schema: $ref: '#/components/schemas/JournalEntriesPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List account journal entries tags: - Journal Entries /accounts/{account_token}/journalentries/{journal_entry_token}: get: description: Retrieve a journal entry for a credit account. operationId: getAccountJournalEntry parameters: - description: |- Unique identifier of the credit account for which you want to retrieve journal entries. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the journal entry you want to retrieve. Send a `GET` request to `/credit/accounts/{account_token}/journalentries` to retrieve existing journal entry tokens. explode: false in: path name: journal_entry_token required: true schema: type: string x-allowableValues: Existing journal entry token style: simple responses: '200': content: application/json: examples: fee_example: summary: The following code block shows a sample `FEE` journal entry. value: account_token: my_account_token_12 amount: 15 card_token: my_credit_card_token7794 created_time: 2023-07-01T07:00:24.240Z currency_code: USD detail_object: account_token: my_account_token_12 amount: 15 created: 2023-07-01T07:00:24.239Z currency_code: USD description: Late Payment Fee method: FLAT token: detail_token_11221 type: LATE_PAYMENT_FEE value: 25 detail_token: detail_token_11221 group: FEE id: '44445678' impact_time: 2023-07-01T03:59:59.999Z memo: Late payment fee request_time: 2023-07-01T03:59:59.999Z status: POSTED token: fee_journal_entry_token2121 type: account.fee.payment.late user_token: user_token4632 interest_example: summary: The following code block shows a sample `INTEREST` journal entry. value: account_token: my_account_token_12 amount: 2.31 card_token: my_credit_card_token7794 created_time: 2023-08-01T07:00:19.756Z currency_code: USD detail_object: account_token: my_account_token_12 average_daily_balance: 181.67 created_date: 2023-08-01T07:00:19.755Z currency_code: USD daily_periodic_rate: 4.1068E-4 days_in_billing_cycle: 31 goto_apr: 14.99 interest_amount: 2.31 statement_balance: 208.93 statement_closing_date: 2023-08-01T03:59:59.999Z statement_opening_date: 2023-07-01T04:00:00 statement_token: statement_token_75b token: detail_token_96749 updated_date: 2023-08-01T07:00:19.755Z detail_token: detail_token_96749 group: INTEREST id: '11112222' impact_time: 2023-08-01T03:59:59.999Z memo: Interest charge on purchases request_time: 2023-08-01T03:59:59.999Z status: POSTED token: interest_journal_entry_token1111 type: account.interest user_token: user_token4632 purchase_example: summary: The following code block shows a sample `PURCHASE` journal entry. value: account_token: my_account_token_12 amount: 9.11 card_token: my_credit_card_token7794 created_time: 2023-09-26T11:53:48.228Z currency_code: USD detail_object: acquirer: system_trace_audit_number: 0 acquirer_fee_amount: 0 acquirer_reference_data: 4.355106395860054E22 acting_user_token: user_token4632 amount: 9.11 approval_code: 946791 batch_number: 2021048291031352 card: last_four: 4489 metadata: { } card_acceptor: city: OAKLAND country_code: US mcc: 5814 mid: 555600244811 name: SWEET TREATS 0484 postal_code: 94612 state: CA card_token: my_credit_card_token7794 clearing_record_sequence_number: 0 created_time: 2023-09-26T11:53:46Z currency_code: USD currency_conversion: network: conversion_rate: 1 original_amount: 9.11 original_currency_code: 840 duration: 378 fees: amount: 0.19131 credit_debit: C type: INTERCHANGE_FEE gpa: available_balance: 0 balances: USD: available_balance: 0 credit_balance: 0 currency_code: USD impacted_amount: -9.11 ledger_balance: 61.7 pending_credits: 0 credit_balance: 0 currency_code: USD impacted_amount: -9.11 ledger_balance: 61.7 pending_credits: 0 gpa_order: amount: 9.11 created_time: 2023-09-25T20:59:43Z currency_code: USD funding: amount: 9.11 source: active: true created_time: 2023-06-22T18:41:14Z is_default_account: false last_modified_time: 2023-06-22T18:41:14Z name: My Funding Source token: funding_source_token6789 type: programgateway funding_source_token: funding_source_token6789 jit_funding: acting_user_token: user_token4632 amount: 9.11 method: pgfs.authorization.capture original_jit_funding_token: jit_funding_token4be7 token: jit_funding_token43a3 user_token: user_token4632 last_modified_time: 2023-09-26T11:53:47Z response: code: 0 memo: Approved or completed successfully state: COMPLETION token: gpa_order_token2c2c5 transaction_token: transaction_token42352a user_token: user_token4632 identifier: 6457 issuer_interchange_amount: 0.19131 issuer_payment_node: 042f97a3458b59e3cce0269f66e864d8 issuer_received_time: 2023-09-26T11:53:46.886Z network: VISA network_metadata: product_id: VISA_TRADITIONAL program_id: '' network_reference_id: 218552461989029 pos: is_installment: false is_recurring: false partial_approval_capable: false pin_present: false purchase_amount_only: false terminal_id: 101 preceding_related_transaction_token: journal_entry_token2460 request_amount: 9.11 response: code: 0 memo: Approved or completed successfully settlement_date: 2023-09-26T00:00:00Z state: COMPLETION subnetwork: VISANET token: detail_token_645736 transaction_metadata: payment_channel: OTHER type: authorization.clearing user: metadata: notification_email: hello@myemail.com user_token: user_token4632 user_transaction_time: 2023-09-25T20:59:43Z detail_token: detail_token_645736 group: PURCHASE id: '12345678' impact_time: 2023-09-26T11:53:48.228Z memo: SWEET TREATS 0484 original_currency: amount: 9.11 code: USD related_token: journal_entry_token2460 request_time: 2023-09-25T20:59:43 root_token: journal_entry_token2460 status: POSTED token: journal_entry_token6789 type: authorization.clearing user_token: user_token4632 schema: $ref: '#/components/schemas/JournalEntry' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve account journal entry tags: - Journal Entries /accounts/{account_token}/ledgerentries: get: deprecated: true description: |- Retrieve an array of ledger entries on a credit account. This endpoint supports <> and <>. operationId: ListAccountLedgerEntries parameters: - description: |- Unique identifier of the credit account for which you want to retrieve ledger entries. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: Number of ledger entry resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: Starting date of the date range from which to return ledger entries. explode: true in: query name: start_date required: false schema: example: 2024-01-01 type: string x-allowableValues: 'Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ' style: form - description: Ending date of the date range from which to return ledger entries. explode: true in: query name: end_date required: false schema: example: 2024-01-01 type: string x-allowableValues: 'Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ' style: form - description: Array of statuses by which to filter ledger entries. explode: true in: query name: statuses required: false schema: items: type: string type: array x-allowableValues: Valid ledger entry status style: form - description: Description of the ledger entries to return. explode: true in: query name: description required: false schema: type: string x-allowableValues: 255 char max style: form - description: Detail token of the ledger entries to return. explode: true in: query name: detail_token required: false schema: type: string x-allowableValues: 36 char max style: form - description: |- Array of groups by which to filter ledger entries. To return all ledger entry groups, do not include this query parameter. explode: true in: query name: groups required: false schema: items: type: string type: array x-allowableValues: Valid ledger entry group style: form - description: Number of ledger entries to return. explode: true in: query name: amount required: false schema: type: number x-allowableValues: Any integer style: form - description: Embeds the specified object into the response. explode: true in: query name: expand required: false schema: items: enum: - detailObject - originalCurrency type: string type: array style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `createdTime`, and not by the field names appearing in response bodies such as `created_time`. explode: true in: query name: sort_by required: false schema: default: -createdTime enum: - createdTime - -createdTime type: string style: form responses: '200': content: application/json: example: count: 3 data: - account_token: my_account_token_12 amount: 2.31 card_token: my_credit_card_token7794 created_time: 2023-08-01T07:00:19.756Z currency_code: USD detail_object: account_token: my_account_token_12 average_daily_balance: 181.67 created_date: 2023-08-01T07:00:19.755Z currency_code: USD daily_periodic_rate: 4.1068E-4 days_in_billing_cycle: 31 goto_apr: 14.99 interest_amount: 2.31 statement_balance: 208.93 statement_closing_date: 2023-08-01T03:59:59.999Z statement_opening_date: 2023-07-01T04:00:00 statement_token: statement_token_75b token: detail_token_96749 updated_date: 2023-08-01T07:00:19.755Z detail_token: detail_token_96749 group: INTEREST id: '11112222' impact_time: 2023-08-01T03:59:59.999Z memo: Interest charge on purchases request_time: 2023-08-01T03:59:59.999Z status: POSTED token: interest_ledger_entry_token1111 type: account.interest - account_token: my_account_token_12 amount: 15 card_token: my_credit_card_token7794 created_time: 2023-07-01T07:00:24.240Z currency_code: USD detail_object: account_token: my_account_token_12 amount: 15 created: 2023-07-01T07:00:24.239Z currency_code: USD description: Late Payment Fee method: FLAT token: detail_token_11221 type: LATE_PAYMENT_FEE value: 25 detail_token: detail_token_11221 group: FEE id: '44445678' impact_time: 2023-07-01T03:59:59.999Z memo: Late payment fee request_time: 2023-07-01T03:59:59.999Z status: POSTED token: fee_ledger_entry_token2121 type: account.fee.latepayment - account_token: my_account_token_12 amount: 9.11 card_token: my_credit_card_token7794 created_time: 2023-09-26T11:53:48.228Z currency_code: USD detail_object: acquirer: system_trace_audit_number: 0 acquirer_fee_amount: 0 acquirer_reference_data: 4.355106395860054E22 acting_user_token: user_token4632 amount: 9.11 approval_code: 946791 batch_number: 2021048291031352 card: last_four: 4489 metadata: { } card_acceptor: city: OAKLAND country_code: US mcc: 5814 mid: 555600244811 name: SWEET TREATS 0484 postal_code: 94612 state: CA card_token: my_credit_card_token7794 clearing_record_sequence_number: 0 created_time: 2023-09-26T11:53:46Z currency_code: USD currency_conversion: network: conversion_rate: 1 original_amount: 9.11 original_currency_code: 840 duration: 378 fees: amount: 0.19131 credit_debit: C type: INTERCHANGE_FEE gpa: available_balance: 0 balances: USD: available_balance: 0 credit_balance: 0 currency_code: USD impacted_amount: -9.11 ledger_balance: 61.7 pending_credits: 0 credit_balance: 0 currency_code: USD impacted_amount: -9.11 ledger_balance: 61.7 pending_credits: 0 gpa_order: amount: 9.11 created_time: 2023-09-25T20:59:43Z currency_code: USD funding: amount: 9.11 source: active: true created_time: 2023-06-22T18:41:14Z is_default_account: false last_modified_time: 2023-06-22T18:41:14Z name: My Funding Source token: funding_source_token6789 type: programgateway funding_source_token: funding_source_token6789 jit_funding: acting_user_token: user_token4632 amount: 9.11 method: pgfs.authorization.capture original_jit_funding_token: jit_funding_token4be7 token: jit_funding_token43a3 user_token: user_token4632 last_modified_time: 2023-09-26T11:53:47Z response: code: 0 memo: Approved or completed successfully state: COMPLETION token: gpa_order_token2c2c5 transaction_token: transaction_token42352a user_token: user_token4632 identifier: 6457 issuer_interchange_amount: 0.19131 issuer_payment_node: 042f97a3458b59e3cce0269f66e864d8 issuer_received_time: 2023-09-26T11:53:46.886Z network: VISA network_metadata: product_id: VISA_TRADITIONAL program_id: '' network_reference_id: 218552461989029 pos: is_installment: false is_recurring: false partial_approval_capable: false pin_present: false purchase_amount_only: false terminal_id: 101 preceding_related_transaction_token: ledger_entry_token2460 request_amount: 9.11 response: code: 0 memo: Approved or completed successfully settlement_date: 2023-09-26T00:00:00Z state: COMPLETION subnetwork: VISANET token: detail_token_645736 transaction_metadata: payment_channel: OTHER type: authorization.clearing user: metadata: notification_email: hello@myemail.com user_token: user_token4632 user_transaction_time: 2023-09-25T20:59:43Z detail_token: detail_token_645736 group: PURCHASE id: '12345678' impact_time: 2023-09-26T11:53:48.228Z memo: SWEET TREATS 0484 original_currency: amount: 11.53 code: CAD related_token: ledger_entry_token2460 request_time: 2023-09-25T20:59:43 root_token: ledger_entry_token2460 status: POSTED token: purchase_ledger_entry_token6789 type: authorization.clearing end_index: 4 is_more: true start_index: 0 schema: $ref: '#/components/schemas/LedgerEntriesPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List account ledger entries tags: - Ledger Entries /accounts/{account_token}/ledgerentries/{ledger_entry_token}: get: description: Retrieve a ledger entry for a credit account. operationId: getAccountLedgerEntry parameters: - description: |- Unique identifier of the credit account for which you want to retrieve ledger entries. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the ledger entry you want to retrieve. Send a `GET` request to `/credit/accounts/{account_token}/ledgerentries` to retrieve existing ledger entry tokens. explode: false in: path name: ledger_entry_token required: true schema: type: string x-allowableValues: Existing ledger entry token style: simple responses: '200': content: application/json: examples: fee_example: summary: The following code block shows a sample fee ledger entry. value: account_token: my_account_token_12 amount: 15 card_token: my_credit_card_token7794 created_time: 2023-07-01T07:00:24.240Z currency_code: USD detail_object: account_token: my_account_token_12 amount: 15 created: 2023-07-01T07:00:24.239Z currency_code: USD description: Late Payment Fee method: FLAT token: detail_token_11221 type: LATE_PAYMENT_FEE value: 25 detail_token: detail_token_11221 group: FEE id: '44445678' impact_time: 2023-07-01T03:59:59.999Z memo: Late payment fee request_time: 2023-07-01T03:59:59.999Z status: POSTED token: fee_ledger_entry_token2121 type: account.fee.latepayment interest_example: summary: The following code block shows a sample interest ledger entry. value: account_token: my_account_token_12 amount: 2.31 card_token: my_credit_card_token7794 created_time: 2023-08-01T07:00:19.756Z currency_code: USD detail_object: account_token: my_account_token_12 average_daily_balance: 181.67 created_date: 2023-08-01T07:00:19.755Z currency_code: USD daily_periodic_rate: 4.1068E-4 days_in_billing_cycle: 31 goto_apr: 14.99 interest_amount: 2.31 statement_balance: 208.93 statement_closing_date: 2023-08-01T03:59:59.999Z statement_opening_date: 2023-07-01T04:00:00 statement_token: statement_token_75b token: detail_token_96749 updated_date: 2023-08-01T07:00:19.755Z detail_token: detail_token_96749 group: INTEREST id: '11112222' impact_time: 2023-08-01T03:59:59.999Z memo: Interest charge on purchases request_time: 2023-08-01T03:59:59.999Z status: POSTED token: interest_ledger_entry_token1111 type: account.interest purchase_example: summary: The following code block shows a sample `PURCHASE` ledger entry. value: account_token: my_account_token_12 amount: 9.11 card_token: my_credit_card_token7794 created_time: 2023-09-26T11:53:48.228Z currency_code: USD detail_object: acquirer: system_trace_audit_number: 0 acquirer_fee_amount: 0 acquirer_reference_data: 4.355106395860054E22 acting_user_token: user_token4632 amount: 9.11 approval_code: 946791 batch_number: 2021048291031352 card: last_four: 4489 metadata: { } card_acceptor: city: OAKLAND country_code: US mcc: 5814 mid: 555600244811 name: SWEET TREATS 0484 postal_code: 94612 state: CA card_token: my_credit_card_token7794 clearing_record_sequence_number: 0 created_time: 2023-09-26T11:53:46Z currency_code: USD currency_conversion: network: conversion_rate: 1 original_amount: 9.11 original_currency_code: 840 duration: 378 fees: amount: 0.19131 credit_debit: C type: INTERCHANGE_FEE gpa: available_balance: 0 balances: USD: available_balance: 0 credit_balance: 0 currency_code: USD impacted_amount: -9.11 ledger_balance: 61.7 pending_credits: 0 credit_balance: 0 currency_code: USD impacted_amount: -9.11 ledger_balance: 61.7 pending_credits: 0 gpa_order: amount: 9.11 created_time: 2023-09-25T20:59:43Z currency_code: USD funding: amount: 9.11 source: active: true created_time: 2023-06-22T18:41:14Z is_default_account: false last_modified_time: 2023-06-22T18:41:14Z name: My Funding Source token: funding_source_token6789 type: programgateway funding_source_token: funding_source_token6789 jit_funding: acting_user_token: user_token4632 amount: 9.11 method: pgfs.authorization.capture original_jit_funding_token: jit_funding_token4be7 token: jit_funding_token43a3 user_token: user_token4632 last_modified_time: 2023-09-26T11:53:47Z response: code: 0 memo: Approved or completed successfully state: COMPLETION token: gpa_order_token2c2c5 transaction_token: transaction_token42352a user_token: user_token4632 identifier: 6457 issuer_interchange_amount: 0.19131 issuer_payment_node: 042f97a3458b59e3cce0269f66e864d8 issuer_received_time: 2023-09-26T11:53:46.886Z network: VISA network_metadata: product_id: VISA_TRADITIONAL program_id: '' network_reference_id: 218552461989029 pos: is_installment: false is_recurring: false partial_approval_capable: false pin_present: false purchase_amount_only: false terminal_id: 101 preceding_related_transaction_token: ledger_entry_token2460 request_amount: 9.11 response: code: 0 memo: Approved or completed successfully settlement_date: 2023-09-26T00:00:00Z state: COMPLETION subnetwork: VISANET token: detail_token_645736 transaction_metadata: payment_channel: OTHER type: authorization.clearing user: metadata: notification_email: hello@myemail.com user_token: user_token4632 user_transaction_time: 2023-09-25T20:59:43Z detail_token: detail_token_645736 group: PURCHASE id: '12345678' impact_time: 2023-09-26T11:53:48.228Z memo: SWEET TREATS 0484 original_currency: amount: 11.53 code: CAD related_token: ledger_entry_token2460 request_time: 2023-09-25T20:59:43 root_token: ledger_entry_token2460 status: POSTED token: ledger_entry_token6789 type: authorization.clearing user_token: user_token4632 schema: $ref: '#/components/schemas/LedgerEntry' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve account ledger entry tags: - Ledger Entries /accounts/{account_token}/payments: get: description: |- Retrieve an array of payments on a credit account. This endpoint supports <>. operationId: listPayments parameters: - description: |- Unique identifier of the credit account for which to retrieve payments. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: Beginning of the date range of the payments to return. explode: true in: query name: start_date required: false schema: example: 2024-01-01 format: date type: string style: form - description: End of the date range of the payments to return. explode: true in: query name: end_date required: false schema: example: 2024-02-01 format: date type: string style: form - description: Number of account payments resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form - description: Array of statuses by which to filter payments. explode: true in: query name: statuses required: false schema: items: $ref: '#/components/schemas/PaymentStatus' type: array style: form responses: '200': content: application/json: example: count: 2 data: - account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 amount: 2500 created_time: 2024-01-31T15:03:09.717Z currency_code: USD description: Account statement payment hold_days: 1 hold_end_time: 2024-02-03T11:32:24.727Z is_manually_released: false metadata: \"bank_account_last_4_digits\":\"7234\\"bank_name\":\"Bank Finance Plus\" method: ACH on_hold: false payment_source_token: 4474c16b-7ba7-435b-8854-237d492e3f32 returned_details: null status: COMPLETED token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 transitions: - account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 created_time: 2024-02-01T02:04:11.645Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: PROCESSING token: b62d45d5-4495-4490-a898-3781229b235d - account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 created_time: 2024-02-01T03:39:22.505Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: SUBMITTED token: 82d79178-5c97-41c2-80e5-bd99bb6bb61c - account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 created_time: 2024-01-31T15:30:45.028Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: PENDING token: c2a83d12-eeff-460a-b88a-bf7a2e40b251 - account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 created_time: 2024-02-02T11:32:24.727Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: COMPLETED token: 156b5134-b37d-49cf-89d5-7123b321ba5c - account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 created_time: 2024-01-31T15:03:09.723Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: INITIATED token: 64ca6c83-937c-4d37-86ae-14766bf87540 updated_time: 2024-02-03T12:00:30.072Z - account_token: my_account_token_12 allocations: - amount: 25 bucket: PRINCIPAL - amount: 15 bucket: INTEREST - amount: 5 bucket: FEES amount: 25 created_time: 2024-09-03T23:03:05.675Z currency_code: USD description: minimum payment hold_days: 0 is_manually_released: false method: CHECK on_hold: false status: COMPLETED token: my_payment_25 transitions: - account_token: my_account_token_12 created_time: 2024-09-03T23:03:05.683Z payment_token: my_payment_25 status: COMPLETED token: my_transition_token1234 updated_time: 2024-09-03T23:03:05.675Z end_index: 2 is_more: false start_index: 0 schema: $ref: '#/components/schemas/PaymentsPage' description: Paginated list of payments for the given token. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List account payments tags: - Payments post: description: Create a new payment to apply toward a credit account's balance. operationId: createPayment parameters: - description: |- Unique identifier of the credit account for which to create a payment. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple requestBody: content: application/json: example: amount: 2500 currency_code: USD description: Account statement payment method: ACH payment_source_token: payment_source_token_1112 token: payment_token_1239 schema: $ref: '#/components/schemas/PaymentCreateReq' required: true responses: '201': content: application/json: example: account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 amount: 2500 created_time: 2024-01-31T15:03:09.717Z currency_code: USD description: Account statement payment hold_days: 1 hold_end_time: 2024-02-03T11:32:24.727Z is_manually_released: false metadata: \"bank_account_last_4_digits\":\"7234\\"bank_name\":\"Bank Finance Plus\" method: ACH on_hold: false payment_source_token: 4474c16b-7ba7-435b-8854-237d492e3f32 refund_details: null returned_details: null status: COMPLETED token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 transitions: - account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 created_time: 2024-02-01T02:04:11.645Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: PROCESSING token: b62d45d5-4495-4490-a898-3781229b235d - account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 created_time: 2024-02-01T03:39:22.505Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: SUBMITTED token: 82d79178-5c97-41c2-80e5-bd99bb6bb61c - account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 created_time: 2024-01-31T15:30:45.028Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: PENDING token: c2a83d12-eeff-460a-b88a-bf7a2e40b251 - account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 created_time: 2024-02-02T11:32:24.727Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: COMPLETED token: 156b5134-b37d-49cf-89d5-7123b321ba5c - account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 created_time: 2024-01-31T15:03:09.723Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: INITIATED token: 64ca6c83-937c-4d37-86ae-14766bf87540 updated_time: 2024-02-03T12:00:30.072Z schema: $ref: '#/components/schemas/PaymentDetailResponse' description: Newly created payment or existing payment with provided payment token. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create account payment tags: - Payments /accounts/{account_token}/payments/{payment_token}: get: description: Retrieve a payment for a credit account. operationId: retrievePayment parameters: - description: |- Unique identifier of the credit account for which to retrieve a payment. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the payment to retrieve. Send a `GET` request to `/credit/accounts/{token}/payments` to retrieve existing payment tokens. explode: false in: path name: payment_token required: true schema: type: string x-allowableValues: Existing payment token style: simple responses: '200': content: application/json: example: account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 amount: 2500 created_time: 2024-01-31T15:03:09.717Z currency_code: USD description: Account statement payment hold_days: 1 hold_end_time: 2024-02-03T11:32:24.727Z is_manually_released: false metadata: \"bank_account_last_4_digits\":\"7234\\"bank_name\":\"Bank Finance Plus\" method: ACH on_hold: false payment_source_token: 4474c16b-7ba7-435b-8854-237d492e3f32 returned_details: null status: COMPLETED token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 transitions: - account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 created_time: 2024-02-01T02:04:11.645Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: PROCESSING token: b62d45d5-4495-4490-a898-3781229b235d - account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 created_time: 2024-02-01T03:39:22.505Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: SUBMITTED token: 82d79178-5c97-41c2-80e5-bd99bb6bb61c - account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 created_time: 2024-01-31T15:30:45.028Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: PENDING token: c2a83d12-eeff-460a-b88a-bf7a2e40b251 - account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 created_time: 2024-02-02T11:32:24.727Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: COMPLETED token: 156b5134-b37d-49cf-89d5-7123b321ba5c - account_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 created_time: 2024-01-31T15:03:09.723Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: INITIATED token: 64ca6c83-937c-4d37-86ae-14766bf87540 updated_time: 2024-02-03T12:00:30.072Z schema: $ref: '#/components/schemas/PaymentDetailResponse' description: Payment object default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve account payment tags: - Payments /accounts/{account_token}/payments/{payment_token}/releasehold: post: description: Manually release a payment hold on a credit account. operationId: releasePaymentHold parameters: - description: |- Unique identifier of the credit account on which a payment hold is being released. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the payment currently on hold. Send a `GET` request to `/credit/accounts/{account_token}/payments` to retrieve existing payment tokens. explode: false in: path name: payment_token required: true schema: type: string x-allowableValues: Existing payment token style: simple responses: '200': content: application/json: example: account_token: my_account_token_12 amount: 25 created_time: 2024-09-09T22:42:35.065Z currency_code: USD description: minimum payment hold_days: 5 hold_end_time: 2024-09-09T22:48:09.721Z is_manually_released: true metadata: check_number123 method: CHECK on_hold: false status: COMPLETED token: my_payment_25 transitions: - account_token: account-12 created_time: 2024-09-09T22:42:35.068Z payment_token: my_payment_25 status: COMPLETED token: my_transition_token1234 updated_time: 2024-09-09T22:48:09.722Z schema: $ref: '#/components/schemas/PaymentDetailResponse' description: Expected response. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Release payment hold tags: - Payments /accounts/{account_token}/payments/{payment_token}/transitions: post: description: Transition a credit account payment's status to a new status. operationId: transitionPayment parameters: - description: |- Unique identifier of the credit account for which you want to transition a payment status. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the payment whose status you want to transition. Send a `GET` request to `/credit/accounts/{account_token}/payments` endpoint to retrieve existing payment tokens for a given account. explode: false in: path name: payment_token required: true schema: type: string x-allowableValues: Existing payment token style: simple requestBody: content: application/json: example: status: RETURNED schema: $ref: '#/components/schemas/PaymentTransitionReq' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/PaymentTransitionResponse' description: Payment Transition Response object. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Transition account payment status tags: - Payments /accounts/{account_token}/paymentschedules: get: description: |- Retrieve an array of payment schedules on a specific credit account. This endpoint supports <>. operationId: retrievePaymentSchedules parameters: - description: |- Unique identifier of the credit account for which you want to retrieve payment schedules. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: Status of the payment schedules to retrieve. explode: true in: query name: statuses required: false schema: items: $ref: '#/components/schemas/PaymentScheduleStatus' type: array style: form - description: Frequency of the payment schedules to retrieve. explode: true in: query name: frequency required: false schema: items: $ref: '#/components/schemas/PaymentScheduleFrequency' type: array style: form - description: Number of payment schedule resources to retrieve. explode: true in: query name: count required: false schema: default: 5 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 2 data: - account_token: account1 amount: null amount_category: REMAINING_STATEMENT_BALANCE created_time: 2023-08-22T22:17:11.407Z currency_code: USD description: Sample payoff frequency: MONTHLY next_payment_impact_date: 2023-08-31 payment_day: PAYMENT_DUE_DAY payment_source_token: source1 status: ACTIVE token: mytoken updated_time: 2023-08-22T22:17:11.407Z - account_token: account1 amount: 100 amount_category: FIXED created_time: 2023-07-22T22:13:31.426Z currency_code: USD description: Sample payment frequency: ONCE next_payment_impact_date: 2023-08-10 payment_day: PAYMENT_DUE_DAY payment_source_token: source1 status: COMPLETED token: mytoken1 updated_time: 2023-07-22T22:13:31.426Z end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/PaymentSchedulePage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List payment schedules tags: - Payment Schedules post: description: Create a new payment schedule, either one-time or recurring. operationId: createPaymentSchedule parameters: - description: |- Unique identifier of the credit account for which you want to create a payment schedule. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple requestBody: content: application/json: example: amount: 100 amount_category: FIXED currency_code: USD description: Account statement payment frequency: MONTHLY payment_day: PAYMENT_DUE_DAY payment_source_token: payment_source_token_1112 token: payment_schedule_token_1239 schema: $ref: '#/components/schemas/PaymentScheduleCreateReq' required: true responses: '201': content: application/json: example: account_token: 12f10563-d5f2-11ec-889b-bd3a73e55331 amount: 2500 amount_category: FIXED created_time: 2024-01-12T15:03:09.717Z currency_code: USD description: Scheduled account payment frequency: ONCE next_payment_impact_date: 2024-01-31 payment_source_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 status: COMPLETED token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 schema: $ref: '#/components/schemas/PaymentScheduleResponse' description: Newly created payment schedule. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create payment schedule tags: - Payment Schedules /accounts/{account_token}/paymentschedules/{payment_schedule_token}: get: description: Retrieve a single payment schedule on a specific credit account. operationId: retrievePaymentSchedule parameters: - description: |- Unique identifier of the credit account for which you want to retrieve a payment schedule. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the payment schedule that you want to retrieve. Send a `GET` request to `/credit/accounts/{account_token}/paymentschedules` to retrieve existing payment schedule tokens. explode: false in: path name: payment_schedule_token required: true schema: type: string x-allowableValues: Existing payment schedule token style: simple responses: '200': content: application/json: example: account_token: 12f10563-d5f2-11ec-889b-bd3a73e55331 amount: 2500 amount_category: FIXED created_time: 2024-01-12T15:03:09.717Z currency_code: USD description: Scheduled account payment frequency: ONCE next_payment_impact_date: 2024-01-31 payment_source_token: 7d68f45b-1232-4283-a0ea-6b0418d37692 status: COMPLETED token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 schema: $ref: '#/components/schemas/PaymentScheduleResponse' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve payment schedule tags: - Payment Schedules /accounts/{account_token}/paymentschedules/{payment_schedule_token}/transitions: get: description: Retrieve an array of payment schedule transitions on a specific credit account. operationId: retrievePaymentScheduleTransitions parameters: - description: |- Unique identifier of the credit account for which you want to retrieve payment schedule transitions. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the payment schedule for which you want to retrieve transitions. Send a `GET` request to `/credit/accounts/{account_token}/paymentschedules` to retrieve existing payment schedule tokens. explode: false in: path name: payment_schedule_token required: true schema: type: string x-allowableValues: Existing payment schedule token style: simple - description: Number of payment schedule resources to retrieve. explode: true in: query name: count required: false schema: default: 5 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `createdTime`, and not by the field names appearing in response bodies such as `created_time`. explode: true in: query name: sort_by required: false schema: default: -createdTime enum: - createdTime - -createdTime type: string style: form responses: '200': content: application/json: example: count: 2 data: - account_token: account1 created_time: 2023-08-23T11:25:34.342Z payment_schedule_token: payment1 status: TERMINATED token: transition1 updated_time: 2023-08-23T11:25:34.342Z - account_token: account2 created_time: 2023-08-22T22:17:11.407Z payment_schedule_token: payment2 status: ACTIVE token: transition2 updated_time: 2023-08-22T22:17:11.407Z end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/PaymentScheduleTransitionPage' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve payment schedule transitions tags: - Payment Schedules post: description: Transition a payment schedule to a new status. operationId: createPaymentScheduleTransition parameters: - description: |- Unique identifier of the credit account on which to transition a payment schedule. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the payment schedule whose status is to transition. Send a `GET` request to `/credit/accounts/{account_token}/paymentschedules` to retrieve existing payment schedule tokens. explode: false in: path name: payment_schedule_token required: true schema: type: string x-allowableValues: Existing payment schedule token style: simple requestBody: content: application/json: example: status: TERMINATED token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 schema: $ref: '#/components/schemas/PaymentScheduleTransitionCreateReq' required: true responses: '201': content: application/json: example: account_token: credit_account_token_1232 created_time: 2024-01-12T15:03:09.717Z payment_schedule_token: payment_schedule_token_1232 status: TERMINATED token: payment_schedule_transition_token_111 updated_time: 2024-01-12T15:03:09.717Z schema: $ref: '#/components/schemas/PaymentScheduleTransitionResponse' description: Newly created payment schedule transition. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create payment schedule transition tags: - Payment Schedules /accounts/{account_token}/paymentschedules/{payment_schedule_token}/transitions/{token}: get: description: Retrieve a single payment schedule transition on a specific credit account. operationId: retrievePaymentScheduleTransition parameters: - description: |- Unique identifier of the credit account for which you want to retrieve a payment schedule transition. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the payment schedule you want to retrieve. Send a `GET` request to `/credit/accounts/{account_token}/paymentschedules` to retrieve existing payment schedule tokens. explode: false in: path name: payment_schedule_token required: true schema: type: string x-allowableValues: Existing payment schedule token style: simple - description: |- Unique identifier of the payment schedule transition you want to retrieve. Send a `GET` request to `/credit/accounts/{account_token}/paymentschedules/{payment_schedule_token}/transitions` to retrieve existing payment schedule transition tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing payment schedule transition token style: simple responses: '200': content: application/json: example: account_token: account1 created_time: 2023-08-22T22:17:11.407Z payment_schedule_token: payment1 status: ACTIVE token: transition2 updated_time: 2023-08-22T22:17:11.407Z schema: $ref: '#/components/schemas/PaymentScheduleTransitionResponse' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve payment schedule transition tags: - Payment Schedules /accounts/{account_token}/periodicfeeschedules: get: description: Get all active and upcoming periodic fee schedules of an account operationId: getPeriodicFeeSchedules parameters: - description: account token explode: false in: path name: account_token required: true schema: type: string style: simple - description: Number of periodic fee schedule resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/PeriodicFeeSchedulePage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Get all active and upcoming periodic fee schedules of an account tags: - Account /accounts/{account_token}/refunds: get: description: |- Use the `/credit/accounts/{account_token}/refunds` endpoint to retrieve an array of refunds on a credit account. This endpoint supports <>. operationId: listRefunds parameters: - description: |- Unique identifier of the credit account for which to retrieve refunds. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: Beginning of the date range of the refunds to return. explode: true in: query name: start_date required: false schema: format: date type: string x-allowableValues: 'Format: yyyy-MM-dd' style: form - description: End of the date range of the refunds to return. explode: true in: query name: end_date required: false schema: format: date type: string x-allowableValues: 'Format: yyyy-MM-dd' style: form - description: Number of account refund resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. Only supports `lastModifiedTime` and `-lastModifiedTime`. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `updated_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form - description: Array of statuses by which to filter refunds. explode: true in: query name: statuses required: false schema: items: $ref: '#/components/schemas/RefundStatus' type: array style: form responses: '200': content: application/json: example: count: 2 data: - account_token: my_account_token_12 amount: 10 created_time: 2025-01-02T20:17:28Z currency_code: USD description: credit balance refund method: ACH payment_source_token: my_payment_funding_source_token status: PENDING token: credit_balance_refund_token1234 type: CREDIT_BALANCE_REFUND updated_time: 2025-01-02T20:17:28Z - account_token: my_account_token_34 amount: 10 created_time: 2025-01-02T20:17:28Z currency_code: USD description: credit balance refund method: CHECK status: COMPLETED token: credit_balance_refund_token12 type: CREDIT_BALANCE_REFUND updated_time: 2025-01-02T20:17:28Z end_index: 2 is_more: false start_index: 0 schema: $ref: '#/components/schemas/RefundsPage' description: Paginated list of refunds for the given token. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List account refunds tags: - Account Refunds post: description: Create a new refund, which you can issue to the account holder if their credit account balance is negative. operationId: createRefund parameters: - description: |- Unique identifier of the credit account for which you want to create a balance refund. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple requestBody: content: application/json: example: description: credit refund method: ACH payment_source_token: my_payment_funding_source_token type: CREDIT_BALANCE_REFUND schema: $ref: '#/components/schemas/RefundCreateRequest' required: true responses: '201': content: application/json: example: account_token: my_account_token_12 amount: 10 created_time: 2025-01-02T20:17:28Z currency_code: USD description: credit balance refund method: ACH payment_source_token: my_payment_funding_source_token status: PENDING token: credit_balance_refund_token1234 type: CREDIT_BALANCE_REFUND updated_time: 2025-01-02T20:17:28Z schema: $ref: '#/components/schemas/RefundResponse' description: Expected response. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create refund tags: - Account Refunds /accounts/{account_token}/refunds/{refund_token}: get: description: Use the `/accounts/{account_token}/refunds/{refund_token}` endpoint to retrieve a refund. operationId: retrieveRefund parameters: - description: |- Unique identifier of the credit account for which to retrieve a refund. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the refund to retrieve. Send a `GET` request to `/credit/accounts/{account_token}/refunds/{refund_token}` to retrieve existing refunds. explode: false in: path name: refund_token required: true schema: type: string x-allowableValues: Existing refund token style: simple responses: '200': content: application/json: example: account_token: my_account_token_12 amount: 10 created_time: 2025-01-02T20:17:28Z currency_code: USD description: credit balance refund method: ACH payment_source_token: my_payment_funding_source_token status: PENDING token: credit_balance_refund_token1234 type: CREDIT_BALANCE_REFUND updated_time: 2025-01-02T20:17:28Z schema: $ref: '#/components/schemas/RefundResponse' description: Refund object default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve account refund tags: - Account Refunds /accounts/{account_token}/refunds/{refund_token}/transitions: get: description: Retrieve a list of transitions associated with the refund. operationId: retrieveRefundTransitions parameters: - description: Unique identifier of the credit account explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: Unique identifier of the refund explode: false in: path name: refund_token required: true schema: type: string x-allowableValues: 36 char max style: simple - description: The number of resources to retrieve. explode: true in: query name: count required: false schema: default: 5 minimum: 1 type: integer style: form - description: The sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `createdTime`, and not by the field names appearing in response bodies such as `created_time`. explode: true in: query name: sort_by required: false schema: default: -createdTime enum: - createdTime - -createdTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/RefundTransitionsPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List transitions associated with a refund post: description: Use the `/accounts/{account_token}/refunds/{refund_token}/transitions` endpoint to transition a credit account refund's status to a new status. operationId: transitionRefund parameters: - description: |- Unique identifier of the credit account for which you want to transition a refund status. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the refund whose status you want to transition. Send a `GET` request to `/credit/accounts/{account_token}/refunds` endpoint to retrieve existing refund tokens for a given account. explode: false in: path name: refund_token required: true schema: type: string x-allowableValues: Existing refund token style: simple requestBody: content: application/json: example: status: SUBMITTED schema: $ref: '#/components/schemas/RefundTransitionRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/RefundResponse' description: Refund Response object. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Transition account refund status tags: - Account Refunds /accounts/{account_token}/rewards: post: description: Create a reward for an existing credit account. operationId: createReward parameters: - description: |- Unique identifier of the credit account for which you want to create a reward. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple requestBody: content: application/json: example: account_token: my_account_token_12 amount: 20 created_time: 2023-09-03T22:53:57.895Z currency_code: USD description: $20 reward token: my_rewards_token1234 type: CASH_BACK updated_time: 2023-09-03T22:53:57.895Z schema: $ref: '#/components/schemas/RewardCreateReq' required: true responses: '201': content: application/json: example: account_token: my_account_token_12 amount: 20 created_time: 2023-09-03T22:53:57.895Z currency_code: USD description: $20 reward token: my_rewards_token1234 type: CASH_BACK updated_time: 2023-09-03T22:53:57.895Z schema: $ref: '#/components/schemas/RewardResponse' description: Newly created reward default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create account reward tags: - Account Rewards /accounts/{account_token}/signupbonusprogress: get: description: Retrieve the signup bonus progress, including the bonus amount and the remaining amount to be earned. operationId: retrieveSignupBonusProgress parameters: - description: |- Unique identifier of the credit account for which you want to retrieve the sign up bonus for. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple responses: '200': content: application/json: example: accrual_start_time: 2024-07-01T00:27:09Z maturity_time: 2024-09-29T00:27:09Z retrieval_time: 2021-08-01T00:27:09Z target_spend: 7000 total_spend: 2000 schema: $ref: '#/components/schemas/AccountSignupBonusProgressResponse' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve account signup bonus progress. tags: - Rewards /accounts/{account_token}/statements: get: description: |- Retrieve an array of statement summaries tied to a cardholder's account. The statement summary, which is a summary of account activity on a statement, provides account holders with a synopsis of activity that occurred on the account during a specified billing cycle. This endpoint supports <>. You can use optional query parameters to return a statement based on its exact opening or closing date, or a statement whose closing date falls within a range of dates. operationId: getStatementSummariesByAccount parameters: - description: |- Unique identifier of the credit account for which you want to retrieve statement summaries. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Returns statements with a matching opening date. If both `start_date` and `end_date` are specified, statements whose closing date falls between the start and end dates are returned. explode: true in: query name: start_date required: false schema: format: date-time type: string x-allowableValues: 'Format: yyyy-MM-ddThh:mm:ssZ' style: form - description: |- Returns statements with a matching closing date. If both `start_date` and `end_date` are specified, statements whose closing date falls between the start and end dates are returned. explode: true in: query name: end_date required: false schema: format: date-time type: string x-allowableValues: 'Format: yyyy-MM-ddThh:mm:ssZ' style: form - description: Number of account statement resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `createdTime`, and not by the field names appearing in response bodies such as `created_time`. explode: true in: query name: sort_by required: false schema: default: -createdTime enum: - createdTime - -createdTime type: string style: form responses: '200': content: application/json: example: count: 1 data: - account_token: my_account_token_12 available_credit: 800 closing_balance: 2000 closing_date: 2023-07-01T00:27:09Z created_time: 2023-07-01T00:27:09Z credit_limit: 10000 credits: 0 cycle_type: BEGINNING_REVOLVING days_in_billing_cycle: 31 fees: 0 interest: 0 opening_balance: 1000 opening_date: 2023-07-01T00:27:09Z past_due_amount: 0 payments: 0 purchases: 200 token: acc0544e-4075-fe67-93dd-6b5cd443adb1 end_index: 0 is_more: true start_index: 0 schema: $ref: '#/components/schemas/StatementSummaryPage' description: A JSON object containing a list of Statement Summaries default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List account statement summaries tags: - Statements /accounts/{account_token}/statements/files: get: description: Retrieve an array of statement files for a specific credit account. operationId: getStatementFilesByAccount parameters: - description: |- Unique identifier of the credit account for which to retrieve statement files. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: Start date of the date range for which to return statement files. explode: true in: query name: start_date required: false schema: example: 2024-01-01T00:00:00Z format: date-time type: string style: form - description: End date of the date range for which to return statement files. explode: true in: query name: end_date required: false schema: example: 2024-03-01T03:59:59Z format: date-time type: string style: form - description: Number of statement file resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `createdTime`, and not by the field names appearing in response bodies such as `created_time`. explode: true in: query name: sort_by required: false schema: default: -createdTime enum: - createdTime - -createdTime type: string style: form responses: '200': content: application/json: example: count: 1 data: - account_token: credit_account_token1234 closing_date: 2023-07-31T00:27:09 opening_date: 2023-07-01T00:27:09 signed_url: statement_summary_token: 37f07818-2a2c-4c82-a721-a479936d5b2e token: file_token type: STATEMENT_PDF - account_token: credit_account_token4567 closing_date: 2023-06-30T00:27:09 opening_date: 2023-06-01T00:27:09 signed_url: statement_summary_token: 79938791-5e15-456a-bf13-c39142c9a763 token: file_token type: STATEMENT_PDF end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/StatementFilePage' description: A JSON object containing a list of statement files. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List files for an account tags: - Statements /accounts/{account_token}/statements/{statement_summary_token}: get: description: Retrieve a statement summary for a credit account. operationId: retrieveStatementSummary parameters: - description: |- Unique identifier of the credit account for which you want to retrieve a statement summary. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the statement summary to retrieve. Send a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens. explode: false in: path name: statement_summary_token required: true schema: type: string x-allowableValues: Existing statement summary token style: simple responses: '200': content: application/json: example: account_token: my_account_token_12 available_credit: 800 closing_balance: 2000 closing_date: 2021-07-01T00:27:09Z created_time: 2021-07-01T00:27:09Z credit_limit: 10000 credits: 0 cycle_type: BEGINNING_REVOLVING days_in_billing_cycle: 31 fees: 0 interest: 0 opening_balance: 1000 opening_date: 2021-07-01T00:27:09Z past_due_amount: 0 payments: 0 purchases: 200 token: acc0544e-4075-fe67-93dd-6b5cd443adb1 schema: $ref: '#/components/schemas/StatementSummary' description: A JSON object containing statement_summary information default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve account statement summary tags: - Statements /accounts/{account_token}/statements/{statement_summary_token}/files: get: description: Retrieve an array of statement files for a specific statement summary. operationId: retrieveStatementFiles parameters: - description: |- Unique identifier of the credit account for which to retrieve statement files for a statement summary. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the statement summary whose statement files you want to retrieve. Send a `GET` request to `/credit/accounts/{token}/statements` to retrieve existing statement summary tokens. explode: false in: path name: statement_summary_token required: true schema: type: string x-allowableValues: Existing statement summary token style: simple - description: Number of statement files to return. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index from which to begin returning files. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form responses: '200': content: application/json: example: count: 1 data: - account_token: credit_account_token1234 closing_date: 2023-07-31T00:27:09 opening_date: 2023-07-01T00:27:09 signed_url: statement_summary_token: 37f07818-2a2c-4c82-a721-a479936d5b2e token: file_token type: STATEMENT_PDF end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/StatementFilePage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List files for a statement summary tags: - Statements /accounts/{account_token}/statements/{statement_summary_token}/interestcharges: get: description: Retrieve the interest charges on a credit account's statement summary. operationId: retrieveStatementInterestCharges parameters: - description: |- Unique identifier of the credit account for which you want to retrieve the statement interest charges. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the statement summary from which to retrieve the interest charges. Send a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens. explode: false in: path name: statement_summary_token required: true schema: type: string x-allowableValues: Existing statement summary token style: simple responses: '200': content: application/json: example: account_token: credit_account_token1234 data: - amount: 2.31 apr_type: GO_TO apr_value: 14.99 balance_subject_to_interest_rate: 181.67 balance_type: PURCHASE statement_summary_token: statement_summary_token1234 user_token: user_token1234 schema: $ref: '#/components/schemas/StatementInterestChargesPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve account statement interest charges tags: - Statements /accounts/{account_token}/statements/{statement_summary_token}/journalentries: get: description: |- Retrieve an array of journal entries on a credit account's statement summary. This endpoint supports <>. operationId: listStatementJournalEntries parameters: - description: |- Unique identifier of the credit account for which to retrieve the statement journal entries. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the statement summary from which to retrieve journal entries. Send a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens. explode: false in: path name: statement_summary_token required: true schema: type: string x-allowableValues: Existing statement summary token style: simple - description: Number of journal entry resources to return. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: Embeds the specified object into the response. explode: true in: query name: expand required: false schema: items: enum: - detailObject - originalCurrency type: string type: array style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 3 data: - account_token: my_account_token_12 amount: 2.31 card_token: my_credit_card_token7794 created_time: 2023-08-01T07:00:19.756Z currency_code: USD detail_object: account_token: my_account_token_12 average_daily_balance: 181.67 created_date: 2023-08-01T07:00:19.755Z currency_code: USD daily_periodic_rate: 4.1068E-4 days_in_billing_cycle: 31 goto_apr: 14.99 interest_amount: 2.31 statement_balance: 208.93 statement_closing_date: 2023-08-01T03:59:59.999Z statement_opening_date: 2023-07-01T04:00:00 statement_token: statement_token_75b token: detail_token_96749 updated_date: 2023-08-01T07:00:19.755Z detail_token: detail_token_96749 group: INTEREST id: '11112222' impact_time: 2023-08-01T03:59:59.999Z memo: Interest charge on purchases request_time: 2023-08-01T03:59:59.999Z status: POSTED token: interest_journal_entry_token1111 type: account.interest user_token: user_token1111 - account_token: my_account_token_12 amount: 15 card_token: my_credit_card_token7794 created_time: 2023-07-01T07:00:24.240Z currency_code: USD detail_object: account_token: my_account_token_12 amount: 15 created: 2023-07-01T07:00:24.239Z currency_code: USD description: Late Payment Fee method: FLAT token: detail_token_11221 type: LATE_PAYMENT_FEE value: 25 detail_token: detail_token_11221 group: FEE id: '44445678' impact_time: 2023-07-01T03:59:59.999Z memo: Late payment fee request_time: 2023-07-01T03:59:59.999Z status: POSTED token: fee_journal_entry_token2121 type: account.fee.payment.late user_token: user_token2121 - account_token: my_account_token_12 amount: 9.11 card_token: my_credit_card_token7794 created_time: 2023-09-26T11:53:48.228Z currency_code: USD detail_object: acquirer: system_trace_audit_number: 0 acquirer_fee_amount: 0 acquirer_reference_data: 4.355106395860054E22 acting_user_token: user_token4632 amount: 9.11 approval_code: 946791 batch_number: 2021048291031352 card: last_four: 4489 metadata: { } card_acceptor: city: OAKLAND country_code: US mcc: 5814 mid: 555600244811 name: SWEET TREATS 0484 postal_code: 94612 state: CA card_token: my_credit_card_token7794 clearing_record_sequence_number: 0 created_time: 2023-09-26T11:53:46Z currency_code: USD currency_conversion: network: conversion_rate: 1 original_amount: 9.11 original_currency_code: 840 duration: 378 fees: amount: 0.19131 credit_debit: C type: INTERCHANGE_FEE gpa: available_balance: 0 balances: USD: available_balance: 0 credit_balance: 0 currency_code: USD impacted_amount: -9.11 ledger_balance: 61.7 pending_credits: 0 credit_balance: 0 currency_code: USD impacted_amount: -9.11 ledger_balance: 61.7 pending_credits: 0 gpa_order: amount: 9.11 created_time: 2023-09-25T20:59:43Z currency_code: USD funding: amount: 9.11 source: active: true created_time: 2023-06-22T18:41:14Z is_default_account: false last_modified_time: 2023-06-22T18:41:14Z name: My Funding Source token: funding_source_token6789 type: programgateway funding_source_token: funding_source_token6789 jit_funding: acting_user_token: user_token4632 amount: 9.11 method: pgfs.authorization.capture original_jit_funding_token: jit_funding_token4be7 token: jit_funding_token43a3 user_token: user_token4632 last_modified_time: 2023-09-26T11:53:47Z response: code: 0 memo: Approved or completed successfully state: COMPLETION token: gpa_order_token2c2c5 transaction_token: transaction_token42352a user_token: user_token4632 identifier: 6457 issuer_interchange_amount: 0.19131 issuer_payment_node: 042f97a3458b59e3cce0269f66e864d8 issuer_received_time: 2023-09-26T11:53:46.886Z network: VISA network_metadata: product_id: VISA_TRADITIONAL program_id: '' network_reference_id: 218552461989029 pos: is_installment: false is_recurring: false partial_approval_capable: false pin_present: false purchase_amount_only: false terminal_id: 101 preceding_related_transaction_token: journal_entry_token2460 request_amount: 9.11 response: code: 0 memo: Approved or completed successfully settlement_date: 2023-09-26T00:00:00Z state: COMPLETION subnetwork: VISANET token: detail_token_645736 transaction_metadata: payment_channel: OTHER type: authorization.clearing user: metadata: notification_email: hello@myemail.com user_token: user_token4632 user_transaction_time: 2023-09-25T20:59:43Z detail_token: detail_token_645736 group: PURCHASE id: '12345678' impact_time: 2023-09-26T11:53:48.228Z memo: SWEET TREATS 0484 related_token: journal_entry_token2460 request_time: 2023-09-25T20:59:43 root_token: journal_entry_token2460 status: POSTED token: purchase_journal_entry_token6789 type: authorization.clearing user_token: user_token12 end_index: 4 is_more: true start_index: 0 schema: $ref: '#/components/schemas/JournalEntriesPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List account statement journal entries tags: - Statements /accounts/{account_token}/statements/{statement_summary_token}/ledgerentries: get: description: |- [IMPORTANT] This feature is being deprecated and replaced by statement journal entries. To list statement journal entries, see <>. Retrieve an array of ledger entries on a credit account's statement summary. This endpoint supports <>. operationId: listStatementLedgerEntries parameters: - description: |- Unique identifier of the credit account for which to retrieve the statement ledger entries. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the statement summary from which to retrieve ledger entries. Send a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens. explode: false in: path name: statement_summary_token required: true schema: type: string x-allowableValues: Existing statement summary token style: simple - description: Embeds the specified object into the response. explode: true in: query name: expand required: false schema: items: enum: - detailObject - originalCurrency type: string type: array style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form responses: '200': content: application/json: example: - account_token: my_account_token_12 amount: 9.11 card_token: my_credit_card_token7794 created_time: 2023-09-26T11:53:48.228Z currency_code: USD detail_object: acquirer: system_trace_audit_number: 0 acquirer_fee_amount: 0 acquirer_reference_data: 4.355106395860054E22 acting_user_token: user_token4632 amount: 9.11 approval_code: 946791 batch_number: 2021048291031352 card: last_four: 4489 metadata: { } card_acceptor: city: OAKLAND country_code: US mcc: 5814 mid: 555600244811 name: SWEET TREATS 0484 postal_code: 94612 state: CA card_token: my_credit_card_token7794 clearing_record_sequence_number: 0 created_time: 2023-09-26T11:53:46Z currency_code: USD currency_conversion: network: conversion_rate: 1 original_amount: 9.11 original_currency_code: 840 duration: 378 fees: amount: 0.19131 credit_debit: C type: INTERCHANGE_FEE gpa: available_balance: 0 balances: USD: available_balance: 0 credit_balance: 0 currency_code: USD impacted_amount: -9.11 ledger_balance: 61.7 pending_credits: 0 credit_balance: 0 currency_code: USD impacted_amount: -9.11 ledger_balance: 61.7 pending_credits: 0 gpa_order: amount: 9.11 created_time: 2023-09-25T20:59:43Z currency_code: USD funding: amount: 9.11 source: active: true created_time: 2023-06-22T18:41:14Z is_default_account: false last_modified_time: 2023-06-22T18:41:14Z name: My Funding Source token: funding_source_token6789 type: programgateway funding_source_token: funding_source_token6789 jit_funding: acting_user_token: user_token4632 amount: 9.11 method: pgfs.authorization.capture original_jit_funding_token: jit_funding_token4be7 token: jit_funding_token43a3 user_token: user_token4632 last_modified_time: 2023-09-26T11:53:47Z response: code: 0 memo: Approved or completed successfully state: COMPLETION token: gpa_order_token2c2c5 transaction_token: transaction_token42352a user_token: user_token4632 identifier: 6457 issuer_interchange_amount: 0.19131 issuer_payment_node: 042f97a3458b59e3cce0269f66e864d8 issuer_received_time: 2023-09-26T11:53:46.886Z network: VISA network_metadata: product_id: VISA_TRADITIONAL program_id: '' network_reference_id: 218552461989029 pos: is_installment: false is_recurring: false partial_approval_capable: false pin_present: false purchase_amount_only: false terminal_id: 101 preceding_related_transaction_token: ledger_entry_token2460 request_amount: 9.11 response: code: 0 memo: Approved or completed successfully settlement_date: 2023-09-26T00:00:00Z state: COMPLETION subnetwork: VISANET token: detail_token_645736 transaction_metadata: payment_channel: OTHER type: authorization.clearing user: metadata: notification_email: hello@myemail.com user_token: user_token4632 user_transaction_time: 2023-09-25T20:59:43Z detail_token: detail_token_645736 group: PURCHASE id: '12345678' impact_time: 2023-09-26T11:53:48.228Z memo: SWEET TREATS 0484 related_token: ledger_entry_token2460 request_time: 2023-09-25T20:59:43 root_token: ledger_entry_token2460 status: POSTED token: ledger_entry_token6789 type: authorization.clearing schema: items: $ref: '#/components/schemas/LedgerEntry' type: array description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List account statement ledger entries tags: - Statements /accounts/{account_token}/statements/{statement_summary_token}/paymentinfo: get: description: Retrieve the payment information on a credit account's statement summary. operationId: retrieveStatementPaymentInfo parameters: - description: |- Unique identifier of the credit account for which you want to retrieve the statement payment information. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the statement summary from which to retrieve the payment information. Send a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens. explode: false in: path name: statement_summary_token required: true schema: type: string x-allowableValues: Existing statement summary token style: simple responses: '200': content: application/json: example: created_time: 2021-07-01T00:27:09Z minimum_payment_due: 25 new_statement_balance: 2000 payment_cutoff_date: 2021-07-01T00:27:09Z payment_due_date: 2021-07-01T00:27:09Z statement_summary_token: acc0544e-4075-fe67-93dd-6b5cd443adb1 three_year_savings: 0 token: 5e3182dc-fc8f-4a83-8038-8808297ca0ca warnings: - disclosure: NEGATIVE_OR_NO_AMORTIZATION interest_paid: 0 monthly_payment: 0 pay_off_period: 1 period_type: MONTH total_paid: 0 type: MIN_PAYMENT schema: $ref: '#/components/schemas/StatementPaymentInfo' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve account statement payment information tags: - Statements /accounts/{account_token}/statements/{statement_summary_token}/paymentreminders/: get: description: Retrieve an array of payment reminder details for a specific statement summary token. operationId: getPaymentRemindersByStatementSummary parameters: - description: |- Unique identifier of the credit account for which you want to retrieve the statement payment information. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the statement summary from which to retrieve the payment information. Send a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens. explode: false in: path name: statement_summary_token required: true schema: type: string x-allowableValues: Existing statement summary token style: simple - description: Number of payment reminder resources to retrieve. explode: true in: query name: count required: false schema: default: 10 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `createdTime`, and not by the field names appearing in response bodies such as `created_time`. explode: true in: query name: sort_by required: false schema: default: -createdTime enum: - createdTime - -createdTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaymentReminderPage' description: Successful response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List payment reminders by statement summary tags: - Statements /accounts/{account_token}/statements/{statement_summary_token}/paymentreminders/{token}: get: description: Retrieve a single payment reminder on a specific statement summary operationId: getPaymentReminder parameters: - description: |- Unique identifier of the credit account for which you want to retrieve the statement payment reminder. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the statement summary for which you want to retrieve the statement payment reminder. Send a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens. explode: false in: path name: statement_summary_token required: true schema: type: string x-allowableValues: Existing statement summary token style: simple - description: |- Unique identifier of the payment reminder you want to retrieve. Send a `GET` request to `/credit/accounts/{account_token}/statements/{statement_summary_token}/paymentreminders/{token}` to retrieve existing payment reminder tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing payment reminder token style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaymentReminderResponse' description: Successful response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Get payment reminder tags: - Statements /accounts/{account_token}/statements/{statement_summary_token}/rewards: get: description: Retrieve the rewards on a credit account's statement summary. operationId: retrieveStatementReward parameters: - description: |- Unique identifier of the credit account from which to retrieve statement rewards. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the statement summary from which to retrieve rewards. Send a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens. explode: false in: path name: statement_summary_token required: true schema: type: string x-allowableValues: Existing statement summary token style: simple responses: '200': content: application/json: example: created_time: 2022-09-01T00:27:09Z current_billing_cycle_reward: 0 previous_billing_cycle_reward: 0 token: account_statement_reward1234 schema: $ref: '#/components/schemas/StatementReward' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve account statement rewards tags: - Statements /accounts/{account_token}/statements/{statement_summary_token}/yeartodate: get: description: Retrieve the year-to-date fee and interest totals on a credit account's statement summary. operationId: retrieveYearToDateForStatementSummary parameters: - description: |- Unique identifier of the credit account from which to retrieve statement year-to-date totals. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the statement summary from which to retrieve year-to-date totals. Send a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens. explode: false in: path name: statement_summary_token required: true schema: type: string x-allowableValues: Existing statement summary token style: simple responses: '200': content: application/json: example: account_token: my_account_token_12 created_time: 2021-07-01T00:27:09Z statement_token: c07918af-2ffa-4da9-972c-6b3d24b2a772 token: c40b683b-ad88-51b6-a1fa-bc9961bc011e total_fees: 0 total_interest: 0 schema: $ref: '#/components/schemas/YearToDate' description: A JSON object containing year-to-date information default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve account statement year-to-date totals tags: - Statements /accountusers/{user_token}: get: description: Retrieve a user's account information. operationId: retrieveAccountUser parameters: - description: |- Unique identifier of the user to retrieve. Send a `GET` request to `/account/users` to retrieve existing user tokens. explode: false in: path name: user_token required: true schema: type: string x-allowableValues: Existing user token style: simple responses: '200': content: application/json: example: address1: Addres Test address2: 1 Under Stair Case Rd city: New York country: US credit_accounts: - is_primary: true token: account-token-5678 email: abc@hogwarts.edu first_name: Harry last_name: Potter phone: '0000000000' state: NY token: user-token-1234 zip: '11217' schema: $ref: '#/components/schemas/AccountUserResponse' description: User details and associated account information default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve user tags: - AccountUsers /admin/programs/funding: get: description: Retrieve an array of program funding entries. operationId: getProgramFundings parameters: - description: Number of program funding resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: Start date for filtering program funding entries. explode: true in: query name: start_date required: false schema: example: 2014-01-01 type: string style: form - description: End date for filtering program funding entries. explode: true in: query name: end_date required: false schema: example: 2014-04-01 type: string style: form - description: Short code for filtering program funding entries. explode: true in: query name: short_code required: false schema: type: string style: form responses: '200': content: application/json: example: count: 2 data: - amount: 1000 created_time: 2025-04-01T23:41:58.802Z currency_code: USD memo: This is a test memo post_time: 2025-04-01T23:41:58.000Z short_code: my_program_short_code_12 token: my_program_funding_token1234 updated_time: 2025-04-01T23:41:58.802Z - amount: 500 created_time: 2025-04-02T23:41:58.802Z currency_code: USD memo: This is a test memo post_time: 2025-04-01T23:41:58.000Z short_code: my_program_short_code_34 token: my_program_funding_token5678 updated_time: 2025-04-02T23:41:58.802Z end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/ProgramFundingPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - nileToken: [ ] summary: List program fundings tags: - ProgramFunding /admin/replayfailedstatements: post: description: Replays all failed statement from statement error processing table operationId: replayFailedStatements responses: '200': content: application/json: schema: $ref: '#/components/schemas/Success' description: Replays all failed statements default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - nileToken: [ ] summary: Replays all failed statement from statement error processing table tags: - Admin /admin/replayfailedstatements/{short_code}: post: description: Replays all failed statements by short code from statement error processing table operationId: replayFailedStatementsByShortCode parameters: - description: Short code of the program explode: false in: path name: short_code required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/Success' description: Replays all failed statements by shortcode default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - nileToken: [ ] summary: Replays all failed statements by short code from statement error processing table tags: - Admin /admin/scheduleStatements: post: description: Schedules statements for applicable accounts operationId: scheduleStatements responses: '200': content: application/json: schema: $ref: '#/components/schemas/Success' description: Schedules statements for applicable accounts default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - nileToken: [ ] summary: Schedules statements for applicable accounts tags: - Admin /admin/{short_code}/replayfailedstatement/{account_token}: post: description: Creates and enables a feature flag for a specified program short code operationId: replaySingleFailedStatement parameters: - description: Short code of the program explode: false in: path name: short_code required: true schema: type: string style: simple - description: account token of the account explode: false in: path name: account_token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/Success' description: Method unimplemented default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - nileToken: [ ] summary: Replays single failed statement by short code and account token from statement error processing table tags: - Admin /admin/{short_code}/retryachpayments: post: description: Create a new ACHO ACH transfer for payment who's current transfer has failed and is in ERROR state. operationId: retryAchPayment parameters: - description: Short code of the program explode: false in: path name: short_code required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/RetryAchPaymentReq' description: Create a new ACHO ACH transfer required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/RetryAchPaymentReq' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - nileToken: [ ] summary: Create a new ACHO ACH transfer tags: - Admin /authcontrols: get: operationId: getAuthcontrols parameters: - description: Card product token. Use "null" to get auth controls that are not associated with any card product. explode: true in: query name: card_product required: false schema: type: string style: form - description: User token. Use "null" to get auth controls that are not associated with any user. explode: true in: query name: user required: false schema: type: string style: form - description: Number of items to retrieve. Count can be between 1 - 10 items. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Indicates from what row to start returning data. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Field by which to sort the returned items. Use any field in the model, or system fields lastModifiedTime or createdTime. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthControlListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all global auth control exceptions for the program tags: - auth controls post: operationId: postAuthcontrols requestBody: content: application/json: schema: $ref: '#/components/schemas/auth_control_request' description: Auth control object required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/auth_control_response' description: Created '400': content: { } description: Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Creates an auth control exception tags: - auth controls /authcontrols/exemptmids: get: operationId: getAuthcontrolsExemptmids parameters: - description: Card product token. Use "null" to get auth controls that are not associated with any card product. explode: true in: query name: card_product required: false schema: type: string style: form - description: User token. Use "null" to get auth controls that are not associated with any user. explode: true in: query name: user required: false schema: type: string style: form - description: Number of items to retrieve. Count can be between 1 - 10 items. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Indicates from what row to start returning data. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Field by which to sort the returned items. Use any field in the model, or system fields lastModifiedTime or createdTime. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthControlExemptMidsListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all auth control exempted MIDs for the program tags: - auth controls post: operationId: postAuthcontrolsExemptmids requestBody: content: application/json: schema: $ref: '#/components/schemas/auth_control_exempt_mids_request' description: Auth control exempt MID object required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/auth_control_exempt_mids_response' description: Created '400': content: { } description: Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Creates an auth control for exempting MIDs tags: - auth controls /authcontrols/exemptmids/{token}: get: operationId: getAuthcontrolsExemptmidsToken parameters: - description: Auth control token explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/auth_control_exempt_mids_response' description: Success '400': content: { } description: Bad request '404': content: { } description: Auth control exception MIDs not found '500': content: { } description: Server error summary: Returns a specific auth control exemptmids tags: - auth controls put: operationId: putAuthcontrolsExemptmidsToken parameters: - description: Auth control token explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/auth_control_exempt_mids_update_request' required: false responses: '204': content: { } description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Updates the status an auth control exemptmids tags: - auth controls /authcontrols/{token}: get: operationId: getAuthcontrolsToken parameters: - description: Auth control token explode: false in: path name: token required: true schema: type: string style: simple - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/auth_control_response' description: Success '400': content: { } description: Bad request '404': content: { } description: Auth control not found '500': content: { } description: Server error summary: Returns a specific auth control exception tags: - auth controls put: operationId: putAuthcontrolsToken parameters: - description: Auth control token explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/auth_control_update_request' description: Auth control object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/auth_control_response' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Updates an auth control exception tags: - auth controls /autoreloads: get: operationId: getAutoreloads parameters: - description: Card product token explode: true in: query name: card_product required: false schema: type: string style: form - description: User token explode: true in: query name: user_token required: false schema: type: string style: form - description: Business token explode: true in: query name: business_token required: false schema: type: string style: form - description: Number of items to retrieve. Count can be between 1 - 10 items. explode: true in: query name: count required: false schema: default: 10 format: int32 type: integer style: form - description: Indicates from what row to start returning data. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Field by which to sort the returned items. Use any field in the model, or system fields lastModifiedTime or createdTime. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/AutoReloadListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all auto reloads for the program tags: - auto reloads post: operationId: postAutoreloads requestBody: content: application/json: schema: $ref: '#/components/schemas/auto_reload_model' description: Auto reload object required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/auto_reload_response_model' description: Created '400': content: { } description: Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Creates an auto reload object tags: - auto reloads /autoreloads/{token}: get: operationId: getAutoreloadsToken parameters: - description: Auto reload token explode: false in: path name: token required: true schema: type: string style: simple - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/auto_reload_response_model' description: Success '400': content: { } description: Bad request '404': content: { } description: Auto reload not found '500': content: { } description: Server error summary: Returns a specific auto reload object tags: - auto reloads put: operationId: putAutoreloadsToken parameters: - explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/auto_reload_update_model' description: Auto reload object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/auto_reload_response_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Updates a specific auto reload object tags: - auto reloads /balances/account/{token}: get: description: balances/account/{token} operationId: getAccountBalancesToken parameters: - description: The unique token associated with the user or business account. This token is required to fetch the corresponding account balance. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/account_balance_response' description: Success '400': content: { } description: Bad request '404': content: { } description: Account not found '500': content: { } description: Server error summary: Returns account balance for an account tags: - cardholder balances /balances/user/{token}: get: description: /balances/user/{token} operationId: getUserAccountBalances parameters: - description: The unique token identifying the user or business. This token is required to retrieve the associated account balances. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/user_accounts_balance_response' description: Success '400': content: { } description: Bad request '403': content: { } description: Forbidden '404': content: { } description: Account not found '500': content: { } description: Server error summary: Returns account balances for a cardholder tags: - cardholder balances /balances/{token}: get: operationId: getBalancesToken parameters: - description: User or Business token explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/cardholder_balances' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Returns account balances for a cardholder tags: - cardholder balances /banktransfers/ach: get: operationId: getBanktransfersAch parameters: - description: Number of users to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: User token explode: true in: query name: user_token required: false schema: type: string style: form - description: Business token explode: true in: query name: business_token required: false schema: type: string style: form - description: Funding source token explode: true in: query name: funding_source_token required: false schema: type: string style: form - description: A comma-delimited list of bank transfer status(s) explode: true in: query name: statuses required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form - description: Object to expand explode: true in: query name: expand required: false schema: type: string style: form - description: Funding source type explode: true in: query name: funding_source_type required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/BankTransferListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all bank transfers tags: - bank transfers post: operationId: postBanktransfersAch requestBody: content: application/json: schema: $ref: '#/components/schemas/bank_transfer_request_model' description: Create bank transfer request model required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/bank_transfer_response_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Creates an ACH bank transfer tags: - bank transfers /banktransfers/ach/earlyfunds: post: operationId: postApplyProvisionalCreditToBankTransfer requestBody: content: application/json: schema: $ref: '#/components/schemas/early_funds_request_model' description: Early funds request model required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/bank_transfer_response_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Applies a provisional credit to a bank transfer tags: - bank transfers /banktransfers/ach/transitions: get: operationId: getBanktransfersAchTransitions parameters: - description: Number of bank transfer transitions to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 maximum: 50 type: integer style: form - description: Bank transfer transition token explode: true in: query name: token required: false schema: type: string style: form - description: Bank transfer token explode: true in: query name: bank_transfer_token required: false schema: type: string style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -createdTime type: string style: form - description: Comma-delimited list of bank transfer states to display e.g. PENDING | PROCESSING | SUBMITTED | RETURNED | COMPLETED | CANCELLED explode: true in: query name: statuses required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/BankTransferTransitionListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all bank transfer transitions tags: - bank transfers post: operationId: postBanktransfersAchTransitions requestBody: content: application/json: schema: $ref: '#/components/schemas/bank_transfer_transition_request_model' description: Create bank transfer transition request model required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/bank_transfer_transition_response_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Creates an ACH bank transfer transition tags: - bank transfers /banktransfers/ach/{token}: get: operationId: getBanktransfersAchToken parameters: - description: Bank transfer token explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/bank_transfer_response_model' description: Success '404': content: { } description: Bank transfer entry not found '500': content: { } description: Server error summary: Returns a bank transfer entry tags: - bank transfers /bulkissuances: get: operationId: getBulkissuances parameters: - description: Number of requests to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -createdTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkCardOrderListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all bulk issuance requests tags: - bulk issuances post: operationId: postBulkissuances requestBody: content: application/json: schema: $ref: '#/components/schemas/bulk_issuance_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/bulk_issuance_response' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Creates a bulk issuance request for cards tags: - bulk issuances /bulkissuances/{token}: get: operationId: getBulkissuancesToken parameters: - description: Bulk issuance token explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/bulk_issuance_response' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Bulk issuance request not found '500': content: { } description: Server error summary: Returns a bulk issuance request tags: - bulk issuances /bundles: get: description: |- Retrieve an array of bundles. This endpoint supports <>. operationId: listBundles parameters: - description: Number of bundles resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, not by the field names appearing in response bodies: for example, `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form - description: An array of statuses by which to filter bundles. explode: true in: query name: status required: false schema: items: $ref: '#/components/schemas/BundleResourceStatus' type: array style: form responses: '200': content: application/json: example: count: 2 data: - apr_policy_detail: created_time: 2024-04-01T23:41:58.802Z description: A gold APR policy effective_date: 2024-05-01 name: Gold APR Policy purchases: external_token: my_external_purchase_token1234 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 1 - apr: 0 margin_rate: 5 token: my_apr_policy_token_1234 updated_time: 2024-04-05T16:04:48.643Z apr_policy_token: my_apr_policy_token_1234 created_time: 2024-04-01T23:41:58.802Z credit_product_policy_detail: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER created_time: 2024-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A gold credit product policy interest_calculation: application_of_credits: cycle_type: END_REVOLVING day: 15 day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_PAYMENT_DATE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 name: Gold Credit Product Policy payments: allocation_order: - INTEREST - FEES - PRINCIPAL billing_cycle_day: 1 due_day: 31 min_payment_calculation: include_overlimit_amount: true include_past_due_amount: false min_payment_flat_amount: 20 min_payment_percentage: include_fees_charged: - LATE_PAYMENT_FEE include_interest_charged: false percentage_of_balance: 1 product_sub_type: CREDIT_CARD product_type: REVOLVING token: my_credit_product_policy_token_1234 updated_time: 2024-04-05T16:04:48.643Z usage: - PURCHASE credit_product_policy_token: my_credit_product_policy_token_1234 description: A gold credit bundle document_policy_detail: account_statement: template_token: an_account_statement_template_token1234 template_urls: html: https://url.com/an_account_statement_template_token1234.html benefits_disclosure: asset_token: a_benefits_disclosure_asset_token1234 asset_urls: html: https://url.com/a_benefits_disclosure_asset_token1234.html pdf: https://url.com/a_benefits_disclosure_asset_token1234.pdf png: https://url.com/a_benefits_disclosure_asset_token1234.png card_member_agreement: asset_token: a_card_member_agreement_asset_token1234 asset_urls: html: https://url.com/a_card_member_agreement_asset_token1234.html pdf: https://url.com/a_card_member_agreement_asset_token1234.pdf png: https://url.com/a_card_member_agreement_asset_token1234.png created_time: 2025-04-01T23:41:58.802Z e_disclosure: asset_token: a_e_disclosure_asset_token1234 asset_urls: html: https://url.com/a_e_disclosure_asset_token1234.html pdf: https://url.com/a_e_disclosure_asset_token1234.pdf png: https://url.com/a_e_disclosure_asset_token1234.png name: My Document Policy notice_of_adverse_action: template_token: a_notice_of_adverse_action_template_token1234 template_urls: html: https://url.com/a_notice_of_adverse_action_template_token1234.html privacy_policy: asset_token: a_privacy_policy_asset_token1234 asset_urls: html: https://url.com/a_privacy_policy_asset_token1234.html pdf: https://url.com/a_privacy_policy_asset_token1234.pdf png: https://url.com/a_privacy_policy_asset_token1234.png rewards_disclosure: asset_token: a_rewards_disclosure_asset_token1234 asset_urls: html: https://url.com/a_rewards_disclosure_asset_token1234.html pdf: https://url.com/a_rewards_disclosure_asset_token1234.pdf png: https://url.com/a_rewards_disclosure_asset_token1234.png template_token: a_rewards_disclosure_template_token1234 template_urls: html: https://url.com/a_rewards_disclosure_template_token1234.html summary_of_credit_terms: asset_token: a_summary_of_credit_terms_asset_token1234 asset_urls: html: https://url.com/a_summary_of_credit_terms_asset_token1234.html pdf: https://url.com/a_summary_of_credit_terms_asset_token1234.pdf png: https://url.com/a_summary_of_credit_terms_asset_token1234.png template_token: a_summary_of_credit_terms_template_token1234 template_urls: html: https://url.com/a_summary_of_credit_terms_template_token1234.html terms_schedule: template_token: a_terms_schedule_template_token1234 template_urls: html: https://url.com/a_terms_schedule_template_token1234.html token: my_document_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z document_policy_token: my_document_policy_token_1234 fee_policy_detail: account: foreign_transaction_fee: default_method: PERCENTAGE default_value: 12.5 late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2024-04-01T23:41:58.802Z description: A gold fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2024-04-05T16:04:48.643Z fee_policy_token: my_fee_policy_token_1234 name: Gold Credit Bundle offer_policy_detail: created_time: 2024-04-01T23:41:58.802Z description: A gold offer policy name: Gold Offer Policy token: my_offer_policy_token_1234 updated_time: 2024-04-05T16:04:48.643Z offer_policy_token: my_offer_policy_token_1234 parent_token: my_parent_token_1234 reward_policy_detail: accrual_strategy: DEFAULT conversions: - conversion_increment: 10 conversion_rate: 0.001 currency: USD type: STATEMENT_CREDIT created_time: 2025-04-01T23:41:58.802Z description: A gold reward policy exclusions: custom_exclusions: - 2000-2999 - '4321' use_default_exclusions: false name: Gold Reward Policy redemption_strategy: MANUAL rounding_strategy: ROUND_HALF_EVEN rules: - amount: null attributes: mcc: - 0001-1499 - '1500' calculation_type: PER_TRANSACTION description: Earn 3x on selected categories. multiplier: 3 type: MULTIPLIER_PER_TRANSACTION settlement_strategy: STATEMENT token: my_reward_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z reward_policy_token: my_reward_policy_token_1234 status: DRAFT token: my_bundle_token_1234 updated_time: 2024-04-05T16:04:48.643Z - apr_policy_detail: created_time: 2024-04-01T23:41:58.802Z description: A silver APR policy effective_date: 2024-06-01 name: Silver APR Policy purchases: external_token: my_external_purchase_token4321 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 3 - apr: 0 margin_rate: 6 token: my_apr_policy_token_4321 updated_time: 2024-04-05T16:04:48.643Z apr_policy_token: my_apr_policy_token_4321 created_time: 2024-04-01T23:41:58.802Z credit_product_policy_detail: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token4321 classification: CONSUMER created_time: 2024-04-01T23:41:58.802Z credit_line: max: 3100 min: 50 currency_code: USD description: A silver credit product policy interest_calculation: application_of_credits: cycle_type: END_REVOLVING day: 15 day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_PAYMENT_DATE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 name: Silver Credit Product Policy payments: allocation_order: - INTEREST - FEES - PRINCIPAL billing_cycle_day: 1 due_day: 31 min_payment_calculation: include_overlimit_amount: true include_past_due_amount: false min_payment_flat_amount: 20 min_payment_percentage: include_fees_charged: - LATE_PAYMENT_FEE include_interest_charged: false percentage_of_balance: 1 product_sub_type: CREDIT_CARD product_type: REVOLVING token: my_credit_product_policy_token_4321 updated_time: 2024-04-05T16:04:48.643Z usage: - PURCHASE credit_product_policy_token: my_credit_product_policy_token_4321 description: A silver credit bundle document_policy_detail: account_statement: template_token: an_account_statement_template_token4321 template_urls: html: https://url.com/an_account_statement_template_token4321.html benefits_disclosure: asset_token: a_benefits_disclosure_asset_token4321 asset_urls: html: https://url.com/a_benefits_disclosure_asset_token4321.html pdf: https://url.com/a_benefits_disclosure_asset_token4321.pdf png: https://url.com/a_benefits_disclosure_asset_token4321.png card_member_agreement: asset_token: a_card_member_agreement_asset_token4321 asset_urls: html: https://url.com/a_card_member_agreement_asset_token4321.html pdf: https://url.com/a_card_member_agreement_asset_token4321.pdf png: https://url.com/a_card_member_agreement_asset_token4321.png created_time: 2025-04-01T23:41:58.802Z e_disclosure: asset_token: a_e_disclosure_asset_token4321 asset_urls: html: https://url.com/a_e_disclosure_asset_token4321.html pdf: https://url.com/a_e_disclosure_asset_token4321.pdf png: https://url.com/a_e_disclosure_asset_token4321.png name: My Document Policy notice_of_adverse_action: template_token: a_notice_of_adverse_action_template_token4321 template_urls: html: https://url.com/a_notice_of_adverse_action_template_token4321.html privacy_policy: asset_token: a_privacy_policy_asset_token4321 asset_urls: html: https://url.com/a_privacy_policy_asset_token4321.html pdf: https://url.com/a_privacy_policy_asset_token4321.pdf png: https://url.com/a_privacy_policy_asset_token4321.png rewards_disclosure: asset_token: a_rewards_disclosure_asset_token4321 asset_urls: html: https://url.com/a_rewards_disclosure_asset_token4321.html pdf: https://url.com/a_rewards_disclosure_asset_token4321.pdf png: https://url.com/a_rewards_disclosure_asset_token4321.png template_token: a_rewards_disclosure_template_token4321 template_urls: html: https://url.com/a_rewards_disclosure_template_token4321.html summary_of_credit_terms: asset_token: a_summary_of_credit_terms_asset_token4321 asset_urls: html: https://url.com/a_summary_of_credit_terms_asset_token4321.html pdf: https://url.com/a_summary_of_credit_terms_asset_token4321.pdf png: https://url.com/a_summary_of_credit_terms_asset_token4321.png template_token: a_summary_of_credit_terms_template_token4321 template_urls: html: https://url.com/a_summary_of_credit_terms_template_token4321.html terms_schedule: template_token: a_terms_schedule_template_token4321 template_urls: html: https://url.com/a_terms_schedule_template_token4321.html token: my_document_policy_token_4321 updated_time: 2025-04-05T16:04:48.643Z document_policy_token: my_document_policy_token_4321 fee_policy_detail: account: foreign_transaction_fee: default_method: PERCENTAGE default_value: 12.5 late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2025-04-01T23:41:58.802Z description: A silver fee policy name: Silver Fee Policy token: my_fee_policy_token_4321 updated_time: 2025-04-05T16:04:48.643Z fee_policy_token: my_fee_policy_token_4321 name: Silver Credit Bundle offer_policy_detail: created_time: 2024-04-01T23:41:58.802Z description: A silver offer policy name: Silver Offer Policy token: my_offer_policy_token_4321 updated_time: 2024-04-05T16:04:48.643Z offer_policy_token: my_offer_policy_token_4321 parent_token: my_parent_token_4321 reward_policy_detail: accrual_strategy: DEFAULT conversions: - conversion_increment: 10 conversion_rate: 0.001 currency: USD type: STATEMENT_CREDIT created_time: 2025-04-01T23:41:58.802Z description: A gold reward policy exclusions: custom_exclusions: - 2000-2999 - '4321' use_default_exclusions: false name: Gold Reward Policy redemption_strategy: MANUAL rounding_strategy: ROUND_HALF_EVEN rules: - amount: null attributes: mcc: - 0001-1499 - '1500' calculation_type: PER_TRANSACTION description: Earn 3x on selected categories. multiplier: 3 type: MULTIPLIER_PER_TRANSACTION settlement_strategy: STATEMENT token: my_reward_policy_token_4321 updated_time: 2025-04-05T16:04:48.643Z reward_policy_token: my_reward_policy_token_4321 status: DRAFT token: my_bundle_token_4321 updated_time: 2024-04-05T16:04:48.643Z end_index: 2 is_more: true start_index: 0 schema: $ref: '#/components/schemas/BundleResponsePage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List bundles tags: - Bundles post: description: Create a bundle. operationId: createBundle parameters: [ ] requestBody: content: application/json: example: apr_policy_token: my_apr_policy_token_1234 credit_product_policy_token: my_credit_product_policy_token_1234 description: A gold credit bundle policy document_policy_token: my_document_policy_token_1234 fee_policy_token: my_fee_policy_token_1234 name: Gold Credit Bundle offer_policy_token: my_offer_policy_token_1234 reward_policy_token: my_reward_policy_token_1234 status: DRAFT token: my_bundle_token_1234 schema: $ref: '#/components/schemas/BundleCreateReq' required: true responses: '201': content: application/json: example: apr_policy_detail: created_time: 2025-04-01T23:41:58.802Z description: A gold APR policy effective_date: 2025-05-01 name: Gold APR Policy purchases: external_token: my_external_purchase_token1234 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 1 - apr: 0 margin_rate: 5 token: my_apr_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z apr_policy_token: my_apr_policy_token_1234 created_time: 2025-04-01T23:41:58.802Z credit_product_policy_detail: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER created_time: 2025-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A gold credit product policy interest_calculation: application_of_credits: cycle_type: END_REVOLVING day: 15 day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_PAYMENT_DATE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 name: Gold Credit Product Policy payments: allocation_order: - INTEREST - FEES - PRINCIPAL billing_cycle_day: 1 due_day: 31 min_payment_calculation: include_overlimit_amount: true include_past_due_amount: false min_payment_flat_amount: 20 min_payment_percentage: include_fees_charged: - LATE_PAYMENT_FEE include_interest_charged: false percentage_of_balance: 1 product_sub_type: CREDIT_CARD product_type: REVOLVING token: my_credit_product_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z usage: - PURCHASE credit_product_policy_token: my_credit_product_policy_token_1234 description: A gold credit bundle policy document_policy_detail: account_statement: template_token: an_account_statement_template_token1234 template_urls: html: https://url.com/an_account_statement_template_token1234.html benefits_disclosure: asset_token: a_benefits_disclosure_asset_token1234 asset_urls: html: https://url.com/a_benefits_disclosure_asset_token1234.html pdf: https://url.com/a_benefits_disclosure_asset_token1234.pdf png: https://url.com/a_benefits_disclosure_asset_token1234.png card_member_agreement: asset_token: a_card_member_agreement_asset_token1234 asset_urls: html: https://url.com/a_card_member_agreement_asset_token1234.html pdf: https://url.com/a_card_member_agreement_asset_token1234.pdf png: https://url.com/a_card_member_agreement_asset_token1234.png created_time: 2025-04-01T23:41:58.802Z e_disclosure: asset_token: a_e_disclosure_asset_token1234 asset_urls: html: https://url.com/a_e_disclosure_asset_token1234.html pdf: https://url.com/a_e_disclosure_asset_token1234.pdf png: https://url.com/a_e_disclosure_asset_token1234.png name: My Document Policy notice_of_adverse_action: template_token: a_notice_of_adverse_action_template_token1234 template_urls: html: https://url.com/a_notice_of_adverse_action_template_token1234.html privacy_policy: asset_token: a_privacy_policy_asset_token1234 asset_urls: html: https://url.com/a_privacy_policy_asset_token1234.html pdf: https://url.com/a_privacy_policy_asset_token1234.pdf png: https://url.com/a_privacy_policy_asset_token1234.png rewards_disclosure: asset_token: a_rewards_disclosure_asset_token1234 asset_urls: html: https://url.com/a_rewards_disclosure_asset_token1234.html pdf: https://url.com/a_rewards_disclosure_asset_token1234.pdf png: https://url.com/a_rewards_disclosure_asset_token1234.png template_token: a_rewards_disclosure_template_token1234 template_urls: html: https://url.com/a_rewards_disclosure_template_token1234.html summary_of_credit_terms: asset_token: a_summary_of_credit_terms_asset_token1234 asset_urls: html: https://url.com/a_summary_of_credit_terms_asset_token1234.html pdf: https://url.com/a_summary_of_credit_terms_asset_token1234.pdf png: https://url.com/a_summary_of_credit_terms_asset_token1234.png template_token: a_summary_of_credit_terms_template_token1234 template_urls: html: https://asset-bucket.s3.amazonaws.com/short_code/a_summary_of_credit_terms_template_token1234/a_summary_of_credit_terms_template_token1234.html terms_schedule: template_token: a_terms_schedule_template_token1234 template_urls: html: https://url.com/a_terms_schedule_template_token1234.html token: my_document_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z document_policy_token: my_document_policy_token_1234 fee_policy_detail: account: foreign_transaction_fee: default_method: PERCENTAGE default_value: 12.5 late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2025-04-01T23:41:58.802Z description: A gold fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z fee_policy_token: my_fee_policy_token_1234 name: Gold Credit Bundle offer_policy_detail: created_time: 2025-04-01T23:41:58.802Z description: A gold offer policy name: Gold Offer Policy token: my_offer_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z offer_policy_token: my_offer_policy_token_1234 parent_token: my_parent_token_1234 reward_policy_detail: accrual_strategy: DEFAULT conversions: - conversion_increment: 10 conversion_rate: 0.001 currency: USD type: STATEMENT_CREDIT created_time: 2025-04-01T23:41:58.802Z description: A gold reward policy exclusions: custom_exclusions: - 2000-2999 - '4321' use_default_exclusions: false name: Gold Reward Policy redemption_strategy: MANUAL rounding_strategy: ROUND_HALF_EVEN rules: - amount: null attributes: mcc: - 0001-1499 - '1500' calculation_type: PER_TRANSACTION description: Earn 3x on selected categories. multiplier: 3 type: MULTIPLIER_PER_TRANSACTION settlement_strategy: STATEMENT token: my_reward_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z reward_policy_token: my_reward_policy_token_1234 status: DRAFT token: my_bundle_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/BundleResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create bundle tags: - Bundles /bundles/{token}: get: description: Retrieve a specific bundle. operationId: retrieveBundle parameters: - description: |- Unique identifier of the bundle to retrieve. Send a `GET` request to `/credit/bundles` to retrieve existing tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing bundle token style: simple - description: |- Embeds the associated object of the specified type into the response. For more, see <>. explode: true in: query name: expand_objects required: false schema: items: $ref: '#/components/schemas/PolicyType' maxItems: 5 type: array style: form responses: '200': content: application/json: example: apr_policy_detail: created_time: 2025-04-01T23:41:58.802Z description: A gold APR policy effective_date: 2025-05-01 name: Gold APR Policy purchases: external_token: my_external_purchase_token1234 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 1 - apr: 0 margin_rate: 5 token: my_apr_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z apr_policy_token: my_apr_policy_token_1234 created_time: 2025-04-01T23:41:58.802Z credit_product_policy_detail: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER created_time: 2025-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A gold credit product policy interest_calculation: application_of_credits: cycle_type: END_REVOLVING day: 15 day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_PAYMENT_DATE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 name: Gold Credit Product Policy payments: allocation_order: - INTEREST - FEES - PRINCIPAL billing_cycle_day: 1 due_day: 31 min_payment_calculation: include_overlimit_amount: true include_past_due_amount: false min_payment_flat_amount: 20 min_payment_percentage: include_fees_charged: - LATE_PAYMENT_FEE include_interest_charged: false percentage_of_balance: 1 product_sub_type: CREDIT_CARD product_type: REVOLVING token: my_credit_product_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z usage: - PURCHASE credit_product_policy_token: my_credit_product_policy_token_1234 description: A gold credit bundle document_policy_detail: account_statement: template_token: an_account_statement_template_token1234 template_urls: html: https://url.com/an_account_statement_template_token1234.html benefits_disclosure: asset_token: a_benefits_disclosure_asset_token1234 asset_urls: html: https://url.com/a_benefits_disclosure_asset_token1234.html pdf: https://url.com/a_benefits_disclosure_asset_token1234.pdf png: https://url.com/a_benefits_disclosure_asset_token1234.png card_member_agreement: asset_token: a_card_member_agreement_asset_token1234 asset_urls: html: https://url.com/a_card_member_agreement_asset_token1234.html pdf: https://url.com/a_card_member_agreement_asset_token1234.pdf png: https://url.com/a_card_member_agreement_asset_token1234.png created_time: 2025-04-01T23:41:58.802Z e_disclosure: asset_token: a_e_disclosure_asset_token1234 asset_urls: html: https://url.com/a_e_disclosure_asset_token1234.html pdf: https://url.com/a_e_disclosure_asset_token1234.pdf png: https://url.com/a_e_disclosure_asset_token1234.png name: My Document Policy notice_of_adverse_action: template_token: a_notice_of_adverse_action_template_token1234 template_urls: html: https://url.com/a_notice_of_adverse_action_template_token1234.html privacy_policy: asset_token: a_privacy_policy_asset_token1234 asset_urls: html: https://url.com/a_privacy_policy_asset_token1234.html pdf: https://url.com/a_privacy_policy_asset_token1234.pdf png: https://url.com/a_privacy_policy_asset_token1234.png rewards_disclosure: asset_token: a_rewards_disclosure_asset_token1234 asset_urls: html: https://url.com/a_rewards_disclosure_asset_token1234.html pdf: https://url.com/a_rewards_disclosure_asset_token1234.pdf png: https://url.com/a_rewards_disclosure_asset_token1234.png template_token: a_rewards_disclosure_template_token1234 template_urls: html: https://url.com/a_rewards_disclosure_template_token1234.html summary_of_credit_terms: asset_token: a_summary_of_credit_terms_asset_token1234 asset_urls: html: https://url.com/a_summary_of_credit_terms_asset_token1234.html pdf: https://url.com/a_summary_of_credit_terms_asset_token1234.pdf png: https://url.com/a_summary_of_credit_terms_asset_token1234.png template_token: a_summary_of_credit_terms_template_token1234 template_urls: html: https://asset-bucket.s3.amazonaws.com/short_code/a_summary_of_credit_terms_template_token1234/a_summary_of_credit_terms_template_token1234.html terms_schedule: template_token: a_terms_schedule_template_token1234 template_urls: html: https://url.com/a_terms_schedule_template_token1234.html token: my_document_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z document_policy_token: my_document_policy_token_1234 fee_policy_detail: account: foreign_transaction_fee: default_method: PERCENTAGE default_value: 3 late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2025-04-01T23:41:58.802Z description: A gold fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z fee_policy_token: my_fee_policy_token_1234 name: Gold Credit Bundle offer_policy_detail: created_time: 2025-04-01T23:41:58.802Z description: A gold offer policy name: Gold Offer Policy token: my_offer_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z offer_policy_token: my_offer_policy_token_1234 parent_token: my_parent_token_1234 reward_policy_detail: accrual_strategy: DEFAULT conversions: - conversion_increment: 10 conversion_rate: 0.001 currency: USD type: STATEMENT_CREDIT created_time: 2025-04-01T23:41:58.802Z description: A gold reward policy exclusions: custom_exclusions: - 2000-2999 - '4321' use_default_exclusions: false name: Gold Reward Policy redemption_strategy: MANUAL rounding_strategy: ROUND_HALF_EVEN rules: - amount: null attributes: mcc: - 0001-1499 - '1500' calculation_type: PER_TRANSACTION description: Earn 3x on selected categories. multiplier: 3 type: MULTIPLIER_PER_TRANSACTION settlement_strategy: STATEMENT token: my_reward_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z reward_policy_token: my_reward_policy_token_1234 status: DRAFT token: my_bundle_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/BundleResponse' description: A JSON object containing bundle information default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve bundle tags: - Bundles put: description: |- Update a specific bundle that is not `ACTIVE` or `ARCHIVED`. Bundles are created in a `DRAFT` state, and are still modifiable at this point. Using the transitions endpoint, a bundle can be transitioned from `DRAFT`, to `ACTIVE`. Once a bundle is active, it cannot be modified. operationId: updateBundle parameters: - description: |- Token of the bundle to update. Send a `GET` request to `/credit/bundles` to retrieve existing tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing bundle token style: simple requestBody: content: application/json: example: apr_policy_token: my_apr_policy_token_1234 credit_product_policy_token: my_credit_product_policy_token_1234 description: Description of the renamed bundle document_policy_token: my_document_policy_token_1234 fee_policy_token: my_fee_policy_token_1234 name: Renamed Bundle offer_policy_token: my_offer_policy_token_1234 reward_policy_token: my_reward_policy_token_1234 token: my_bundle_token_1234 schema: $ref: '#/components/schemas/BundleUpdateReq' required: true responses: '200': content: application/json: example: apr_policy_detail: created_time: 2025-04-01T23:41:58.802Z description: A gold APR policy effective_date: 2025-05-01 name: Gold APR Policy purchases: external_token: my_external_purchase_token1234 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 1 - apr: 0 margin_rate: 5 token: my_apr_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z apr_policy_token: my_apr_policy_token_1234 created_time: 2025-04-01T23:41:58.802Z credit_product_policy_detail: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER created_time: 2025-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A gold credit product policy interest_calculation: application_of_credits: cycle_type: END_REVOLVING day: 15 day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_PAYMENT_DATE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 name: Gold Credit Product Policy payments: allocation_order: - INTEREST - FEES - PRINCIPAL billing_cycle_day: 1 due_day: 31 min_payment_calculation: include_overlimit_amount: true include_past_due_amount: false min_payment_flat_amount: 20 min_payment_percentage: include_fees_charged: - LATE_PAYMENT_FEE include_interest_charged: false percentage_of_balance: 1 product_sub_type: CREDIT_CARD product_type: REVOLVING token: my_credit_product_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z usage: - PURCHASE credit_product_policy_token: my_credit_product_policy_token_1234 description: Description of the renamed bundle document_policy_detail: account_statement: template_token: an_account_statement_template_token1234 template_urls: html: https://url.com/an_account_statement_template_token1234.html benefits_disclosure: asset_token: a_benefits_disclosure_asset_token1234 asset_urls: html: https://url.com/a_benefits_disclosure_asset_token1234.html pdf: https://url.com/a_benefits_disclosure_asset_token1234.pdf png: https://url.com/a_benefits_disclosure_asset_token1234.png card_member_agreement: asset_token: a_card_member_agreement_asset_token1234 asset_urls: html: https://url.com/a_card_member_agreement_asset_token1234.html pdf: https://url.com/a_card_member_agreement_asset_token1234.pdf png: https://url.com/a_card_member_agreement_asset_token1234.png created_time: 2025-04-01T23:41:58.802Z e_disclosure: asset_token: a_e_disclosure_asset_token1234 asset_urls: html: https://url.com/a_e_disclosure_asset_token1234.html pdf: https://url.com/a_e_disclosure_asset_token1234.pdf png: https://url.com/a_e_disclosure_asset_token1234.png name: My Document Policy notice_of_adverse_action: template_token: a_notice_of_adverse_action_template_token1234 template_urls: html: https://url.com/a_notice_of_adverse_action_template_token1234.html privacy_policy: asset_token: a_privacy_policy_asset_token1234 asset_urls: html: https://url.com/a_privacy_policy_asset_token1234.html pdf: https://url.com/a_privacy_policy_asset_token1234.pdf png: https://url.com/a_privacy_policy_asset_token1234.png rewards_disclosure: asset_token: a_rewards_disclosure_asset_token1234 asset_urls: html: https://url.com/a_rewards_disclosure_asset_token1234.html pdf: https://url.com/a_rewards_disclosure_asset_token1234.pdf png: https://url.com/a_rewards_disclosure_asset_token1234.png template_token: a_rewards_disclosure_template_token1234 template_urls: html: https://url.com/a_rewards_disclosure_template_token1234.html summary_of_credit_terms: asset_token: a_summary_of_credit_terms_asset_token1234 asset_urls: html: https://url.com/a_summary_of_credit_terms_asset_token1234.html pdf: https://url.com/a_summary_of_credit_terms_asset_token1234.pdf png: https://url.com/a_summary_of_credit_terms_asset_token1234.png template_token: a_summary_of_credit_terms_template_token1234 template_urls: html: https://asset-bucket.s3.amazonaws.com/short_code/a_summary_of_credit_terms_template_token1234/a_summary_of_credit_terms_template_token1234.html terms_schedule: template_token: a_terms_schedule_template_token1234 template_urls: html: https://url.com/a_terms_schedule_template_token1234.html token: my_document_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z document_policy_token: my_document_policy_token_1234 fee_policy_detail: account: foreign_transaction_fee: default_method: PERCENTAGE default_value: 3 late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2025-04-01T23:41:58.802Z description: A gold fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z fee_policy_token: my_fee_policy_token_1234 name: Renamed Bundle offer_policy_detail: created_time: 2025-04-01T23:41:58.802Z description: A gold offer policy name: Gold Offer Policy token: my_offer_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z offer_policy_token: my_offer_policy_token_1234 parent_token: my_parent_token_1234 reward_policy_detail: accrual_strategy: DEFAULT conversions: - conversion_increment: 10 conversion_rate: 0.001 currency: USD type: STATEMENT_CREDIT created_time: 2025-04-01T23:41:58.802Z description: A gold reward policy exclusions: custom_exclusions: - 2000-2999 - '4321' use_default_exclusions: false name: Gold Reward Policy redemption_strategy: MANUAL rounding_strategy: ROUND_HALF_EVEN rules: - amount: null attributes: mcc: - 0001-1499 - '1500' calculation_type: PER_TRANSACTION description: Earn 3x on selected categories. multiplier: 3 type: MULTIPLIER_PER_TRANSACTION settlement_strategy: STATEMENT token: my_reward_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z reward_policy_token: my_reward_policy_token_1234 status: DRAFT token: my_bundle_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/BundleResponse' description: A JSON object containing bundle information. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Update bundle tags: - Bundles /bundles/{token}/clone: post: description: Create a new bundle based on an existing bundle. operationId: cloneBundle parameters: - description: |- Unique identifier of the bundle to clone. Send a `GET` request to `/bundles` to retrieve existing bundle tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing bundle token style: simple responses: '201': content: application/json: example: apr_policy_detail: created_time: 2025-05-01T23:41:58.802Z description: A gold APR policy effective_date: 2025-05-01 name: Gold APR Policy purchases: external_token: my_external_purchase_token1234 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 1 - apr: 0 margin_rate: 5 token: my_apr_policy_token_1234 updated_time: 2025-05-05T16:04:48.643Z apr_policy_token: my_apr_policy_token_1234 created_time: 2025-04-01T23:41:58.802Z credit_product_policy_detail: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER created_time: 2025-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A gold credit product policy interest_calculation: application_of_credits: cycle_type: END_REVOLVING day: 15 day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_PAYMENT_DATE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 name: Gold Credit Product Policy payments: allocation_order: - INTEREST - FEES - PRINCIPAL billing_cycle_day: 1 due_day: 31 min_payment_calculation: include_overlimit_amount: true include_past_due_amount: false min_payment_flat_amount: 20 min_payment_percentage: include_fees_charged: - LATE_PAYMENT_FEE include_interest_charged: false percentage_of_balance: 1 product_sub_type: CREDIT_CARD product_type: REVOLVING token: my_credit_product_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z usage: - PURCHASE credit_product_policy_token: my_credit_product_policy_token_1234 description: A gold credit bundle document_policy_detail: account_statement: template_token: an_account_statement_template_token1234 template_urls: html: https://url.com/an_account_statement_template_token1234.html benefits_disclosure: asset_token: a_benefits_disclosure_asset_token1234 asset_urls: html: https://url.com/a_benefits_disclosure_asset_token1234.html pdf: https://url.com/a_benefits_disclosure_asset_token1234.pdf png: https://url.com/a_benefits_disclosure_asset_token1234.png card_member_agreement: asset_token: a_card_member_agreement_asset_token1234 asset_urls: html: https://url.com/a_card_member_agreement_asset_token1234.html pdf: https://url.com/a_card_member_agreement_asset_token1234.pdf png: https://url.com/a_card_member_agreement_asset_token1234.png created_time: 2025-04-01T23:41:58.802Z e_disclosure: asset_token: a_e_disclosure_asset_token1234 asset_urls: html: https://url.com/a_e_disclosure_asset_token1234.html pdf: https://url.com/a_e_disclosure_asset_token1234.pdf png: https://url.com/a_e_disclosure_asset_token1234.png name: My Document Policy notice_of_adverse_action: template_token: a_notice_of_adverse_action_template_token1234 template_urls: html: https://url.com/a_notice_of_adverse_action_template_token1234.html privacy_policy: asset_token: a_privacy_policy_asset_token1234 asset_urls: html: https://url.com/a_privacy_policy_asset_token1234.html pdf: https://url.com/a_privacy_policy_asset_token1234.pdf png: https://url.com/a_privacy_policy_asset_token1234.png rewards_disclosure: asset_token: a_rewards_disclosure_asset_token1234 asset_urls: html: https://url.com/a_rewards_disclosure_asset_token1234.html pdf: https://url.com/a_rewards_disclosure_asset_token1234.pdf png: https://url.com/a_rewards_disclosure_asset_token1234.png template_token: a_rewards_disclosure_template_token1234 template_urls: html: https://url.com/a_rewards_disclosure_template_token1234.html summary_of_credit_terms: asset_token: a_summary_of_credit_terms_asset_token1234 asset_urls: html: https://url.com/a_summary_of_credit_terms_asset_token1234.html pdf: https://url.com/a_summary_of_credit_terms_asset_token1234.pdf png: https://url.com/a_summary_of_credit_terms_asset_token1234.png template_token: a_summary_of_credit_terms_template_token1234 template_urls: html: https://asset-bucket.s3.amazonaws.com/short_code/a_summary_of_credit_terms_template_token1234/a_summary_of_credit_terms_template_token1234.html terms_schedule: template_token: a_terms_schedule_template_token1234 template_urls: html: https://url.com/a_terms_schedule_template_token1234.html token: my_document_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z document_policy_token: my_document_policy_token_1234 fee_policy_detail: account: foreign_transaction_fee: default_method: PERCENTAGE default_value: 12.5 late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2025-04-01T23:41:58.802Z description: A gold fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z fee_policy_token: my_fee_policy_token_1234 name: Gold Credit Bundle offer_policy_detail: created_time: 2025-04-01T23:41:58.802Z description: A gold offer policy name: Gold Offer Policy token: my_offer_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z offer_policy_token: my_offer_policy_token_1234 parent_token: my_parent_token_1234 reward_policy_detail: accrual_strategy: DEFAULT created_time: 2025-04-01T23:41:58.802Z description: A gold reward policy name: Gold Reward Policy redemption_strategy: MANUAL rounding_strategy: ROUND_HALF_EVEN rules: - amount: null attributes: mcc: - 0001-1499 - '1500' calculation_type: PER_TRANSACTION description: Earn 3x on selected categories. multiplier: 3 type: MULTIPLIER_PER_TRANSACTION settlement_strategy: STATEMENT token: my_reward_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z reward_policy_token: my_reward_policy_token_1234 status: DRAFT token: my_bundle_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/BundleResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Clone bundle tags: - Bundles /bundles/{token}/lineage: get: description: |- Retrieve an array of related product bundles. This endpoint supports <>. operationId: listRelatedBundles parameters: - description: |- Unique identifier of the parent product bundle. Send a `GET` request to `/bundles` to retrieve existing product bundles tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing bundle token style: simple - description: Number of related bundle product resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form - description: Array of statuses by which to filter bundles. explode: true in: query name: status required: false schema: items: $ref: '#/components/schemas/BundleResourceStatus' type: array style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/BundleResponsePage' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List related bundles tags: - Bundles /bundles/{token}/promote: put: description: Promote a specific bundle that replaces the current active bundle and activates the promoted bundle. operationId: promoteBundle parameters: - description: |- Unique identifier of the bundle to promote. Send a `GET` request to `/bundles` to retrieve existing bundle tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing bundle token style: simple responses: '200': content: application/json: example: apr_policy_detail: created_time: 2025-04-01T23:41:58.802Z description: A silver APR policy effective_date: 2025-06-01 name: Silver APR Policy purchases: external_token: my_external_purchase_token4321 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 3 - apr: 0 margin_rate: 6 token: my_apr_policy_token_4321 updated_time: 2025-04-05T16:04:48.643Z apr_policy_token: my_apr_policy_token_4321 created_time: 2025-04-01T23:41:58.802Z credit_product_policy_detail: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token4321 classification: CONSUMER created_time: 2025-04-01T23:41:58.802Z credit_line: max: 3100 min: 50 currency_code: USD description: A silver credit product policy interest_calculation: application_of_credits: cycle_type: END_REVOLVING day: 15 day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_PAYMENT_DATE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 name: Silver Credit Product Policy payments: allocation_order: - INTEREST - FEES - PRINCIPAL billing_cycle_day: 1 due_day: 31 min_payment_calculation: include_overlimit_amount: true include_past_due_amount: false min_payment_flat_amount: 20 min_payment_percentage: include_fees_charged: - LATE_PAYMENT_FEE include_interest_charged: false percentage_of_balance: 1 product_sub_type: CREDIT_CARD product_type: REVOLVING token: my_credit_product_policy_token_4321 updated_time: 2025-04-05T16:04:48.643Z usage: - PURCHASE credit_product_policy_token: my_credit_product_policy_token_4321 description: A silver document_policy_detail: account_statement: template_token: an_account_statement_template_token4321 template_urls: html: https://url.com/an_account_statement_template_token4321.html benefits_disclosure: asset_token: a_benefits_disclosure_asset_token4321 asset_urls: html: https://url.com/a_benefits_disclosure_asset_token4321.html pdf: https://url.com/a_benefits_disclosure_asset_token4321.pdf png: https://url.com/a_benefits_disclosure_asset_token4321.png card_member_agreement: asset_token: a_card_member_agreement_asset_token4321 asset_urls: html: https://url.com/a_card_member_agreement_asset_token4321.html pdf: https://url.com/a_card_member_agreement_asset_token4321.pdf png: https://url.com/a_card_member_agreement_asset_token4321.png created_time: 2025-04-01T23:41:58.802Z e_disclosure: asset_token: a_e_disclosure_asset_token4321 asset_urls: html: https://url.com/a_e_disclosure_asset_token4321.html pdf: https://url.com/a_e_disclosure_asset_token4321.pdf png: https://url.com/a_e_disclosure_asset_token4321.png name: My Document Policy notice_of_adverse_action: template_token: a_notice_of_adverse_action_template_token4321 template_urls: html: https://url.com/a_notice_of_adverse_action_template_token4321.html privacy_policy: asset_token: a_privacy_policy_asset_token4321 asset_urls: html: https://url.com/a_privacy_policy_asset_token4321.html pdf: https://url.com/a_privacy_policy_asset_token4321.pdf png: https://url.com/a_privacy_policy_asset_token4321.png rewards_disclosure: asset_token: a_rewards_disclosure_asset_token4321 asset_urls: html: https://url.com/a_rewards_disclosure_asset_token4321.html pdf: https://url.com/a_rewards_disclosure_asset_token4321.pdf png: https://url.com/a_rewards_disclosure_asset_token4321.png template_token: a_rewards_disclosure_template_token4321 template_urls: html: https://url.com/a_rewards_disclosure_template_token4321.html summary_of_credit_terms: asset_token: a_summary_of_credit_terms_asset_token4321 asset_urls: html: https://url.com/a_summary_of_credit_terms_asset_token4321.html pdf: https://url.com/a_summary_of_credit_terms_asset_token4321.pdf png: https://url.com/a_summary_of_credit_terms_asset_token4321.png template_token: a_summary_of_credit_terms_template_token4321 template_urls: html: https://url.com/a_summary_of_credit_terms_template_token4321.html terms_schedule: template_token: a_terms_schedule_template_token4321 template_urls: html: https://url.com/a_terms_schedule_template_token4321.html token: my_document_policy_token_4321 updated_time: 2025-04-05T16:04:48.643Z document_policy_token: my_document_policy_token_4321 fee_policy_detail: account: foreign_transaction_fee: default_method: PERCENTAGE default_value: 12.5 late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2025-04-01T23:41:58.802Z description: A silver fee policy name: Silver Fee Policy token: my_fee_policy_token_4321 updated_time: 2025-04-05T16:04:48.643Z fee_policy_token: my_fee_policy_token_4321 name: Silver Credit Bundle offer_policy_detail: created_time: 2025-04-01T23:41:58.802Z description: A silver offer policy name: Silver Offer Policy token: my_offer_policy_token_4321 updated_time: 2025-04-05T16:04:48.643Z offer_policy_token: my_offer_policy_token_4321 parent_token: my_parent_token_4321 reward_policy_detail: accrual_strategy: DEFAULT created_time: 2025-04-01T23:41:58.802Z description: A gold reward policy name: Gold Reward Policy redemption_strategy: MANUAL rounding_strategy: ROUND_HALF_EVEN rules: - amount: null attributes: mcc: - 0001-1499 - '1500' calculation_type: PER_TRANSACTION description: Earn 3x on selected categories. multiplier: 3 type: MULTIPLIER_PER_TRANSACTION settlement_strategy: STATEMENT token: my_reward_policy_token_4321 updated_time: 2025-04-05T16:04:48.643Z reward_policy_token: my_reward_policy_token_4321 status: DRAFT token: my_bundle_token_4321 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/BundleResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Promote bundle tags: - Bundles /bundles/{token}/transitions: post: description: Transition the status of a specific bundle. operationId: transitionBundle parameters: - description: |- Token of the bundle whose status you want to transition. Send a `GET` request to `/credit/bundles` to retrieve existing tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing bundle token style: simple requestBody: content: application/json: example: status: PENDING_APPROVAL schema: $ref: '#/components/schemas/BundleTransitionReq' required: true responses: '201': content: application/json: example: bundle_token: my_bundle_token_1234 created_time: 2025-06-04T05:59:14.979Z original_status: DRAFT status: PENDING_APPROVAL token: my_transition_token_1234 schema: $ref: '#/components/schemas/BundleTransitionResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Transition a bundle tags: - Bundles /businesses: get: operationId: getBusinesses parameters: - description: Number of users to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Business name DBA explode: true in: query name: business_name_dba required: false schema: type: string style: form - description: Business name legal explode: true in: query name: business_name_legal required: false schema: type: string style: form - description: Search type explode: true in: query name: search_type required: false schema: type: string style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/BusinessCardHolderListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all businesses tags: - businesses post: operationId: postBusinesses requestBody: content: application/json: schema: $ref: '#/components/schemas/business_cardholder' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/business_card_holder_response' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Request already processed with a different payload '500': content: { } description: Server error summary: Creates a business tags: - businesses /businesses/lookup: post: operationId: postBusinessesLookup requestBody: content: application/json: schema: $ref: '#/components/schemas/DDARequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/business_cardholder' description: Success '404': content: { } description: Business not found '500': content: { } description: Server error summary: Returns a specific business tags: - businesses /businesses/{business_token}/directors: post: operationId: postBusinessesTokenDirectors parameters: - description: Business token explode: false in: path name: business_token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/business_director_request_model' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/cardholder_note_response_model' description: Success '400': content: { } description: Bad request '401': content: { } description: Unauthorized '403': content: { } description: Forbidden '500': content: { } description: Server error summary: Creates a BusinessDirector for a business tags: - businesses /businesses/{business_token}/directors/{token}: get: operationId: getBusinessDirectorToken parameters: - description: Business token explode: false in: path name: business_token required: true schema: type: string style: simple - description: Business Director token explode: false in: path name: token required: true schema: type: string style: simple - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/business_director_request_model' description: Success '400': content: { } description: Bad request '404': content: { } description: Business Director not found '500': content: { } description: Server error summary: Returns a specific business director tags: - businesses put: operationId: putBusinessesTokenBusinessDirectorToken parameters: - description: Business token explode: false in: path name: business_token required: true schema: type: string style: simple - description: Business Director token explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/business_director_request_model' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/business_director_response_model' description: Success '400': content: { } description: Bad request '401': content: { } description: Unauthorized '403': content: { } description: Forbidden '500': content: { } description: Server error summary: Updates a specific business director for a business tags: - businesses /businesses/{business_token}/directors/{token}/identifications: get: operationId: getBusinessDirectorTokenSsn parameters: - description: Business token explode: false in: path name: business_token required: true schema: type: string style: simple - description: Business Director token explode: false in: path name: token required: true schema: type: string style: simple - explode: true in: query name: full_ssn required: false schema: type: boolean style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ssn_response_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Returns a specific business director's SSN tags: - businesses /businesses/{parent_token}/children: get: operationId: getBusinessesParenttokenChildren parameters: - description: Number of users to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Token of parent business explode: false in: path name: parent_token required: true schema: type: string style: simple - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/BusinessUserCardHolderListResponse' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Lists all children of a parent business tags: - businesses /businesses/{token}: get: operationId: getBusinessesToken parameters: - description: Business token explode: false in: path name: token required: true schema: type: string style: simple - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/business_card_holder_response' description: Success '400': content: { } description: Bad request '404': content: { } description: Business not found '500': content: { } description: Server error summary: Returns a specific business tags: - businesses put: operationId: putBusinessesToken parameters: - description: Business token explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/business_card_holder_update' description: Business object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/business_cardholder' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Updates a specific business tags: - businesses /businesses/{token}/notes: get: operationId: getBusinessesTokenNotes parameters: - description: Business token explode: false in: path name: token required: true schema: type: string style: simple - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Number of notes to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Created by explode: true in: query name: created_by required: false schema: type: string style: form - description: Comma-delimited list of created by user roles explode: true in: query name: created_by_user_role required: false schema: type: string style: form - description: Include private notes and private fields in note response explode: true in: query name: include_private required: false schema: type: boolean style: form - description: Search type explode: true in: query name: search_type required: false schema: type: string style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/CardHolderNoteListResponse' description: Success '400': content: { } description: Bad request '401': content: { } description: Unauthorized '403': content: { } description: Forbidden '404': content: { } description: Business not found '500': content: { } description: Server error summary: Lists business notes tags: - businesses post: operationId: postBusinessesTokenNotes parameters: - description: Business token explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/cardholder_note_request_model' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/cardholder_note_response_model' description: Success '400': content: { } description: Bad request '401': content: { } description: Unauthorized '403': content: { } description: Forbidden '500': content: { } description: Server error summary: Creates a note for a business tags: - businesses /businesses/{token}/notes/{notes_token}: put: operationId: putBusinessesTokenNotesNotestoken parameters: - description: Business token explode: false in: path name: token required: true schema: type: string style: simple - description: Notes token explode: false in: path name: notes_token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/cardholder_note_update_request_model' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/cardholder_note_response_model' description: Success '400': content: { } description: Bad request '401': content: { } description: Unauthorized '403': content: { } description: Forbidden '500': content: { } description: Server error summary: Updates a specific note for a business tags: - businesses /businesses/{token}/ssn: get: operationId: getBusinessesTokenSsn parameters: - description: Business token explode: false in: path name: token required: true schema: type: string style: simple - explode: true in: query name: full_ssn required: false schema: type: boolean style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ssn_response_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Returns a specific business proprietor's SSN tags: - businesses /businesstransitions: post: operationId: postBusinesstransitions requestBody: content: application/json: schema: $ref: '#/components/schemas/BusinessTransitionRequest' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/BusinessTransitionResponse' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Request already processed with a different payload '412': content: { } description: Pre-condition setup issue '500': content: { } description: Server error summary: Creates a business transition tags: - business transitions /businesstransitions/business/{business_token}: get: operationId: getBusinesstransitionsBusinessBusinesstoken parameters: - description: Business token explode: false in: path name: business_token required: true schema: type: string style: simple - description: Number of business transitions to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -id type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/BusinessTransitionListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Returns transitions for a given business tags: - business transitions /businesstransitions/{token}: get: operationId: getBusinesstransitionsToken parameters: - description: Transition token explode: false in: path name: token required: true schema: type: string style: simple - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/BusinessTransitionResponse' description: Success '400': content: { } description: Bad request '404': content: { } description: Cardholder not found '500': content: { } description: Server error summary: Returns a business transition tags: - business transitions /cardgroups: get: description: Get a list of all card groups in the program operationId: listCardGroups parameters: - description: list of unique card identifiers to retrieve. explode: true in: query name: card_tokens required: false schema: items: type: string type: array style: form - description: Number of card group resources to retrieve. explode: true in: query name: count required: false schema: maximum: 10 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: minimum: 0 type: integer style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/CardGroupPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: List Card Groups tags: - Card Group post: description: Create a new card group object operationId: createCardGroup parameters: [ ] requestBody: content: application/json: schema: $ref: '#/components/schemas/CardGroupReq' description: Card group to create. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/CardGroup' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Create Card Group tags: - Card Group /cardgroups/{token}: get: description: Retrieves the Card Group with the given token operationId: retrieveCardGroup parameters: - description: Unique identifier of the card group to retrieve explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/CardGroup' description: A JSON object containing `card_group` information. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Retrieve Card Group tags: - Card Group /cardproducts: get: operationId: getCardproducts parameters: - description: Number of items to retrieve. Count can be between 1 - 10 items. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Indicates from what row to start returning data. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -createdTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/CardProductListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all card products tags: - card products post: operationId: postCardproducts requestBody: content: application/json: schema: $ref: '#/components/schemas/card_product_request' description: Card product object required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/card_product_response' description: Created '400': content: { } description: Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Creates a card product tags: - card products /cardproducts/{token}: get: operationId: getCardproductsToken parameters: - description: Card product token explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_product_response' description: Success '400': content: { } description: Bad request '404': content: { } description: Card product not found '500': content: { } description: Server error summary: Returns a specific card product tags: - card products put: operationId: putCardproductsToken parameters: - description: Card product token explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/card_product_update_model' description: Card product object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_product_response' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Updates a specific card product tags: - card products /cards: get: operationId: getCards parameters: - description: Number of cards to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Last four digits of card number explode: true in: query name: last_four required: true schema: type: string style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/CardListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists cards by the last 4 digits tags: - cards post: operationId: postCards parameters: - description: Show CVV explode: true in: query name: show_cvv_number required: false schema: default: false type: boolean style: form - description: Show PAN explode: true in: query name: show_pan required: false schema: default: false type: boolean style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/card_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/card_response' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Creates a card tags: - cards /cards/barcode/{barcode}: get: operationId: getCardsBarcodeBarcode parameters: - description: Barcode explode: false in: path name: barcode required: true schema: type: string style: simple - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_response' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Card does not exist '500': content: { } description: Server error summary: Returns a card's metadata tags: - cards /cards/getbypan: post: operationId: postCardsGetbypan requestBody: content: application/json: schema: $ref: '#/components/schemas/pan_request' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/pan_response' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Returns user and card tokens for the specified PAN tags: - cards /cards/user/{token}: get: operationId: getCardsUserToken parameters: - description: User token explode: false in: path name: token required: true schema: type: string style: simple - description: Number of items to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/CardListResponse' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Lists all cards for a specific user tags: - cards /cards/{token}: get: operationId: getCardsToken parameters: - description: Card token explode: false in: path name: token required: true schema: type: string style: simple - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Object to expand explode: true in: query name: expand required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_response' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Card not found '500': content: { } description: Server error summary: Returns a specific card tags: - cards put: operationId: putCardsToken parameters: - description: Card token explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/card_update_request' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_response' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Updates a specific card tags: - cards /cards/{token}/showpan: get: operationId: getCardsTokenShowpan parameters: - description: Card token explode: false in: path name: token required: true schema: type: string style: simple - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - explode: true in: query name: show_cvv_number required: false schema: type: boolean style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_response' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Card not found '500': content: { } description: Server error summary: Returns a specific card - PAN visible tags: - cards /cardtransitions: post: operationId: postCardtransitions requestBody: content: application/json: schema: $ref: '#/components/schemas/card_transition_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/card_transition_response' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Token already associated with a different payload '422': content: { } description: Cardholder not active '500': content: { } description: Server error summary: Creates a card transition object tags: - card transitions /cardtransitions/card/{token}: get: operationId: getCardtransitionsCardToken parameters: - description: Card token explode: false in: path name: token required: true schema: type: string style: simple - description: Number of card transitions to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 minimum: 0 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -createdTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/CardTransitionListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all card transitions tags: - card transitions /cardtransitions/{token}: get: operationId: getCardtransitionsToken parameters: - description: Card transition token explode: false in: path name: token required: true schema: type: string style: simple - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_transition_response' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Transition not found '500': content: { } description: Server error summary: Returns a card transition object tags: - card transitions /chargebacks: get: operationId: getChargebacks parameters: - description: Number of chargebacks to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Network reference ID explode: true in: query name: network_reference_id required: false schema: type: string style: form - description: Transaction token explode: true in: query name: transaction_token required: false schema: type: string style: form - description: Amount explode: true in: query name: amount required: false schema: type: string style: form - description: Comma-delimited list of chargeback states to display e.g. INITIATED | REPRESENTMENT | PREARBITRATION | ARBITRATION | CASE_WON | CASE_LOST | NETWORK_REJECTED | WITHDRAWN | WRITTEN_OFF_ISSUER | WRITTEN_OFF_PROGRAM explode: true in: query name: states required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form - explode: true in: query name: network_case_id required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChargebackListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List all chargebacks tags: - chargebacks post: operationId: postChargebacks requestBody: content: application/json: schema: $ref: '#/components/schemas/chargeback_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/chargeback_response' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Token already associated with a different payload '412': content: { } description: Pre-condition failed. Chargeback amount is greater than user GPA balance '422': content: { } description: Unable to return funds back to cardholder '500': content: { } description: Server error summary: Creates a chargeback tags: - chargebacks /chargebacks/allocationacknowledgement: post: operationId: postChargebackAllocationAcknowledgment requestBody: content: application/json: schema: $ref: '#/components/schemas/chargeback_allocation_ack_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/chargeback_response' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Creates a chargeback allocation acknowledgement tags: - chargebacks /chargebacks/transitions: post: operationId: postChargebacksTransitions requestBody: content: application/json: schema: $ref: '#/components/schemas/chargeback_transition_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/chargeback_transition_response' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Token already associated with a different payload '422': content: { } description: Unable to perform chargeback transition '500': content: { } description: Server error summary: Creates a chargeback transition tags: - chargebacks /chargebacks/transitions/{token}: get: operationId: getChargebacksTransitionsToken parameters: - description: Chargeback transition token explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/chargeback_transition_response' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Transition not found '500': content: { } description: Server error summary: Returns a specific chargeback transition tags: - chargebacks /chargebacks/{chargeback_token}/transitions: get: operationId: getChargebacksChargebacktokenTransitions parameters: - description: Number of transitions to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form - description: Chargeback token explode: false in: path name: chargeback_token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChargebackTransitionListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all chargeback transitions that are related to a chargeback tags: - chargebacks /chargebacks/{token}: get: operationId: getChargebacksToken parameters: - explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/chargeback_response' description: Success '404': content: { } description: Chargeback not found '500': content: { } description: Server error summary: Returns a specific chargeback tags: - chargebacks put: operationId: putChargebacksToken parameters: - explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/ChargebackUpdateRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/chargeback_response' description: Success '400': content: { } description: Chargeback not found '422': content: { } description: Unable to update chargeback '500': content: { } description: Server error summary: Updates chargeback data tags: - chargebacks /chargebacks/{token}/grantprovisionalcredit: put: operationId: putChargebacksTokenGrantprovisionalcredit parameters: - explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/chargeback_response' description: Success '400': content: { } description: Chargeback not found '422': content: { } description: Unable to grant provisional credit '500': content: { } description: Server error summary: Grants provisional credit tags: - chargebacks /chargebacks/{token}/reverseprovisionalcredit: put: operationId: putChargebacksTokenReverseprovisionalcredit parameters: - explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/chargeback_response' description: Success '400': content: { } description: Chargeback not found; chargeback at terminal state '422': content: { } description: Unable to reverse provisional credit '500': content: { } description: Server error summary: Reverses provisional credit tags: - chargebacks /clicktopay/visa/cards: delete: description: |- Use this endpoint to delete card information for Click to Pay for Visa. For more information about this ecommerce checkout solution, see <>. operationId: deleteCardInfo parameters: - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple responses: '202': content: application/json: example: requestTraceId: 2b6f0cc904d137be2e1730235f5664094b83 schema: $ref: '#/components/schemas/visa_click_to_pay_response' description: Accepted '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Delete card information for Click to Pay for Visa tags: - Digital Wallets Management put: description: |- Use this endpoint to update card information for Click to Pay for Visa. For more information about this ecommerce checkout solution, see <>. operationId: updateCardInfo parameters: - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: example: card: billingAddress: address1: 123 Elm Street address2: APT 1 city: Oakland country: USA postalCode: '94607' state: CA cardToken: '2345678901' nameOnCard: John Smith userToken: '1234567890' schema: $ref: '#/components/schemas/visa_click_to_pay_update_card_request' required: true responses: '202': content: application/json: example: requestTraceId: 2b6f0cc904d137be2e1730235f5664094b83 schema: $ref: '#/components/schemas/visa_click_to_pay_response' description: Accepted '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Update card information for Click to Pay for Visa tags: - Digital Wallets Management /clicktopay/visa/enroll: post: description: |- Use this endpoint to enroll a new cardholder in Click to Pay for Visa. For more information about this ecommerce checkout solution, see <>. operationId: enrollCardholder parameters: - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: example: card: billingAddress: address1: 123 Elm Street address2: APT 1 city: Oakland country: USA postalCode: '94607' state: CA cardToken: '2345678910' nameOnCard: John Smith user: country: USA email: example@email.com firstName: John lastName: Smith locale: en phone: 111-111-1111 userToken: '1234567890' schema: $ref: '#/components/schemas/visa_click_to_pay_enroll_request' required: true responses: '202': content: application/json: example: requestTraceId: 2b6f0cc904d137be2e1730235f5664094b83 schema: $ref: '#/components/schemas/visa_click_to_pay_response' description: Accepted '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Enroll a cardholder to Click to Pay for Visa tags: - Digital Wallets Management /clicktopay/visa/enrollcards: post: description: |- Use this endpoint to enroll a new card for an existing cardholder in Click to Pay for Visa. For more information about this ecommerce checkout solution, see <>. operationId: enrollCard parameters: - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: example: card: billingAddress: address1: 123 Elm Street address2: APT 1 city: Oakland country: USA postalCode: '94607' state: CA cardToken: '2345678901' nameOnCard: John Smith userToken: '1234567890' schema: $ref: '#/components/schemas/visa_click_to_pay_enroll_cards_request' required: true responses: '202': content: application/json: example: requestTraceId: 2b6f0cc904d137be2e1730235f5664094b83 schema: $ref: '#/components/schemas/visa_click_to_pay_response' description: Accepted '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Enroll a card to Click to Pay for Visa tags: - Digital Wallets Management /clicktopay/visa/getdata/{user_token}: get: description: |- Use this endpoint to get user data for Click to Pay for Visa. For more information about this ecommerce checkout solution, see <>. operationId: getUserData parameters: - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Unique identifier of the cardholder. example: '1234567890' explode: false in: path name: user_token required: true schema: type: string x-allowableValues: Existing Visa Click To Pay User Token style: simple responses: '200': content: application/json: example: externalConsumerId: '1234567890' schema: $ref: '#/components/schemas/visa_click_to_pay_get_user_data_response' description: OK '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve user data for Click to Pay for Visa tags: - Digital Wallets Management /clicktopay/visa/status/{requestTraceId}: get: description: |- Use this endpoint to return the status of a Click to Pay for Visa request. For more information about this ecommerce checkout solution, see <>. operationId: getStatus parameters: - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Unique identifier of the Visa Click to Pay request. example: 2b6f0cc904d137be2e1730235f5664094b83 explode: false in: path name: requestTraceId required: true schema: maxLength: 36 minLength: 1 type: string style: simple responses: '200': content: application/json: example: consumerInformation: externalConsumerID: 63421837-d597-4f0f-89e4-930c1a7b9e85 externalConsumerIDOwnerBID: '11133322' details: - errorDetails: - field: string message: string reason: string intent: type: PRODUCT_CODE value: CLICK_TO_PAY status: SUCCESS status: IN_PROGRESS schema: $ref: '#/components/schemas/visa_click_to_pay_status_response' description: OK '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve Click to Pay for Visa request status tags: - Digital Wallets Management /clicktopay/visa/users: delete: description: |- Use this endpoint to delete cardholder information for Click to Pay for Visa. For more information about this ecommerce checkout solution, see <>. operationId: deleteCardHolderInfo parameters: - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple responses: '202': content: application/json: example: requestTraceId: 2b6f0cc904d137be2e1730235f5664094b83 schema: $ref: '#/components/schemas/visa_click_to_pay_response' description: Accepted '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Delete cardholder information for Click to Pay for Visa tags: - Digital Wallets Management put: description: |- Use this endpoint to update cardholder information for Click to Pay for Visa. For more information about this ecommerce checkout solution, see <>. operationId: updateCardHolderInfo parameters: - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: example: user: country: USA email: example@email.com firstName: John lastName: Smith locale: en phone: 111-111-1111 userToken: '1234567890' schema: $ref: '#/components/schemas/visa_click_to_pay_update_cardholder_request' required: true responses: '202': content: application/json: example: requestTraceId: 2b6f0cc904d137be2e1730235f5664094b83 schema: $ref: '#/components/schemas/visa_click_to_pay_response' description: Accepted '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Update cardholder information for Click to Pay for Visa tags: - Digital Wallets Management /commandomodes: get: operationId: getCommandomodes parameters: - description: Number of commando modes to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommandoModeListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all commando mode control sets tags: - commando modes /commandomodes/transitions/{token}: get: operationId: getCommandomodesTransitionsToken parameters: - description: Commando mode transition token explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/commando_mode_transition_response' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Transition not found '500': content: { } description: Server error summary: Returns a specific commando mode transition tags: - commando modes /commandomodes/{commandomode_token}/transitions: get: operationId: getCommandomodesCommandomodetokenTransitions parameters: - description: Number of transitions to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -createdTime type: string style: form - description: Commando mode token explode: false in: path name: commandomode_token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommandoModeTransitionListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all commando mode transitions related to a commando mode control set tags: - commando modes /commandomodes/{token}: get: operationId: getCommandomodesToken parameters: - explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/commando_mode_response' description: Success '404': content: { } description: Commando mode not found '500': content: { } description: Server error summary: Returns a specific commando mode control set tags: - commando modes /depositaccounts: post: operationId: createAccount requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectDepositAccountRequest' description: Create direct deposit account for cardholder required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/direct_deposit_account_response' description: Created '404': content: { } description: Not found '500': content: { } description: Server error summary: Creates new direct deposit account for cardholder. tags: - direct deposit accounts /depositaccounts/account/{account_number}/user: get: operationId: getUserForDirectDepositAccount parameters: - description: Get user associated with direct deposit account number explode: false in: path name: account_number required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/direct_deposit_account_response' description: Success '404': content: { } description: Not found '500': content: { } description: Server error summary: Get User for Plain Text Account Number tags: - direct deposit accounts /depositaccounts/transitions: post: operationId: createTransition requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectDepositAccountTransitionRequest' description: Create transition for direct deposit account required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/direct_deposit_account_transition_response' description: Created '404': content: { } description: Not found '500': content: { } description: Server error summary: Creates new transition for a direct deposit account. tags: - direct deposit accounts /depositaccounts/transitions/{token}: get: operationId: getDirectDepositAccountTransition parameters: - description: Get specific direct deposit account transition explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/direct_deposit_account_transition_response' description: Success '404': content: { } description: Not found '500': content: { } description: Server error summary: Get direct deposit account transition. tags: - direct deposit accounts /depositaccounts/user/{token}: get: operationId: getUserDirectDepositAccounts parameters: - description: Number of users to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form - description: Direct deposit account status explode: true in: query name: state required: false schema: enum: - ACTIVE - SUSPENDED - TERMINATED - UNSUPPORTED - UNACTIVATED - LIMITED type: string style: form - description: Get specific direct deposit account explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/DirectDepositAccountListResponse' description: Success '404': content: { } description: Not found '500': content: { } description: Server error summary: List all specific direct deposit accounts. tags: - direct deposit accounts /depositaccounts/user/{token}/direct: get: deprecated: true operationId: getDepositAccountUserToken parameters: - description: Token explode: false in: path name: token required: true schema: type: string style: simple responses: default: content: { } description: successful operation summary: Get deposit account user token. /depositaccounts/{token}: get: operationId: getDirectDepositAccount parameters: - description: Get specific direct deposit account explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/direct_deposit_account_response' description: Success '404': content: { } description: Not found '500': content: { } description: Server error summary: Get direct deposit account. tags: - direct deposit accounts put: deprecated: true operationId: update parameters: - explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/DepositAccountUpdateRequest' description: Update direct deposit account required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/direct_deposit_account_response' description: Success '404': content: { } description: Not found '500': content: { } description: Server error summary: Update direct deposit account. tags: - direct deposit accounts /depositaccounts/{token}/cdd: get: operationId: getCDDInfo parameters: - description: Get CDD info for a specific DDA token explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/customer_due_diligence_response' description: Success '404': content: { } description: Not found '500': content: { } description: Server error summary: Get direct deposit account transition list for card holder. tags: - direct deposit accounts /depositaccounts/{token}/cdd/{cddtoken}: put: operationId: updateCDDInfo parameters: - explode: false in: path name: token required: true schema: type: string style: simple - explode: false in: path name: cddtoken required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerDueDiligenceUpdateRequest' description: Update CDD answers required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/customer_due_diligence_response' description: Success '404': content: { } description: Not found '500': content: { } description: Server error summary: Update CDD answers for Direct Deposit Account tags: - direct deposit accounts /depositaccounts/{user_token}/transitions: get: operationId: getTransitionList parameters: - description: Number of users to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -createdTime type: string style: form - description: Get direct deposit account transition list for user explode: false in: path name: user_token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/direct_deposit_account_transition_response' description: Success '404': content: { } description: Not found '500': content: { } description: Server error summary: Get direct deposit account transition list for card holder. tags: - direct deposit accounts /digitalwalletprovisionrequests/androidpay: post: description: |- Use this endpoint to return card data for use in provisioning a digital wallet token into Google Wallet. The returned card data is encrypted using the digital wallet provider's encryption key, thereby reducing your PCI compliance overhead. operationId: postDigitalwalletprovisionrequestsAndroidpay requestBody: content: application/json: example: card_token: my_card_token_0987 device_id: my_device_id_r51j device_type: MOBILE_PHONE provisioning_app_version: 2.13.3 wallet_account_id: my_wallet_account_id_sr51 schema: $ref: '#/components/schemas/digital_wallet_android_pay_provision_request' required: false responses: '201': content: application/json: example: card_token: my_card_token_1111 created_time: 2024-11-06T22:43:20Z last_modified_time: 2024-11-06T22:43:20Z push_tokenize_request_data: display_name: Visa Card last_digits: '3264' network: Visa opaque_payment_card: my_opaque_payment_card_RUza... token_service_provider: TOKEN_PROVIDER_VISA user_address: address1: 180 Grand Ave address2: Suite 500 city: Oakland country: US name: John Doe phone: '5105551212' postal_code: '94612' state: CA schema: $ref: '#/components/schemas/digital_wallet_android_pay_provision_response' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Card not found '500': content: { } description: Server error summary: Create digital wallet token provisioning request for Google Wallet tags: - Digital Wallets Management /digitalwalletprovisionrequests/applepay: post: description: |- Use this endpoint to return card data for use in provisioning a digital wallet token into Apple Wallet. The returned card data is encrypted using the digital wallet provider's encryption key, thereby reducing your PCI compliance overhead. operationId: postDigitalwalletprovisionrequestsApplepay requestBody: content: application/json: example: card_token: my_card_token_1234 certificates: - my_certificate_ZIzj... - my_certificate_SgMA... device_type: MOBILE_PHONE nonce: my_nonce_JJCF nonce_signature: my_nonce_signature_wbBn provisioning_app_version: 2.13.7 schema: $ref: '#/components/schemas/digital_wallet_apple_pay_provision_request' required: false responses: '201': content: application/json: example: activation_data: my_activation_data_VERF... card_token: my_card_token_1234 created_time: 2025-03-22T21:22:19Z encrypted_pass_data: my_encrypted_pass_data_KGga... ephemeral_public_key: my_ephemeral_public_key_omvw... last_modified_time: 2025-03-22T21:22:19Z schema: $ref: '#/components/schemas/digital_wallet_apple_pay_provision_response' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Card not found '500': content: { } description: Server error summary: Create digital wallet token provisioning request for Apple Wallet tags: - Digital Wallets Management /digitalwalletprovisionrequests/samsungpay: post: description: |- [NOTE] This endpoint is limited in availability. For more information, contact your Marqeta representative. Use this endpoint to return card data for use in provisioning a digital wallet token into Samsung Wallet. The returned card data is encrypted using the digital wallet provider's encryption key, thereby reducing your PCI compliance overhead. operationId: postDigitalwalletprovisionrequestsSamsungpay requestBody: content: application/json: schema: $ref: '#/components/schemas/digital_wallet_samsung_pay_provision_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/digital_wallet_samsung_pay_provision_response' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Card not found '500': content: { } description: Server error summary: Create digital wallet token provisioning request for Samsung Wallet tags: - Digital Wallets Management /digitalwalletprovisionrequests/xpay: post: description: |- [NOTE] This endpoint is limited in availability. For more information, contact your Marqeta representative. Use this endpoint to return card data for use in provisioning a digital wallet token into an XPay digital wallet. The returned card data is encrypted using the digital wallet provider's encryption key, thereby reducing your PCI compliance overhead. operationId: postDigitalwalletprovisionrequestsXPay requestBody: content: application/json: schema: $ref: '#/components/schemas/digital_wallet_x_pay_provision_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/digital_wallet_x_pay_provision_response' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Card not found '500': content: { } description: Server error summary: Create digital wallet token provisioning request for XPay tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/additionalAliases/{additionalAliasId}: delete: description: Use this endpoint to delete an additional Visa Alias by its Visa Alias ID. operationId: deleteAdditionalAliasById parameters: - description: Unique identifier of the additional Visa Aliases. example: a44c9553-e687-4f3c-b7e7-a4245d9f238e explode: false in: path name: additionalAliasId required: true schema: type: string x-allowableValues: Existing additional Visa Alias ID style: simple - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple responses: '204': description: Success '404': description: Not found '500': description: Internal server error summary: Delete an additional Visa Alias tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases: post: description: Use this endpoint to create a Visa Alias. operationId: createAlias parameters: - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: example: aliasType: PHONE aliasValue: '1231231234' consent: expiryDateTime: 2027-06-20T10:00:00Z intermediaries: - Client A presenter: Bank A validFromDateTime: 2024-12-01T10:00:00Z version: '1.0' identification: type: PASSPORT value: A123456 verificationDetails: authDateTime: 2025-01-01T22:52:46.000Z authMethodReference: EXTERNAL, SMS OTP, Email OTP creationDateTime: 2025-01-01T22:52:46.000Z verifiedEmail: true verifiedPhone: false paymentCredentials: - billingAddress: addressLine1: 1000 Market Street addressLine2: Suite 101 buildingNumber: '56' city: San Francisco country: USA minorSubdivisionCode: CA postalCode: '94105' state: CA streetName: '12' cardToken: '4111111145551142' cardType: Visa Platinum currencyCode: USD issuerName: Bank A nameOnCard: John Doe profile: contactInfo: - type: PHONE value: '1231234321' dateOfBirth: 1980-02-01 firstName: Alex firstNameLocal: Roberto lastName: Miller lastNameLocal: Miller middleName: Robert middleNameLocal: Alexander preferredName: Miller's Shop userToken: 21267931-7975-4b61-be7a-86915883b2b4 schema: $ref: '#/components/schemas/ads_create_alias_request' required: true responses: '200': content: application/json: example: externalId: 21267931-7975-4b61-a-8691588sdfsdfa id: 1f4f5e10-bde6-46a7-b2aa-576550054981 paymentCredentials: - externalId: '1111111111111111' id: 19e538ea-edfb-4780-915e-2f6e02959e03 type: CARD schema: $ref: '#/components/schemas/ads_create_alias_response' description: Success '400': description: User input error/Bad request '422': description: Unprocessable entity '500': description: Internal server error summary: Create a Visa Alias tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases/aliasId: post: description: Use this endpoint to retrieve the internal ID associated with a Visa Alias. operationId: getAliasIdByValue parameters: - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: example: aliasValue: my_alias_value_1234 schema: properties: aliasValue: description: |- Visa Alias value, which can be an email, a phone number, ID of an alias directory, or a payname. If a phone number is used for the Visa Alias, it must follow ITU-T E.164 (2010) number structure. *NOTE:* In the E.164 format, the "+" sign is not included. maxLength: 128 minLength: 1 type: string required: true responses: '200': content: application/json: example: id: my_alias_id_1234 schema: properties: id: description: UUID generated by Alias Directory, which identifies the Visa Alias. maxLength: 128 minLength: 1 type: string description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve alias internal ID tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases/getByExternalId: post: description: Use this endpoint to retrieve a Visa Alias by its external ID. operationId: getAliasByExternalId parameters: - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: example: externalId: 21267931-7975-4b61-be7a-86915883b2b4 type: ALIAS schema: $ref: '#/components/schemas/ads_get_by_external_id_request' required: true responses: '200': content: application/json: example: associatedIds: - id: a44c9553-e687-4f3c-b7e7-a4245d9f238e type: PAYMENT_CREDENTIAL id: e336c8c8-2945-4be3-af3e-951ec2d01219 schema: $ref: '#/components/schemas/ads_get_by_external_id_response' description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve Visa Alias by external ID tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases/inquiry: post: description: |- Use this endpoint to check for available Visa Aliases for alias resolution. One or more Visa Aliases may be available. operationId: inquireAliasAvailability parameters: - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: example: aliases: - '123456' filters: - field: DIRECTORY_NAME value: - DIRECTORY_A - DIRECTORY_B - DIRECTORY_C transactionDetails: currencyCode: USD userDetails: userName: johndoe313 schema: $ref: '#/components/schemas/ads_alias_inquiry_request' required: true responses: '200': content: application/json: example: - details: - aliasType: PHONE aliasValue: '123456' directories: - directoryName: DIRECTORY_A entities: - id: '1101' - id: '1102' preferredFor: - date: 1980-02-01 type: RECEIVE - directoryName: DIRECTORY_B directoriesName: - DIRECTORY_A - DIRECTORY_B summary: aliasesFound: 1 aliasesNotFound: 0 aliasesRepeated: 0 aliasesTotal: 1 schema: items: $ref: '#/components/schemas/ads_alias_inquiry_response' type: array description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Check for Visa Alias tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases/resolve: post: description: Retrieve information about a Visa Alias and all the associated payment credentials. operationId: resolveAlias parameters: - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: example: aliasType: PHONE aliasValue: '1231231234' filters: - field: DIRECTORY_NAME value: - DIRECTORY_A - DIRECTORY_B - DIRECTORY_C transactionDetails: currencyCode: USD userDetails: userName: username1234 schema: $ref: '#/components/schemas/ads_alias_resolve_request' required: true responses: '200': content: application/json: example: - directoryName: DIRECTORY_A identification: type: PASSPORT value: A123456 verificationDetails: authDateTime: 2021-01-01T22:52:46Z authMethodReference: EXTERNAL, SMS OTP, Email OTP creationDateTime: 2021-01-01T22:52:46Z verifiedEmail: true verifiedPhone: false paymentCredentials: - accountNumber: '4111111145551142' accountNumberType: TOKEN billingAddress: addressLine1: 1000 Market Street addressLine2: Suite 101 buildingNumber: '56' city: San Francisco country: USA minorSubdivisionCode: CA postalCode: '94105' state: CA streetName: '12' cardType: Visa Platinum currencyCode: USD expirationDate: 2026-01 issuerName: Bank A lastFourDigits: '1142' modifiedOn: 2021-01-01T22:52:46.000Z nameOnCard: Alex Miller preferredFor: - date: 2021-01-01 type: RECEIVE type: CARD profile: contactInfo: - type: PHONE value: '1231234321' dateOfBirth: 1980-02-01 firstName: Alex firstNameLocal: Alexander lastName: Miller lastNameLocal: Miller middleName: Robert middleNameLocal: Roberto preferredName: Miller's Shop schema: items: $ref: '#/components/schemas/ads_alias_resolve_response' type: array description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Resolve a Visa Alias tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases/{aliasId}: delete: description: Use this endpoint to delete a Visa Alias by Visa Alias ID. operationId: deleteAliasById parameters: - description: Unique identifier of the Visa Alias. example: a44c9553-e687-4f3c-b7e7-a4245d9f238e explode: false in: path name: aliasId required: true schema: type: string x-allowableValues: Existing Visa Alias ID style: simple - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple responses: '204': description: Success '404': description: Not found '500': description: Internal server error summary: Delete Visa Alias by Visa Alias ID tags: - Digital Wallets Management get: description: Use this endpoint to retrieve a Visa Alias by its Visa Alias ID. operationId: getAliasById parameters: - description: Unique identifier of the Visa Alias. explode: false in: path name: aliasId required: true schema: type: string x-allowableValues: Existing Visa Alias ID style: simple - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple responses: '200': content: application/json: example: aliasType: PHONE aliasValue: '1231231234' consent: expiryDateTime: 2025-06-20T10:00:00Z intermediaries: - Client A presenter: Bank A validFromDateTime: 2024-12-01T10:00:00Z version: '1.0' createdOn: 2025-01-01T22:52:46.000Z identification: type: PASSPORT value: A123456 verificationDetails: authDateTime: 2025-01-01T22:52:46Z authMethodReference: EXTERNAL, SMS OTP, Email OTP creationDateTime: 2025-01-01T22:52:46Z verifiedEmail: true verifiedPhone: false lastModifiedOn: 2025-01-01T22:52:46.000Z profile: contactInfo: - type: PHONE value: '1231234321' dateOfBirth: 1980-02-01 firstName: Alex firstNameLocal: Alexander lastName: Miller lastNameLocal: Miller middleName: Robert middleNameLocal: Roberto preferredName: Miller's Shop status: ACTIVE schema: $ref: '#/components/schemas/ads_alias_response' description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve Visa Alias by Visa Alias ID tags: - Digital Wallets Management put: description: Use this endpoint to update a Visa Alias by its Visa Alias ID. operationId: updateAliasById parameters: - description: Unique identifier of the Visa Alias. explode: false in: path name: aliasId required: true schema: type: string x-allowableValues: Existing Visa Alias ID style: simple - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: example: aliasType: PHONE aliasValue: '1231231234' consent: expiryDateTime: 2025-06-20T10:00:00Z intermediaries: - Client A presenter: Bank A validFromDateTime: 2024-12-01T10:00:00Z version: '1.0' createdOn: 2025-01-01T22:52:46Z identification: type: PASSPORT value: A123456 verificationDetails: authDateTime: 2025-01-01T22:52:46Z authMethodReference: EXTERNAL, SMS OTP, Email OTP creationDateTime: 2025-01-01T22:52:46Z verifiedEmail: true verifiedPhone: false lastModifiedOn: 2025-01-01T22:52:46Z profile: contactInfo: - type: PHONE value: '1231234321' dateOfBirth: 1980-02-01 firstName: Alex firstNameLocal: Alexander lastName: Miller lastNameLocal: Miller middleName: Robert middleNameLocal: Roberto preferredName: Miller's Shop status: ACTIVE schema: $ref: '#/components/schemas/ads_update_alias_request' required: true responses: '204': description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Update Visa Alias by Visa Alias ID tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases/{aliasId}/additionalAlias: post: description: Use this endpoint to create additional Visa Aliases associated with an existing main Visa Alias. operationId: createAdditionalAliases parameters: - description: Unique identifier of the Visa Alias. explode: false in: path name: aliasId required: true schema: type: string x-allowableValues: Existing Visa Alias ID style: simple - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple requestBody: content: application/json: example: type: EMAIL value: '1231231234' schema: $ref: '#/components/schemas/ads_create_additional_aliases_request' required: true responses: '200': content: application/json: example: id: my_alias_id_1234 schema: $ref: '#/components/schemas/ads_create_additional_alias_response' description: Success '400': description: User input error/Bad request '422': description: Unprocessable entity '500': description: Internal server error summary: Create an additional Visa Alias tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases/{aliasId}/cards: get: description: Use this endpoint to retrieve a list of payment credentials associated with a Visa Alias. operationId: getCardsByAlias parameters: - description: Unique identifier of the Visa Alias. explode: false in: path name: aliasId required: true schema: type: string x-allowableValues: Existing Visa Alias ID style: simple - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple responses: '200': content: application/json: example: accountNumber: 4111111145551142 accountNumberType: TOKEN billingAddress: addressLine1: 1000 Market Street addressLine2: Suite 101 buildingNumber: 56 city: San Francisco country: USA minorSubdivisionCode: CA postalCode: 94105 state: CA streetName: 12 cardType: Visa Platinum createdOn: 2025-06-21T13:00:00Z currencyCode: USD expirationDate: 2026-01 externalId: 63421837-d597-4f0f-89e4-930c1a7b9e85 id: a44c9553-e687-4f3c-b7e7-a4245d9f238e issuerName: Bank A lastFourDigits: 1142 lastUpdatedOn: 2025-06-22T15:12:00Z nameOnCard: Alex Miller preferredFor: - date: 2025-01-01 type: RECEIVE status: ACTIVE type: CARD schema: $ref: '#/components/schemas/ads_cards_response' description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve a Visa Alias payment credentials tags: - Digital Wallets Management post: description: Use this endpoint to create a payment credential associated with a Visa Alias. operationId: createCardByAlias parameters: - description: Unique identifier of the Visa Alias. explode: false in: path name: aliasId required: true schema: type: string x-allowableValues: Existing Visa Alias ID style: simple - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple requestBody: content: application/json: example: billingAddress: addressLine1: 1000 Market Street addressLine2: Suite 101 buildingNumber: '56' city: San Francisco country: USA minorSubdivisionCode: CA postalCode: '94105' state: CA streetName: '12' cardToken: '4111111145551142' cardType: Visa Platinum currencyCode: USD issuerName: Bank A nameOnCard: John Doe preferredFor: - RECEIVE - SEND schema: $ref: '#/components/schemas/ads_card_details_request' required: true responses: '200': content: application/json: example: externalId: 63421837-d597-4f0f-89e4-930c1a7b9e85 id: a44c9553-e687-4f3c-b7e7-a4245d9f238e type: CARD schema: $ref: '#/components/schemas/ads_create_card_details_response' description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Create Visa Alias payment credential tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases/{aliasId}/status: put: description: Use this endpoint to update the status of a Visa Alias. operationId: updateAliasStatus parameters: - description: Unique identifier of the Visa Alias. explode: false in: path name: aliasId required: true schema: type: string x-allowableValues: Existing Visa Alias ID style: simple - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: example: status: ACTIVE schema: properties: status: description: Status of the Visa Alias. type: string required: true responses: '204': description: Success '400': description: User input error/Bad request '404': description: Not found '422': description: Unprocessable entity '500': description: Internal server error summary: Update alias status tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/cards/{cardToken}: delete: description: Use this endpoint to delete a payment credential associated with a card token. operationId: deleteCardByCardToken parameters: - description: Unique identifier of the card token. example: '1234567890' explode: false in: path name: cardToken required: true schema: type: string x-allowableValues: Existing card token style: simple - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple responses: '204': description: Success '404': description: Not found '500': description: Internal server error summary: Delete card token payment credential tags: - Digital Wallets Management get: description: Use this endpoint to retrieve a payment credential associated with a card token. operationId: getCardByCardToken parameters: - description: Unique identifier of the card token. explode: false in: path name: cardToken required: true schema: type: string x-allowableValues: Existing card token style: simple - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple responses: '200': content: application/json: example: accountNumber: '4111111145551142' accountNumberType: TOKEN billingAddress: addressLine1: 1000 Market Street addressLine2: Suite 101 buildingNumber: 56 city: San Francisco country: USA minorSubdivisionCode: CA postalCode: '94105' state: CA streetName: 12 cardType: Visa Platinum createdOn: 2025-06-21T13:00:00.645Z currencyCode: USD expirationDate: 2026-01 externalId: 63421837-d597-4f0f-89e4-930c1a7b9e85 id: a44c9553-e687-4f3c-b7e7-a4245d9f238e issuerName: Bank A lastFourDigits: 1142 lastUpdatedOn: 2025-06-22T15:12:00.322Z nameOnCard: Alex Miller preferredFor: - date: 2025-01-01 type: RECEIVE status: ACTIVE type: CARD schema: $ref: '#/components/schemas/ads_cards_response' description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve card token payment credential tags: - Digital Wallets Management put: description: Use this endpoint to update a payment credential associated with a card token. operationId: updateCardByCardToken parameters: - description: Unique identifier of the card token. explode: false in: path name: cardToken required: true schema: type: string x-allowableValues: Existing card token style: simple - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple requestBody: content: application/json: example: billingAddress: addressLine1: 1000 Market Street addressLine2: Suite 101 buildingNumber: '56' city: San Francisco country: USA minorSubdivisionCode: CA postalCode: '94105' state: CA streetName: '12' cardToken: '4111111145551142' cardType: Visa Platinum currencyCode: USD issuerName: Bank A nameOnCard: John Doe preferredFor: - RECEIVE - SEND schema: $ref: '#/components/schemas/ads_card_details_request' required: true responses: '204': description: Success '400': description: User input error/Bad request '404': description: Not found '422': description: Unprocessable entity '500': description: Internal server error summary: Update card token payment credential tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/reports: post: description: Use this endpoint to create a new report request. operationId: createReport parameters: - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple requestBody: content: application/json: example: filters: aliasStatuses: - ACTIVE aliasType: PHONE billingEventTypes: - createAlias endDate: 2025-01-01T22:52:46Z startDate: 2025-01-01T22:52:46Z format: JSON reportType: PLATFORM_REQUESTS schema: $ref: '#/components/schemas/ads_create_report_request' required: true responses: '200': content: application/json: example: reportId: my_report_id_1234 schema: properties: reportId: description: Unique identifier of the report. maxLength: 36 type: string description: Success '400': description: User input error/Bad request '422': description: Unprocessable entity '500': description: Internal server error summary: Create a report request tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/reports/{reportId}: get: description: Use this endpoint to retrieve the status of a report by its report ID. operationId: getReportById parameters: - description: Unique identifier of the report. explode: false in: path name: reportId required: true schema: type: string x-allowableValues: Existing report ID style: simple - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple responses: '200': content: application/json: example: creationDateTime: 2025-01-01T22:52:46Z dataClassification: VERY_IMPORTANT expirationDateTime: 2025-01-01T22:52:46Z fileIds: - 000001-a96032e1-0ad9-4937-9320-a2a28b139ea5, 000002-a96032e1-0ad9-4937-9320-a2a28b139ea5 format: JSON id: a77ef5c5-c972-467b-9a11-ac550183b495 reportType: PLATFORM_REQUESTS status: COMPLETED schema: $ref: '#/components/schemas/ads_get_report_status_response' description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve report status by report ID tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/reports/{reportId}/file/{fileId}: get: description: Use this endpoint to retrieve a file by its file ID and report ID. operationId: getFileByReportAndFileId parameters: - description: Unique identifier of the report. explode: false in: path name: reportId required: true schema: type: string x-allowableValues: Existing report ID style: simple - description: Unique identifier of the file. explode: false in: path name: fileId required: true schema: type: string x-allowableValues: Existing file ID style: simple - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple responses: '200': content: application/json: example: - operationType: resolveAlias operationsCount: 18 originatorActorId: 012af73f-44d8-4c9c-bbee-628b07faae1c programId: baf85624-3cf6-4c52-b91f-b8f3493e7330 statusCode: 200 schema: items: $ref: '#/components/schemas/ads_report_file_response' type: array description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve file by file ID and report ID tags: - Digital Wallets Management /digitalwallets/clicktopay/mastercard/checkeligibility: get: description: |- Use this endpoint to check if a provided BIN prefix is eligible for Click to Pay for Mastercard. For more information about this ecommerce checkout solution, see <>. operationId: getClicktopayMastercardCheckeligibility parameters: - description: Prefix of the bank identification number. explode: true in: query name: bin_prefix required: true schema: type: string x-allowableValues: |- A six- to nine-digit number *NOTE:* It is preferable to use eight- or nine-digit BIN prefixes in production environments. Contact your Marqeta representative for the appropriate value to use. style: form - description: Returns a list of image assets for the Click to Pay logo if set to `true`. explode: true in: query name: include_asset required: false schema: default: false type: boolean x-allowableValues: '`true`, `false`' style: form - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple responses: '200': content: application/json: example: image_assets: - media_content: data: iVBORw0KGgoAAAANSUhEUgAAAMAAAADACAYAAABS3GwHAAAAAXNSR0IArs4c6... (truncated for readability) height: 192px type: image/png width: 192px - media_content: data: PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3... (truncated for readability) height: 192px type: image/svg+xml width: 192px is_eligible: true schema: $ref: '#/components/schemas/click_to_pay_check_eligibility_response' description: Eligibility check successful '400': description: Invalid binPrefix or other validation error '500': description: Internal server error summary: Check eligibility for Click to Pay for Mastercard tags: - Digital Wallets Management /digitalwallets/clicktopay/mastercard/enroll: post: description: |- Use this endpoint to enroll a card in Click to Pay for Mastercard. For more information about this ecommerce checkout solution, see <>. operationId: postClicktopayMastercardEnroll parameters: - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: example: card_token: my_card_token_1234 locale_country: US locale_language: en user_details: - email_address: test@test.com mobile_number: country_code: '44' phone_number: '1234567890' user_token: my_user_token_1234 schema: $ref: '#/components/schemas/click_to_pay_enroll_request' required: true responses: '201': content: application/json: example: token: my_token_0000 schema: $ref: '#/components/schemas/click_to_pay_enroll_response' description: Enrollment Request Accepted '400': description: Invalid request or other validation error '500': description: Internal server error summary: Enroll a card to Click to Pay for Mastercard tags: - Digital Wallets Management /digitalwallets/clicktopay/mastercard/status/{token}: get: description: |- Use this endpoint to return the status of a specific Click to Pay for Mastercard request. For more information about this ecommerce checkout solution, see <>. operationId: getClicktopayMastercardStatusToken parameters: - description: Unique identifier of the Click to Pay request. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing Click to Pay request token style: simple - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false in: header name: req-sys-id required: true schema: type: string style: simple responses: '200': content: application/json: example: status: SUCCESS token: my_token_0000 token_reference_id: my_token_reference_id_1600 schema: $ref: '#/components/schemas/click_to_pay_status_response' description: Status retrieval successful '404': description: No provision request found with the token '500': description: Internal server error summary: Retrieve Click to Pay for Mastercard enrollment status tags: - Digital Wallets Management /digitalwallets/postTokenizationAuthenticationDecision: post: description: |- Use this endpoint to submit a post-tokenization authentication decision from the customer to Marqeta in a secure card on file scenario. Marqeta validates the request, stores it, and forwards the authentication decision to Mastercard MDES in real time. Marqeta then returns the MDES response back to the customer synchronously. This enables issuers to notify Mastercard Digital Enablement Service (MDES) of the cardholder's authentication outcome following tokenization, ensuring that the token requestor receives timely and accurate decisioning. operationId: postTokenizationAuthenticationDecision requestBody: content: application/json: schema: $ref: '#/components/schemas/PostTokenizationAuthenticationDecisionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PostTokenizationAuthenticationDecisionResponse' description: Successful response summary: Submit a post-tokenization authentication decision tags: - Digital Wallets Management /digitalwallets/wpp/applePayJWT: post: description: Use this endpoint to add a card to Apple Wallet via a web application. operationId: generateApplePayWPPJWT parameters: - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/request_for_apple_pay_wpp_JWT' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/web_push_provisioning_apple_pay_JWT_response' description: Ok headers: req-sys-id: description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false schema: type: string style: simple '400': content: application/json: schema: $ref: '#/components/schemas/error_message_from_web_push_provisioning_request' description: Bad request headers: req-sys-id: description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false schema: type: string style: simple '401': content: application/json: schema: $ref: '#/components/schemas/error_message_from_web_push_provisioning_request' description: Unauthorized headers: req-sys-id: description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false schema: type: string style: simple '500': content: application/json: schema: $ref: '#/components/schemas/error_message_from_web_push_provisioning_request' description: Internal Server Error headers: req-sys-id: description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false schema: type: string style: simple summary: Create request for Apple Wallet web push provisioning tags: - Digital Wallets Management /digitalwallets/wpp/googlePayPushProvisioningNotification: post: description: |- Use this endpoint to add a card to Google Wallet via a web application. This endpoint does not return a payload in response to a request. Instead, a successful call will return a response code only. operationId: sendOPCDataToGooglePay parameters: - description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/sending_provisioning_data_to_google_pay_backend_request' required: true responses: '202': content: { } description: Accepted headers: req-sys-id: description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false schema: type: string style: simple '400': content: application/json: schema: $ref: '#/components/schemas/error_message_from_web_push_provisioning_request' description: Bad request headers: req-sys-id: description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false schema: type: string style: simple '401': content: application/json: schema: $ref: '#/components/schemas/error_message_from_web_push_provisioning_request' description: Unauthorized headers: req-sys-id: description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false schema: type: string style: simple '500': content: application/json: schema: $ref: '#/components/schemas/error_message_from_web_push_provisioning_request' description: Internal Server Error headers: req-sys-id: description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. explode: false schema: type: string style: simple summary: Create request for Google Wallet web push provisioning tags: - Digital Wallets Management /digitalwallets/wpp/parameters: post: operationId: getWPPParameters parameters: - description: Random pseudo unique value used for troubleshooting between multiple parties. 36 char max example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/request_for_wpp_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/web_push_provisioning' description: Ok headers: req-sys-id: description: Random pseudo unique value used for troubleshooting between multiple parties. 36 char max explode: false schema: type: string style: simple '400': content: application/json: schema: $ref: '#/components/schemas/error_message_from_web_push_provisioning_request' description: Bad request headers: req-sys-id: description: Random pseudo unique value used for troubleshooting between multiple parties. 36 char max explode: false schema: type: string style: simple '401': content: application/json: schema: $ref: '#/components/schemas/error_message_from_web_push_provisioning_request' description: Unauthorized headers: req-sys-id: description: Random pseudo unique value used for troubleshooting between multiple parties. 36 char max explode: false schema: type: string style: simple '500': content: application/json: schema: $ref: '#/components/schemas/error_message_from_web_push_provisioning_request' description: Internal Server Error headers: req-sys-id: description: Random pseudo unique value used for troubleshooting between multiple parties. 36 char max explode: false schema: type: string style: simple summary: 'API to query for the web push provisioning related parameters, such as: google piaid/integrator_id, apple partnerId, apple Card Template Identifier' tags: - web push provisioning /digitalwallettokens: get: description: Use this endpoint to retrieve a list of digital wallet tokens. operationId: getDigitalwallettokens parameters: - description: Number of digital wallet token resources to retrieve. explode: true in: query name: count required: false schema: default: 10 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first digital wallet token resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -id type: string style: form - description: Date when the digital wallet token becomes active. explode: true in: query name: start_date required: false schema: type: string style: form - description: Expiration date of the digital wallet token. explode: true in: query name: end_date required: false schema: type: string style: form - description: |- Unique identifier of the digital wallet token primary account number (PAN) within the card network. This value may vary, depending on the digital wallet. For example, the `pan_reference_id` may be different in Apple Wallet and Google Wallet for the same digital wallet token. explode: true in: query name: pan_reference_id required: false schema: type: string style: form - description: |- Unique identifier of the digital wallet token within the card network. The `token_reference_id` is unique at the card network level. explode: true in: query name: token_reference_id required: false schema: type: string style: form - description: Unique value representing a tokenization request (Mastercard only). explode: true in: query name: correlation_id required: false schema: type: string style: form - description: Comma-delimited list of digital wallet token types to display. explode: true in: query name: token_type required: false schema: type: string style: form - description: |- Name of the token requestor within the card network. *NOTE:* The list of example values for this field is maintained by the card networks and is subject to change. explode: true in: query name: token_requestor_name required: false schema: type: string style: form - description: Comma-delimited list of digital wallet token states to display. explode: true in: query name: state required: false schema: type: string style: form - description: An optional embedded user object. explode: true in: query name: embed required: false schema: enum: - user type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/DigitalWalletTokenListResponse' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: List digital wallet tokens tags: - Digital Wallets Management /digitalwallettokens/card/{card_token}: get: description: |- Use this endpoint to return an array of all digital wallet tokens for a particular card. This endpoint supports <>. operationId: getDigitalwallettokensCardCardtoken parameters: - description: |- Unique identifier of the card. Used to minimize the need to exchange card details during subsequent calls, and also for troubleshooting. explode: false in: path name: card_token required: true schema: type: string style: simple - description: Number of digital wallet token resources to retrieve. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Sort order index of the first digital wallet token resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -id type: string style: form responses: '200': content: application/json: example: count: 1 data: - address_verification: name: Address Verification Name postal_code: '94703' street_address: 223 Elm Street card_token: my_card_token_1989 created_time: 2025-10-03T18:55:45Z device: device_id: my_device_id_9575 ip_address: x.x.x.x language_code: eng location: +37.81/-122.26 name: Phone Name phone_number: '12345678900' type: MOBILE_PHONE fulfillment_status: PROVISIONED issuer_eligibility_decision: cardaccount.verified last_modified_time: 2025-01-26T22:36:10Z state: ACTIVE state_reason: Card activated by cardholder token: my_token_0000 token_service_provider: pan_reference_id: my_pan_reference_id_0073 token_eligibility_decision: DECISION_GREEN token_reference_id: my_token_reference_id_1600 token_requestor_id: my_token_requestor_id_0373 token_requestor_name: Token Requestor Name token_score: '02' token_type: DEVICE_SECURE_ELEMENT wallet_provider_profile: account: score: '05' device_score: '03' pan_source: KEY_ENTERED risk_assessment: score: DECISION_YELLOW version: '0001.00' end_index: 0 is_more: true start_index: 0 schema: $ref: '#/components/schemas/DigitalWalletTokenListResponse' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Card not found '500': content: { } description: Server error summary: List digital wallet tokens for card tags: - Digital Wallets Management /digitalwallettokens/{token}: get: description: Use this endpoint to retrieve a specific digital wallet token. operationId: getDigitalwallettokensToken parameters: - description: Unique identifier of the digital wallet token (DWT). explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: address_verification: name: Address Verification Name postal_code: '94703' street_address: 223 Elm Street card_token: my_card_token_1989 created_time: 2025-10-03T18:55:45Z device: device_id: my_device_id_9575 ip_address: x.x.x.x language_code: eng location: +37.81/-122.26 name: Phone Name phone_number: '12345678900' type: MOBILE_PHONE fulfillment_status: PROVISIONED issuer_eligibility_decision: cardaccount.verified last_modified_time: 2025-01-26T22:36:10Z state: ACTIVE state_reason: Card activated by cardholder token: my_token_0000 token_service_provider: pan_reference_id: my_pan_reference_id_0073 token_eligibility_decision: DECISION_GREEN token_reference_id: my_token_reference_id_1600 token_requestor_id: my_token_requestor_id_0373 token_requestor_name: Token Requestor Name token_score: '02' token_type: DEVICE_SECURE_ELEMENT wallet_provider_profile: account: score: '05' device_score: '03' pan_source: KEY_ENTERED risk_assessment: score: DECISION_YELLOW version: '0001.00' schema: $ref: '#/components/schemas/digital_wallet_token' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Card not found '500': content: { } description: Server error summary: Retrieve digital wallet token tags: - Digital Wallets Management /digitalwallettokens/{token}/showtokenpan: get: description: |- Use this endpoint to retrieve a digital wallet token with the entire primary account number (PAN) displayed. The PAN returned is of the digital wallet token and not of the card. (For security reasons, the PAN is not fully visible on the digital wallet token returned by `GET` `/digitalwallettokens/{token}`.) [WARNING] Sending a request to this endpoint requires PCI DSS compliance. You must comply with PCI DSS data security requirements if you want to store, transmit, or process sensitive card data such as the cardholder's primary account number (PAN), personal identification number (PIN), and card expiration date. operationId: getDigitalwallettokensTokenShowtokenpan parameters: - description: Unique identifier of the digital wallet token (DWT). explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: address_verification: name: Address Verification Name postal_code: '94703' street_address: 223 Elm Street card_token: my_card_token_1989 created_time: 2025-10-03T18:55:45Z device: device_id: my_device_id_9575 ip_address: x.x.x.x language_code: eng location: +37.81/-122.26 name: Phone Name phone_number: '12345678900' type: MOBILE_PHONE fulfillment_status: PROVISIONED issuer_eligibility_decision: cardaccount.verified last_modified_time: 2025-01-26T22:36:10Z state: ACTIVE state_reason: Card activated by cardholder token: my_token_0000 token_service_provider: pan_reference_id: my_pan_reference_id_0073 token_eligibility_decision: DECISION_GREEN token_pan: my_token_pan_6792 token_reference_id: my_token_reference_id_1600 token_requestor_id: my_token_requestor_id_0373 token_requestor_name: Token Requestor Name token_score: '02' token_type: DEVICE_SECURE_ELEMENT wallet_provider_profile: account: score: '05' device_score: '03' pan_source: KEY_ENTERED risk_assessment: score: DECISION_YELLOW version: '0001.00' schema: $ref: '#/components/schemas/digital_wallet_token' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Card not found '500': content: { } description: Server error summary: Retrieve digital wallet token PAN tags: - Digital Wallets Management /digitalwallettokentransitions: post: description: Use this endpoint to transition a digital wallet token from one state to another. operationId: postDigitalwallettokentransitions requestBody: content: application/json: example: digital_wallet_token: token: my_digital_wallet_token_0987 reason: Passed additional identity verification reason_code: '18' state: ACTIVE token: my_transition_04 schema: $ref: '#/components/schemas/digital_wallet_token_transition_request' required: false responses: '201': content: application/json: example: channel: API created_time: 2025-02-23T18:57:45Z digital_wallet_token: token: my_digital_wallet_token_0987 fulfillment_status: PROVISIONED reason: Passed additional identity verification reason_code: '18' state: ACTIVE token: my_transition_04 type: state.activated schema: $ref: '#/components/schemas/digital_wallet_token_transition_response' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Create digital wallet token transition tags: - Digital Wallets Management /digitalwallettokentransitions/digitalwallettoken/{token}: get: description: |- Use this endpoint to return an array of all transitions for a particular digital wallet token. This endpoint supports <>, <>, and <>. operationId: getDigitalwallettokentransitionsDigitalwallettokenToken parameters: - description: Unique identifier of the digital wallet token (DWT). explode: false in: path name: token required: true schema: type: string style: simple - description: Number of digital wallet transitions to retrieve. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: The sort order index of the first digital wallet token in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -id type: string style: form responses: '200': content: application/json: example: count: 2 data: - channel: API created_time: 2025-02-23T18:57:45Z digital_wallet_token: token: my_digital_wallet_token_0987 fulfillment_status: PROVISIONED reason: Passed additional identity verification reason_code: '18' state: ACTIVE token: my_transition_04 type: state.activated - channel: TOKEN_SERVICE_PROVIDER created_time: 2024-02-23T18:44:21Z digital_wallet_token: token: my_digital_wallet_token_0987 fulfillment_status: DECISION_YELLOW reason: Additional identity verification required reason_code: '21' state: REQUESTED token: my_transition_04 type: fulfillment.requested end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/DigitalWalletTokenTransitionListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List transitions for digital wallet token tags: - Digital Wallets Management /digitalwallettokentransitions/{token}: get: description: |- Use this endpoint to retrieve a specific digital wallet token transition. This endpoint supports <>. operationId: getDigitalwallettokentransitionsToken parameters: - description: Unique identifier of the digital wallet token (DWT) transition. explode: false in: path name: token required: true schema: type: string style: simple - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: example: channel: API created_time: 2025-02-23T18:57:45Z digital_wallet_token: token: my_digital_wallet_token_0987 fulfillment_status: PROVISIONED reason: Passed additional identity verification reason_code: '18' state: ACTIVE token: my_transition_04 type: state.activated schema: $ref: '#/components/schemas/digital_wallet_token_transition_response' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Transition not found '500': content: { } description: Server error summary: Retrieve digital wallet token transition tags: - Digital Wallets Management /directdeposits: get: operationId: getDirectdeposits parameters: - description: Number of direct deposits to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 maximum: 100 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Reversed after grace period explode: true in: query name: reversed_after_grace_period required: false schema: type: boolean style: form - description: User token explode: true in: query name: user_token required: false schema: type: string style: form - description: Business token explode: true in: query name: business_token required: false schema: type: string style: form - description: Direct deposit state explode: true in: query name: direct_deposit_state required: false schema: enum: - PENDING - APPLIED - REVERSED - REJECTED type: string style: form - description: Start settlement date explode: true in: query name: start_settlement_date required: false schema: type: string style: form - description: End settlement date explode: true in: query name: end_settlement_date required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/DirectDepositListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all direct deposits tags: - direct deposits /directdeposits/accounts/{user_or_business_token}: get: deprecated: true operationId: getDirectdepositsAccountsUserorbusinesstoken parameters: - explode: false in: path name: user_or_business_token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/DepositAccountResponse' description: Success '400': content: { } description: Cardholder not found '404': content: { } description: Account not found '500': content: { } description: Server error summary: Returns an account and routing number which can be used for direct deposit tags: - direct deposits put: deprecated: true operationId: putDirectdepositsAccountsUserorbusinesstoken parameters: - description: User or business token explode: false in: path name: user_or_business_token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/DepositAccountUpdateRequest' description: Deposit account update request required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DepositAccountResponse' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Updates a specific direct deposit account tags: - direct deposits /directdeposits/transitions: get: operationId: getDirectdepositsTransitions parameters: - description: Number of direct deposit transitions to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 maximum: 100 type: integer style: form - description: User token explode: true in: query name: user_token required: false schema: type: string style: form - description: Business token explode: true in: query name: business_token required: false schema: type: string style: form - description: Direct deposit token explode: true in: query name: direct_deposit_token required: false schema: type: string style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -createdTime type: string style: form - description: 'Comma-delimited list of direct deposit states to display e.g. PENDING | REVERSED | APPLIED | REJECTED ' explode: true in: query name: states required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/DirectDepositTransitionListResponse' description: Success '404': content: { } description: Not found '500': content: { } description: Server error summary: Returns a list of direct deposit transitions tags: - direct deposits post: operationId: postDirectdepositsTransitions requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectDepositTransitionRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/DirectDepositTransitionResponse' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Creates a direct deposit transition tags: - direct deposits /directdeposits/transitions/{token}: get: operationId: getDirectdepositsTransitionsToken parameters: - explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/DirectDepositTransitionResponse' description: Success '404': content: { } description: Direct deposit transition not found '500': content: { } description: Server error summary: Returns a direct deposit transition tags: - direct deposits /directdeposits/{token}: get: operationId: getDirectdepositsToken parameters: - explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/DepositDepositResponse' description: Success '404': content: { } description: Direct deposit entry not found '500': content: { } description: Server error summary: Returns a direct deposit entry tags: - direct deposits /feecharges: post: operationId: postFeeCharge requestBody: content: application/json: schema: $ref: '#/components/schemas/fee_transfer_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/fee_transfer_response' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Request already processed with a different payload '422': content: { } description: Rule violations '500': content: { } description: Server error summary: Creates a fee charge tags: - fee charges /feecharges/realtime: post: operationId: postRealTimeFeeCharge requestBody: content: application/json: schema: $ref: '#/components/schemas/realtime_fee_transfer_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/fee_transfer_response' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Request already processed with a different payload '422': content: { } description: Rule violations '500': content: { } description: Server error summary: Creates a realTime fee charge tags: - fee charges /feecharges/{token}: get: operationId: getFeeChargeToken parameters: - explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/fee_transfer_response' description: Success '404': content: { } description: Fee charge not found '500': content: { } description: Server error summary: Returns a fee charge tags: - fee charges /feedback/fraud: post: description: This endpoint is to get a fraud feedback from the customer. requestBody: content: application/json: schema: $ref: '#/components/schemas/FraudFeedbackRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/FraudFeedbackResponse' description: Fraud feedback is created successfully. '400': content: application/json: schema: $ref: '#/components/schemas/BadRequestError' description: Bad Request Error '401': content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' description: Unauthorized Error '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' description: Forbidden Error '500': content: application/json: schema: $ref: '#/components/schemas/InternalServerError' description: Internal Server Error security: - zionToken: [ ] summary: Creates a fraud feedback /feerefunds: post: operationId: postFeeRefunds requestBody: content: application/json: schema: $ref: '#/components/schemas/fee_refund_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/fee_refund_response' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Request already processed with a different payload '422': content: { } description: Rule violations '500': content: { } description: Server error summary: Creates a fee refund tags: - fee refunds /fees: get: operationId: getFees parameters: - description: Number of fees to retrieve explode: true in: query name: count required: false schema: default: 100 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -createdTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/FeeListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all fees tags: - fees post: operationId: postFees requestBody: content: application/json: schema: $ref: '#/components/schemas/fee_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/fee_response' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Request already processed with a different payload '500': content: { } description: Server error summary: Creates a fee tags: - fees /fees/{token}: get: operationId: getFeesToken parameters: - description: Fee token explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/fee_response' description: Success '404': content: { } description: Fee not found '500': content: { } description: Server error summary: Returns a specific fee tags: - fees put: operationId: putFeesToken parameters: - description: Fee token explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/fee_update_request' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/fee_response' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Updates a specific fee tags: - fees /fundingsources/ach: post: operationId: postFundingsourcesAch requestBody: content: application/json: schema: $ref: '#/components/schemas/ach_model' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/ach_response_model' description: Success '400': content: { } description: Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Registers an ACH funding source tags: - funding sources /fundingsources/ach/partner: post: operationId: postFundingsourcesAchPartner requestBody: content: application/json: schema: $ref: '#/components/schemas/ach_partner_request_model' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/ach_response_model' description: Success '400': content: { } description: Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Registers an ACH funding source through a partner tags: - funding sources /fundingsources/ach/partner/{funding_source_token}/balance: get: operationId: getAchPartnerLinkedFundingSourceBalance parameters: - description: Funding source token explode: false in: path name: funding_source_token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/LinkedAccountBalanceResponse' description: Success '400': content: { } description: Bad request '404': content: { } description: Not found '500': content: { } description: Server error summary: Retrieves a linked funding source balance from a partner tags: - funding sources /fundingsources/ach/{funding_source_token}: get: operationId: getFundingsourcesAchFundingsourcetoken parameters: - description: Funding account token explode: false in: path name: funding_source_token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/ach_response_model' description: Success '400': content: { } description: Bad request '404': content: { } description: Not found '500': content: { } description: Server error summary: Returns a user ACH account tags: - funding sources put: operationId: putFundingsourcesAchFundingsourcetoken parameters: - explode: false in: path name: funding_source_token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/ach_verification_model' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/ach_response_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Verifies a bank account as a funding source tags: - funding sources /fundingsources/ach/{funding_source_token}/verificationamounts: get: operationId: getFundingsourcesAchFundingsourcetokenVerificationamounts parameters: - description: Funding account token explode: false in: path name: funding_source_token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/ach_verification_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Returns the dollar amounts used to verify the ACH account tags: - funding sources /fundingsources/addresses: post: operationId: postFundingsourcesAddresses requestBody: content: application/json: schema: $ref: '#/components/schemas/card_holder_address_model' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/CardholderAddressResponse' description: Created '400': content: { } description: Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Creates an account holder address for a funding source tags: - funding sources /fundingsources/addresses/business/{business_token}: get: operationId: getFundingsourcesAddressesBusinessBusinesstoken parameters: - description: Business token explode: false in: path name: business_token required: true schema: type: string style: simple - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/CardholderAddressListResponse' description: Success '400': content: { } description: Bad request '404': content: { } description: Not found '500': content: { } description: Server error summary: Lists all addresses for a business tags: - funding sources /fundingsources/addresses/user/{user_token}: get: operationId: getFundingsourcesAddressesUserUsertoken parameters: - description: User token explode: false in: path name: user_token required: true schema: type: string style: simple - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/CardholderAddressListResponse' description: Success '400': content: { } description: Bad request '404': content: { } description: Not found '500': content: { } description: Server error summary: Lists all addresses for a user tags: - funding sources /fundingsources/addresses/{funding_source_address_token}: get: operationId: getFundingsourcesAddressesFundingsourceaddresstoken parameters: - description: Funding source address token explode: false in: path name: funding_source_address_token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/CardholderAddressResponse' description: Success '400': content: { } description: Bad request '404': content: { } description: Not found '500': content: { } description: Server error summary: Returns a user address for a funding source tags: - funding sources put: operationId: putFundingsourcesAddressesFundingsourceaddresstoken parameters: - description: Funding source address token explode: false in: path name: funding_source_address_token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/card_holder_address_update_model' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/CardholderAddressResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Updates the account holder address for a funding source tags: - funding sources /fundingsources/business/{business_token}: get: operationId: getFundingsourcesBusinessBusinesstoken parameters: - description: Business token explode: false in: path name: business_token required: true schema: type: string style: simple - description: Type, such as a payment card or ACH explode: true in: query name: type required: false schema: type: string style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/FundingAccountListResponse' description: Success '400': content: { } description: Bad request '404': content: { } description: No funding accounts found '500': content: { } description: Server error summary: Lists all funding sources for a business tags: - funding sources /fundingsources/paymentcard: post: operationId: postFundingsourcesPaymentcard requestBody: content: application/json: schema: $ref: '#/components/schemas/token_request' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_card_response_model' description: Success '400': content: { } description: Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Registers a payment card funding source tags: - funding sources /fundingsources/paymentcard/{funding_source_token}: get: operationId: getFundingsourcesPaymentcardFundingsourcetoken parameters: - description: Funding token explode: false in: path name: funding_source_token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_card_response_model' description: Success '400': content: { } description: Bad request '404': content: { } description: Not found '500': content: { } description: Server error summary: Returns a specific payment card tags: - funding sources put: operationId: putFundingsourcesFundingsourcetoken parameters: - description: Funding account token explode: false in: path name: funding_source_token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/token_update_request' description: Payment card required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_card_response_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: 'Updates a specific payment card ' tags: - funding sources /fundingsources/program: post: operationId: postFundingsourcesProgram requestBody: content: application/json: schema: $ref: '#/components/schemas/program_funding_source_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/program_funding_source_response' description: Success '400': content: { } description: Invalid fields detected '409': content: { } description: Request already processed with a different payload '500': content: { } description: Server error summary: Creates a program funding source tags: - funding sources /fundingsources/program/ach: get: operationId: getAllACHFundingSources parameters: - description: Number of items to retrieve. Count can be between 1 - 10 items. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Indicates from what row to start returning data. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Comma delimited list of fields to return (e.g. field_1,field_2,..) explode: true in: query name: fields required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form - description: Returns programs with this active state explode: true in: query name: active required: false schema: type: boolean style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ACHListResponse' description: Success '400': content: { } description: Bad Request '404': content: { } description: Not Found '500': content: { } description: Server error summary: Returns a list of Program ACH funding sources tags: - funding sources post: operationId: postFundingsourcesProgramAch requestBody: content: application/json: schema: $ref: '#/components/schemas/base_ach_request_model' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/base_ach_response_model' description: Success '400': content: { } description: Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Registers an ACH funding source for a program tags: - funding sources /fundingsources/program/{token}: get: operationId: getFundingsourcesProgramToken parameters: - description: Program funding source token explode: false in: path name: token required: true schema: type: string style: simple responses: '201': content: application/json: schema: $ref: '#/components/schemas/program_funding_source_response' description: Success '404': content: { } description: Program funding source not found '500': content: { } description: Server error summary: Returns a specific program funding source tags: - funding sources put: operationId: putFundingsourcesProgramToken parameters: - description: Program funding source token explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/program_funding_source_update_request' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/program_funding_source_response' description: Success '400': content: { } description: Invalid fields detected '500': content: { } description: Server error summary: Updates a specific program funding source tags: - funding sources /fundingsources/programgateway: post: operationId: postFundingsourcesProgramgateway requestBody: content: application/json: schema: $ref: '#/components/schemas/gateway_program_funding_source_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/gateway_program_funding_source_response' description: Success '400': content: { } description: Invalid fields detected '409': content: { } description: Request already processed with a different payload '500': content: { } description: Server error summary: Creates a gateway program funding source tags: - funding sources /fundingsources/programgateway/customheaders/{token}: put: operationId: putFundingsourcesProgramgatewayCustomHeaderToken parameters: - description: Gateway program funding source token explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/gateway_program_custom_header_update_request' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/gateway_program_funding_source_response' description: Success '400': content: { } description: Invalid fields detected '500': content: { } description: Server error summary: Updates a specific gateway program funding source Custom headers tags: - funding sources /fundingsources/programgateway/{token}: get: operationId: getFundingsourcesProgramgatewayToken parameters: - description: Gateway program funding source token explode: false in: path name: token required: true schema: type: string style: simple responses: '201': content: application/json: schema: $ref: '#/components/schemas/gateway_program_funding_source_response' description: Success '404': content: { } description: Gateway program funding source not found '500': content: { } description: Server error summary: Returns a gateway program funding source tags: - funding sources put: operationId: putFundingsourcesProgramgatewayToken parameters: - description: Gateway program funding source token explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/gateway_program_funding_source_update_request' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/gateway_program_funding_source_response' description: Success '400': content: { } description: Invalid fields detected '500': content: { } description: Server error summary: Updates a specific gateway program funding source tags: - funding sources /fundingsources/user/{user_token}: get: operationId: getFundingsourcesUserUsertoken parameters: - description: User token explode: false in: path name: user_token required: true schema: type: string style: simple - description: Type, such as a payment card or ACH explode: true in: query name: type required: false schema: type: string style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/FundingAccountListResponse' description: Success '400': content: { } description: Bad request '404': content: { } description: No funding accounts found '500': content: { } description: Server error summary: Lists all funding sources for a user tags: - funding sources /fundingsources/{funding_source_token}/default: put: operationId: putFundingsourcesFundingsourcetokenDefault parameters: - description: Funding account explode: false in: path name: funding_source_token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_card_response_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Configures a default funding source tags: - funding sources /gpaorders: post: operationId: postGpaorders requestBody: content: application/json: schema: $ref: '#/components/schemas/gpa_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/gpa_response' description: Success '400': content: { } description: Bad request '409': content: { } description: Request already processed with a different payload '422': content: { } description: Rule violations or declined transactions from funding source '500': content: { } description: Server error summary: Funds a user's GPA account tags: - gpa orders /gpaorders/unloads: get: operationId: getGpaordersUnloads parameters: - description: Number of GPA unloads to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form - description: User token explode: true in: query name: user_token required: false schema: type: string style: form - description: Business token explode: true in: query name: business_token required: false schema: type: string style: form - description: Original order token explode: true in: query name: original_order_token required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/GPAUnloadListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all GPA returns tags: - gpa orders post: operationId: postGpaordersUnloads requestBody: content: application/json: schema: $ref: '#/components/schemas/unload_request_model' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/gpa_returns' description: Success '400': content: { } description: Bad request '404': content: { } description: GPA order token not found '412': content: { } description: Pre-condition failed. Unload amount is greater than load amount '500': content: { } description: Server error summary: Returns a GPA order tags: - gpa orders /gpaorders/unloads/{unload_token}: get: operationId: getGpaordersUnloadsUnloadtoken parameters: - description: Unload token explode: false in: path name: unload_token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/gpa_returns' description: Success '400': content: { } description: Bad request '404': content: { } description: Return not found '500': content: { } description: Server error summary: Returns a specific GPA return tags: - gpa orders /gpaorders/{token}: get: operationId: getGpaordersToken parameters: - explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/gpa_response' description: Success '404': content: { } description: GPA order token not found '500': content: { } description: Server error summary: Returns a GPA order tags: - gpa orders /internal/binpools: get: description: Returns a list of all BIN pools operationId: getAllPools responses: default: content: { } description: successful operation summary: Get all BIN pools tags: - Internal - BIN Pools post: description: Creates a new BIN pool operationId: createPool requestBody: content: application/json: schema: $ref: '#/components/schemas/BinPoolCreateRequest' description: Create request required: true responses: default: content: { } description: successful operation summary: Create BIN pool tags: - Internal - BIN Pools /internal/binpools/{token}: delete: description: Soft deletes a BIN pool by setting active=false operationId: deletePool parameters: - description: Pool token explode: false in: path name: token required: true schema: type: string style: simple responses: default: content: { } description: successful operation summary: Delete BIN pool tags: - Internal - BIN Pools get: description: Returns details of a specific BIN pool operationId: getPool parameters: - description: Pool token explode: false in: path name: token required: true schema: type: string style: simple responses: default: content: { } description: successful operation summary: Get BIN pool by token tags: - Internal - BIN Pools put: description: Updates an existing BIN pool operationId: updatePool parameters: - description: Pool token explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/BinPoolUpdateRequest' description: Update request required: true responses: default: content: { } description: successful operation summary: Update BIN pool tags: - Internal - BIN Pools /kyc: post: operationId: postKyc requestBody: content: application/json: schema: $ref: '#/components/schemas/kyc_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/kyc_response' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Request already processed with a different payload '500': content: { } description: Server error summary: Performs a KYC tags: - kyc /kyc/business/{business_token}: get: operationId: getKycBusinessBusinesstoken parameters: - description: Business token explode: false in: path name: business_token required: true schema: type: string style: simple - description: Number of items to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -createdTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/KYCListResponse' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Lists all KYC results for a business tags: - kyc /kyc/user/{user_token}: get: operationId: getKycUserUsertoken parameters: - description: User token explode: false in: path name: user_token required: true schema: type: string style: simple - description: Number of items to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -createdTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/KYCListResponse' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Lists all KYC results for a user tags: - kyc /kyc/{token}: get: operationId: getKycToken parameters: - description: KYC token explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/kyc_response' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: KYC not found '500': content: { } description: Server error summary: Returns a specific KYC result tags: - kyc /mccgroups: get: operationId: getMccgroups parameters: - description: MCC explode: true in: query name: mcc required: false schema: type: string style: form - description: Number of items to retrieve. Count can be between 1 - 10 items. explode: true in: query name: count required: false schema: default: 10 format: int32 type: integer style: form - description: Indicates from what row to start returning data. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Field by which to sort the returned items. Use any field in the model, or system fields lastModifiedTime or createdTime. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/MCCGroupListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all MCC groups tags: - mcc groups post: operationId: postMccgroups requestBody: content: application/json: schema: $ref: '#/components/schemas/mcc_group_model' description: MCC group required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/mcc_group_model' description: Created '400': content: { } description: Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Creates an MCC group tags: - mcc groups /mccgroups/{token}: get: operationId: getMccgroupsToken parameters: - description: MCC group token explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/mcc_group_model' description: Success '400': content: { } description: Bad request '404': content: { } description: MCC group not found '500': content: { } description: Server error summary: Returns a specific MCC group tags: - mcc groups put: operationId: putMccgroupsToken parameters: - explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/mcc_group_update_model' description: MCC group required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/mcc_group_update_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Updates an MCC group tags: - mcc groups /merchantgroups: get: operationId: getMerchantGroups parameters: - description: mid explode: true in: query name: mid required: false schema: type: string style: form - description: Number of items to retrieve. Count can be between 1 - 10 items. explode: true in: query name: count required: false schema: default: 10 format: int32 type: integer style: form - description: Indicates from what row to start returning data. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Field by which to sort the returned items. Use any field in the model, or system fields lastModifiedTime or createdTime. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/MerchantGroupListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all Merchant Groups tags: - merchantgroups post: operationId: postMerchantGroup requestBody: content: application/json: schema: $ref: '#/components/schemas/merchant_group_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/merchant_group_response' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Creates a merchant group tags: - merchantgroups /merchantgroups/{token}: get: operationId: getMerchantGroup parameters: - description: Merchant Group token explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/merchant_group_response' description: Success '400': content: { } description: Bad request '404': content: { } description: Merchant Group not found '500': content: { } description: Server error summary: Returns a Merchant Group tags: - merchantgroups put: operationId: putMerchantGroupsToken parameters: - explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/merchant_group_update_request' description: Merchant Group required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/merchant_group_response' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Updates an Merchant Group tags: - merchantgroups /migrations/accounts/{account_token}/finalize: get: description: | Called to retrieve the finalize status of a migrated account operationId: getFinalizeAccountMigrationStatus parameters: - description: |- Unique identifier of the credit account for which you want to get the finalize status. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/FinalizeMigrationStatusResponse' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Get finalize status tags: - Migrations /migrations/accounts/{account_token}/getaccountbalances: get: description: Retrieve the current balance, available credit for a credit account. operationId: getAccountBalances parameters: - description: |- Unique identifier of the credit account for which you want to retrieve fees. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/CalculatedBalanceResponse' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Get the current balance and available credit for a credit account tags: - Migrations /migrations/accounts/{account_token}/statements/{statement_summary_token}/files: post: description: Sync a statement asset to a migrated statement summary. operationId: syncStatementAsset parameters: - description: |- Unique identifier of the credit account for which you want to sync a statement asset. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: Unique identifier of the migrated statement summary for which you want to sync an asset. explode: false in: path name: statement_summary_token required: true schema: type: string x-allowableValues: Existing statement summary token style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SyncStatementAssetReq' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/MigrationResponse' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - nileToken: [ ] summary: Sync statement asset tags: - Migrations /paymentsources: get: description: |- Retrieve an array of payment sources. This endpoint supports <>. operationId: listPaymentSources parameters: - description: Unique identifier of the credit account associated with the payment source. explode: true in: query name: account_token required: false schema: type: string x-allowableValues: Existing account token style: form - description: Unique identifier of the user associated with the payment source. explode: true in: query name: user_token required: false schema: type: string x-allowableValues: Existing user token style: form - description: Unique identifier of the business associated with the payment source. explode: true in: query name: business_token required: false schema: type: string x-allowableValues: Existing business token style: form - description: Number of payment source resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form - description: Array of statuses to use for filtering payment sources. explode: true in: query name: statuses required: false schema: items: $ref: '#/components/schemas/PaymentSourceStatusEnum' type: array style: form responses: '200': content: application/json: example: count: 1 data: - account_suffix: '5678' account_token: my_account_token_12 created_time: 2025-05-19T19:19:24Z last_modified_time: 2025-05-19T19:19:24Z name: John Jacob owner: INDIVIDUAL routing_number: payment_source_routing_number source_type: CHECKING status: ACTIVE token: my_payment_source_token_6789 user_token: user5678 verification_status: ACH_VERIFIED end_index: 0 is_more: true start_index: 0 schema: $ref: '#/components/schemas/PaymentSourcePage' description: Response containing a list of all payment sources for a provided account default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List payment sources tags: - Payment Sources post: description: Create a payment source from which to make payments. operationId: createPaymentSource parameters: [ ] requestBody: content: application/json: example: account_number: 4567_payment_source_account_number account_token: my_account_token_12 name: John Jacob owner: INDIVIDUAL routing_number: 56789_payment_source_routing_number source_type: CHECKING token: my_payment_source_token_6789 user_token: user5678 verification_override: true schema: $ref: '#/components/schemas/PaymentSourceCreateReq' required: true responses: '201': content: application/json: example: account_suffix: '5678' account_token: my_account_token_12 created_time: 2025-05-19T19:19:24Z last_modified_time: 2025-05-19T19:19:24Z name: John Jacob owner: INDIVIDUAL routing_number: payment_source_routing_number source_type: CHECKING status: ACTIVE token: my_payment_source_token_6789 user_token: user5678 verification_status: ACH_VERIFIED schema: $ref: '#/components/schemas/PaymentSourceResponse' description: Response containing the created payment source default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create payment source tags: - Payment Sources /paymentsources/{token}: get: description: Retrieve a payment source. operationId: retrievePaymentSource parameters: - description: |- Unique identifier of the payment source to retrieve. Send a `GET` request to `/credit/paymentsources` to retrieve existing payment source tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing payment source token style: simple responses: '200': content: application/json: example: account_suffix: '5678' account_token: my_account_token_12 created_time: 2025-05-19T19:19:24Z last_modified_time: 2025-05-19T19:19:24Z name: John Jacob owner: INDIVIDUAL routing_number: payment_source_routing_number source_type: CHECKING status: ACTIVE token: my_payment_source_token_6789 user_token: user5678 verification_status: ACH_VERIFIED schema: $ref: '#/components/schemas/PaymentSourceResponse' description: Response containing details for the requested payment source default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve payment source tags: - Payment Sources put: description: Update details of a payment source. operationId: updatePaymentSource parameters: - description: |- Unique identifier of the payment source to retrieve. Send a `GET` request to `/credit/paymentsources` to retrieve existing payment source tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing payment source token style: simple requestBody: content: application/json: example: status: ACTIVE schema: $ref: '#/components/schemas/PaymentSourceUpdateReq' required: true responses: '200': content: application/json: example: account_suffix: '5678' account_token: my_account_token_12 created_time: 2025-05-19T19:19:24Z last_modified_time: 2025-05-19T19:19:24Z name: John Jacob owner: INDIVIDUAL routing_number: payment_source_routing_number source_type: CHECKING status: ACTIVE token: my_payment_source_token_6789 user_token: user5678 verification_status: ACH_VERIFIED schema: $ref: '#/components/schemas/PaymentSourceResponse' description: Response containing updated payment source default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Update payment source tags: - Payment Sources /peertransfers: post: operationId: postPeertransfers requestBody: content: application/json: schema: $ref: '#/components/schemas/peer_transfer_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/peer_transfer_response' description: Success '400': content: { } description: 'Invalid fields detected: either sender or recipient is not found' '409': content: { } description: Request already processed with a different payload '422': content: { } description: Rule violations '500': content: { } description: Server error summary: Performs a peer transfer from one user to another tags: - peer transfers /peertransfers/user/{user_or_business_token}: get: operationId: getPeertransfersUserUserorbusinesstoken parameters: - description: User or business token explode: false in: path name: user_or_business_token required: true schema: type: string style: simple - description: Number of transfers to retrieve explode: true in: query name: count required: false schema: default: 25 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/peer_transfer_response' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Returns all peer transfers for a user tags: - peer transfers /peertransfers/user/{user_or_business_token}/recipient: get: operationId: getPeertransfersUserUserorbusinesstokenRecipient parameters: - description: User or business token explode: false in: path name: user_or_business_token required: true schema: type: string style: simple - description: Number of transfers to retrieve explode: true in: query name: count required: false schema: default: 25 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/peer_transfer_response' description: Success '404': content: { } description: User token not found '500': content: { } description: Server error summary: Returns received peer transfers for a user tags: - peer transfers /peertransfers/user/{user_or_business_token}/sender: get: operationId: getPeertransfersUserUserorbusinesstokenSender parameters: - description: User or business token explode: false in: path name: user_or_business_token required: true schema: type: string style: simple - description: Number of transfers to retrieve explode: true in: query name: count required: false schema: default: 25 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/peer_transfer_response' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Returns sent peer transfers for a user tags: - peer transfers /peertransfers/{token}: get: operationId: getPeertransfersToken parameters: - explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/peer_transfer_response' description: Success '404': content: { } description: Transfer token not found '500': content: { } description: Server error summary: Returns details of a previous transfer tags: - peer transfers /ping: get: description: Tests if the Marqeta server is available and responsive. operationId: getPing responses: '200': content: application/json: schema: $ref: '#/components/schemas/ping_response' description: Success '500': content: { } description: Server error summary: Returns a heartbeat to the consumer tags: - ping post: operationId: postPing requestBody: content: application/json: schema: $ref: '#/components/schemas/echo_ping_request' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/echo_ping_response' description: Success '500': content: { } description: Server error summary: Echo test for sending payload to server tags: - ping /pins: put: description: |- Creates or updates a personal identification number (PIN) for an existing card. Although cardholders might choose a four-, five-, or six-digit PIN if they set their PIN at an automated teller machine, they can only set a four-digit PIN using Marqeta's Set PIN widget or the create or update PIN endpoint (`PUT /pins`). Cardholders can update their PIN through the API regardless of its length, but the new PIN value they choose must contain four digits. If you want to manage a card's PIN, first create a new control token for the card by sending a `POST` request to `/pins/controltoken`, and then use that token to update the PIN. You must create a card before you can manage a PIN. Unless PIN reveal functionality has been enabled for your program, you cannot retrieve a PIN that has previously been created. If the PIN has been forgotten, you must either update the card's PIN or create a new card and PIN. If you have enabled PIN reveal functionality for your program, you can send a `POST` request to the `/pins/reveal` endpoint to retrieve an existing PIN. See <> on this page for details. [WARNING] Sending a request to this endpoint requires PCI DSS compliance. You must comply with PCI DSS data security requirements if you want to store, transmit, or process sensitive card data such as the cardholder's primary account number (PAN), personal identification number (PIN), and card expiration date. operationId: putPins requestBody: content: application/json: example: control_token: b4647c9a-d4b8-4091-a5ff-dd67a7bb9ffc pin: '5678' schema: $ref: '#/components/schemas/pin_request' required: false responses: '204': content: { } description: PIN was successfully set '400': content: { } description: Bad request '412': content: { } description: Weak PIN '500': content: { } description: Server error summary: Create or update PIN tags: - PINs /pins/controltoken: post: description: |- Creates a control token necessary when creating or updating a card's personal identification number (PIN). Creating, updating, or revealing a card's PIN is a two-step process. You must first create the control token that is required to create the PIN, and then you create, update, or reveal the PIN itself. The lifespan of the control token in a production environment is either five minutes or one hour from creation, depending on the token type. If multiple tokens are requested for a single card, only the most recent one is valid. Once redeemed, a token cannot be reused. operationId: postPinsControltoken requestBody: content: application/json: example: card_token: my_card_01 controltoken_type: SET_PIN schema: $ref: '#/components/schemas/control_token_request' required: false responses: '201': content: application/json: example: control_token: b4647c9a-d4b8-4091-a5ff-dd67a7bb9ffc schema: $ref: '#/components/schemas/control_token_response' description: Control token created '400': content: { } description: Bad request '403': content: { } description: Forbidden '500': content: { } description: Server error summary: Create PIN control token tags: - PINs /pins/reveal: post: description: |- Reveals the personal identification number (PIN) of an existing, active card. Be aware that while a cardholder can only set a four-digit PIN using the Marqeta Set PIN widget or `PUT /pins` API, you may see a four-, five-, or six-digit PIN in cases where your cardholders have set a new PIN at an automated teller machine. [WARNING] Only use this endpoint to access a PIN in order to reveal it to its cardholder. Do not use this endpoint for the purpose of storing a PIN at any location. Sending a request to this endpoint requires PCI DSS compliance. You must comply with PCI DSS data security requirements if you want to store, transmit, or process sensitive card data such as the cardholder's primary account number (PAN), personal identification number (PIN), and card expiration date. If you want to update a card's PIN instead, send a `PUT` request to the `/pins` endpoint. See <> on this page for details. Revealing a card's PIN is a two-step process. You must first create a new control token for the card by sending a `POST` request to `/pins/controltoken`, and then use that token to reveal the PIN. operationId: revealPins requestBody: content: application/json: example: cardholder_verification_method: BIOMETRIC_FINGERPRINT control_token: b4647c9a-d4b8-4091-a5ff-dd67a7bb9ffc schema: $ref: '#/components/schemas/pin_reveal_request' required: false responses: '204': content: { } description: PIN was successfully revealed '400': content: { } description: Bad request '500': content: { } description: Server error summary: Reveal PIN tags: - PINs /policies/aprs: get: description: |- Retrieve an array of existing APR policies. This endpoint supports <>. operationId: getAprPolicies parameters: - description: Number of APR policy resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `effectiveDate`, and not by the field names appearing in response bodies such as `effective_date`. explode: true in: query name: sort_by required: false schema: default: -effectiveDate enum: - effectiveDate - -effectiveDate type: string style: form responses: '200': content: application/json: example: count: 2 data: - created_time: 2025-04-01T23:41:58.802Z description: A gold APR policy effective_date: 2025-05-01 name: Gold APR Policy purchases: external_token: my_external_purchase_token1234 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 1 - apr: 0 margin_rate: 5 token: my_apr_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z - created_time: 2025-04-01T23:41:58.802Z description: A silver APR policy effective_date: 2025-06-01 name: Silver APR Policy purchases: external_token: my_external_purchase_token4321 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 3 - apr: 0 margin_rate: 6 token: my_apr_policy_token_4321 updated_time: 2025-04-05T16:04:48.643Z end_index: 2 is_more: true start_index: 0 schema: $ref: '#/components/schemas/PolicyAprsPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List APR policies tags: - Policies post: description: Create a new annual percentage rate (APR) policy. operationId: createAprPolicy parameters: [ ] requestBody: content: application/json: example: description: A gold APR policy name: Gold APR Policy purchases: external_token: my_external_purchase_token1234 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 1 - apr: 0 margin_rate: 5 token: my_apr_policy_token_1234 schema: $ref: '#/components/schemas/PolicyAprCreateReq' required: true responses: '201': content: application/json: example: created_time: 2025-04-01T23:41:58.802Z description: A gold APR policy effective_date: 2025-05-01 name: Gold APR Policy purchases: external_token: my_external_purchase_token1234 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 1 - apr: 0 margin_rate: 5 token: my_apr_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/PolicyAprResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create APR policy tags: - Policies /policies/aprs/{token}: get: description: |- Retrieve a specific annual percentage rate (APR) policy. This endpoint supports <>. operationId: getAprPolicyByToken parameters: - description: |- Unique identifier of the APR policy to retrieve. Send a `GET` request to `/policies/aprs` to retrieve existing APR policy tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing APR policy token style: simple responses: '200': content: application/json: example: created_time: 2025-04-01T23:41:58.802Z description: A gold APR policy effective_date: 2025-05-01 name: Gold APR Policy purchases: external_token: my_external_purchase_token1234 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 1 - apr: 0 margin_rate: 5 token: my_apr_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/PolicyAprResponse' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve APR policy tags: - Policies put: description: Update a specific APR policy. operationId: updateAprPolicyWithToken parameters: - description: |- Unique identifier of the APR policy to update. Send a `GET` request to `/policies/aprs` to retrieve existing APR policy tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing APR policy token style: simple requestBody: content: application/json: example: description: Description of the renamed APR Policy name: Renamed APR Policy purchases: external_token: my_external_purchase_token1234 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 1 - apr: 0 margin_rate: 5 token: my_apr_policy_token_1234 schema: $ref: '#/components/schemas/PolicyAprUpdateReq' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PolicyAprResponse' description: Expected response default: content: application/json: example: created_time: 2025-04-01T23:41:58.802Z description: Description of the renamed APR Policy effective_date: 2025-05-01 name: Renamed APR Policy purchases: external_token: my_external_purchase_token1234 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 1 - apr: 0 margin_rate: 5 token: my_apr_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Update APR policy tags: - Policies /policies/aprs/{token}/clone: post: description: Create a new annual percentage rate (APR) policy based on an existing APR policy. operationId: cloneAprPolicy parameters: - description: |- Unique identifier of the APR policy to clone. Send a `GET` request to `/policies/aprs` to retrieve existing APR policy tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing APR policy token style: simple responses: '201': content: application/json: example: created_time: 2025-04-01T23:41:58.802Z description: A gold APR policy effective_date: 2025-05-01 name: Gold APR Policy purchases: external_token: my_external_purchase_token1234 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 1 - apr: 0 margin_rate: 5 token: my_apr_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/PolicyAprResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Clone APR policy tags: - Policies /policies/aprs/{token}/schedule: get: description: |- Retrieve an array of the historic annual percentage rate (APR) schedules on a specific APR policy. This endpoint supports <>. operationId: getAprPolicySchedulesWithToken parameters: - description: |- Unique identifier of the APR policy on which to retrieve APR schedules. Send a `GET` request to `/policies/aprs` to retrieve existing product policy tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing APR policy token style: simple - description: Number of APR schedule resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 2 data: - created_time: 2025-04-01T23:41:58.802Z description: A gold APR policy effective_date: 2025-05-01 name: Gold APR Policy purchases: external_token: my_external_purchase_token1234 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 1 - apr: 0 margin_rate: 5 token: my_apr_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z - created_time: 2025-04-01T23:41:58.802Z description: A silver APR policy effective_date: 2025-06-01 name: Silver APR Policy purchases: external_token: my_external_purchase_token4321 name: A purchase at a merchant tiers: - apr: 0 margin_rate: 1 - apr: 0 margin_rate: 5 token: my_apr_policy_token_4321 updated_time: 2025-04-05T16:04:48.643Z end_index: 2 is_more: true start_index: 0 schema: $ref: '#/components/schemas/PolicyAprsPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List APR schedules tags: - Policies /policies/documents: get: description: |- Retrieve an array of existing document policies. A document policy consists of all the pre- and post-application disclosures and credit program documents known as assets and templates. Assets contain finalized values after a bundle is created; templates do not contain finalized values. This endpoint supports <>. operationId: listDocumentPolicies parameters: - description: Number of document policy resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 2 data: - account_statement: template_token: an_account_statement_template_token1234 template_urls: html: https://url.com/an_account_statement_template_token1234.html benefits_disclosure_premium: asset_token: a_benefits_disclosure_premium_asset_token1234 asset_urls: html: https://url.com/a_benefits_disclosure_premium_asset_token1234.html pdf: https://url.com/a_benefits_disclosure_premium_asset_token1234.pdf png: https://url.com/a_benefits_disclosure_premium_asset_token1234.png benefits_disclosure_traditional: asset_token: a_benefits_disclosure_traditional_asset_token1234 asset_urls: html: https://url.com/a_benefits_disclosure_traditional_asset_token1234.html pdf: https://url.com/a_benefits_disclosure_traditional_asset_token1234.pdf png: https://url.com/a_benefits_disclosure_traditional_asset_token1234.png card_member_agreement: asset_token: a_card_member_agreement_asset_token1234 asset_urls: html: https://url.com/a_card_member_agreement_asset_token1234.html pdf: https://url.com/a_card_member_agreement_asset_token1234.pdf png: https://url.com/a_card_member_agreement_asset_token1234.png created_time: 2025-04-01T23:41:58.802Z e_disclosure: asset_token: a_e_disclosure_asset_token1234 asset_urls: html: https://url.com/a_e_disclosure_asset_token1234.html pdf: https://url.com/a_e_disclosure_asset_token1234.pdf png: https://url.com/a_e_disclosure_asset_token1234.png name: My Document Policy noaa_multiple_reason_with_dodd_frank: template_token: an_noaa_multiple_reason_with_dodd_frank_template_token1234 template_urls: html: https://url.com/an_noaa_multiple_reason_with_dodd_frank_template_token1234.html noaa_single_reason: template_token: an_noaa_single_reason_template_token1234 template_urls: html: https://url.com/an_noaa_single_reason_template_token1234.html noaa_single_reason_with_dodd_frank: template_token: an_noaa_single_reason_with_dodd_frank_template_token1234 template_urls: html: https://url.com/an_noaa_single_reason_with_dodd_frank_template_token1234.html pre_qualification_disclosure: asset_token: a_pre_qualification_disclosure_asset_token1234 asset_urls: html: https://url.com/a_pre_qualification_disclosure_asset_token1234.html pdf: https://url.com/a_pre_qualification_disclosure_asset_token1234.pdf png: https://url.com/a_pre_qualification_disclosure_asset_token1234.png template_token: a_pre_qualification_disclosure_template_token1234 template_urls: html: https://url.com/a_pre_qualification_disclosure_template_token1234.html privacy_policy: asset_token: a_privacy_policy_asset_token1234 asset_urls: html: https://url.com/a_privacy_policy_asset_token1234.html pdf: https://url.com/a_privacy_policy_asset_token1234.pdf png: https://url.com/a_privacy_policy_asset_token1234.png rewards_disclosure: asset_token: a_rewards_disclosure_asset_token1234 asset_urls: html: https://url.com/a_rewards_disclosure_asset_token1234.html pdf: https://url.com/a_rewards_disclosure_asset_token1234.pdf png: https://url.com/a_rewards_disclosure_asset_token1234.png template_token: a_rewards_disclosure_template_token1234 template_urls: html: https://url.com/a_rewards_disclosure_template_token1234.html summary_of_credit_terms: asset_token: a_summary_of_credit_terms_asset_token1234 asset_urls: html: https://url.com/a_summary_of_credit_terms_asset_token1234.html pdf: https://url.com/a_summary_of_credit_terms_asset_token1234.pdf png: https://url.com/a_summary_of_credit_terms_asset_token1234.png template_token: a_summary_of_credit_terms_template_token1234 template_urls: html: https://asset-bucket.s3.amazonaws.com/short_code/a_summary_of_credit_terms_template_token1234/a_summary_of_credit_terms_template_token1234.html terms_schedule: template_token: a_terms_schedule_template_token1234 template_urls: html: https://url.com/a_terms_schedule_template_token1234.html token: my_document_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z - account_statement: template_token: an_account_statement_template_token4321 template_urls: html: https://url.com/an_account_statement_template_token4321.html benefits_disclosure_premium: asset_token: a_benefits_disclosure_premium_asset_token4321 asset_urls: html: https://url.com/a_benefits_disclosure_premium_asset_token4321.html pdf: https://url.com/a_benefits_disclosure_premium_asset_token4321.pdf png: https://url.com/a_benefits_disclosure_premium_asset_token4321.png benefits_disclosure_traditional: asset_token: a_benefits_disclosure_traditional_asset_token4321 asset_urls: html: https://url.com/a_benefits_disclosure_traditional_asset_token4321.html pdf: https://url.com/a_benefits_disclosure_traditional_asset_token4321.pdf png: https://url.com/a_benefits_disclosure_traditional_asset_token4321.png card_member_agreement: asset_token: a_card_member_agreement_asset_token4321 asset_urls: html: https://url.com/a_card_member_agreement_asset_token4321.html pdf: https://url.com/a_card_member_agreement_asset_token4321.pdf png: https://url.com/a_card_member_agreement_asset_token4321.png created_time: 2025-04-01T23:41:58.802Z e_disclosure: asset_token: a_e_disclosure_asset_token4321 asset_urls: html: https://url.com/a_e_disclosure_asset_token4321.html pdf: https://url.com/a_e_disclosure_asset_token4321.pdf png: https://url.com/a_e_disclosure_asset_token4321.png name: Silver Document Policy noaa_multiple_reason_with_dodd_frank: template_token: an_noaa_multiple_reason_with_dodd_frank_template_token4321 template_urls: html: https://url.com/an_noaa_multiple_reason_with_dodd_frank_template_token4321.html noaa_single_reason: template_token: an_noaa_single_reason_template_token4321 template_urls: html: https://url.com/an_noaa_single_reason_template_token4321.html noaa_single_reason_with_dodd_frank: template_token: an_noaa_single_reason_with_dodd_frank_template_token4321 template_urls: html: https://url.com/an_noaa_single_reason_with_dodd_frank_template_token4321.html pre_qualification_disclosure: asset_token: a_pre_qualification_disclosure_asset_token4321 asset_urls: html: https://url.com/a_pre_qualification_disclosure_asset_token4321.html pdf: https://url.com/a_pre_qualification_disclosure_asset_token4321.pdf png: https://url.com/a_pre_qualification_disclosure_asset_token4321.png template_token: a_pre_qualification_disclosure_template_token4321 template_urls: html: https://url.com/a_pre_qualification_disclosure_template_token4321.html privacy_policy: asset_token: a_privacy_policy_asset_token4321 asset_urls: html: https://url.com/a_privacy_policy_asset_token4321.html pdf: https://url.com/a_privacy_policy_asset_token4321.pdf png: https://url.com/a_privacy_policy_asset_token4321.png rewards_disclosure: asset_token: a_rewards_disclosure_asset_token4321 asset_urls: html: https://url.com/a_rewards_disclosure_asset_token4321.html pdf: https://url.com/a_rewards_disclosure_asset_token4321.pdf png: https://url.com/a_rewards_disclosure_asset_token4321.png template_token: a_rewards_disclosure_template_token4321 template_urls: html: https://url.com/a_rewards_disclosure_template_token4321.html summary_of_credit_terms: asset_token: a_summary_of_credit_terms_asset_token4321 asset_urls: html: https://url.com/a_summary_of_credit_terms_asset_token4321.html pdf: https://url.com/a_summary_of_credit_terms_asset_token4321.pdf png: https://url.com/a_summary_of_credit_terms_asset_token4321.png template_token: a_summary_of_credit_terms_template_token4321 template_urls: html: https://url.com/a_summary_of_credit_terms_template_token4321.html terms_schedule: template_token: a_terms_schedule_template_token4321 template_urls: html: https://url.com/a_terms_schedule_template_token4321.html token: my_document_policy_token_4321 updated_time: 2025-04-05T16:04:48.643Z end_index: 2 is_more: true start_index: 0 schema: $ref: '#/components/schemas/PoliciesDocumentPage' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List document policies tags: - Policies post: description: |- Create a new document policy, which consists of all the pre- and post-application disclosures and credit program documents known as assets and templates. Assets contain finalized values after a bundle is created; templates do not contain finalized values. operationId: createDocumentPolicy parameters: [ ] requestBody: content: application/json: example: account_statement: template_token: an_account_statement_template_token1234 benefits_disclosure_premium: asset_token: a_benefits_disclosure_premium_asset_token1234 benefits_disclosure_traditional: asset_token: a_benefits_disclosure_traditional_asset_token1234 card_member_agreement: asset_token: a_card_member_agreement_asset_token1234 e_disclosure: asset_token: a_e_disclosure_asset_token1234 name: My Document Policy noaa_multiple_reason_with_dodd_frank: template_token: an_noaa_multiple_reason_with_dodd_frank_template_token1234 noaa_single_reason: template_token: an_noaa_single_reason_template_token1234 noaa_single_reason_with_dodd_frank: template_token: an_noaa_single_reason_with_dodd_frank_template_token1234 pre_qualification_disclosure: asset_token: a_pre_qualification_disclosure_asset_token1234 template_token: a_pre_qualification_disclosure_template_token1234 privacy_policy: asset_token: a_privacy_policy_asset_token1234 rewards_disclosure: asset_token: a_rewards_disclosure_asset_token1234 template_token: a_rewards_disclosure_template_token1234 summary_of_credit_terms: asset_token: a_summary_of_credit_terms_asset_token1234 template_token: a_summary_of_credit_terms_template_token1234 terms_schedule: template_token: a_terms_schedule_template_token1234 token: my_document_policy_token_1234 schema: $ref: '#/components/schemas/PolicyDocumentCreateReq' required: true responses: '201': content: application/json: example: account_statement: template_token: an_account_statement_template_token1234 template_urls: html: https://url.com/an_account_statement_template_token1234.html benefits_disclosure_premium: asset_token: a_benefits_disclosure_premium_asset_token1234 asset_urls: html: https://url.com/a_benefits_disclosure_premium_asset_token1234.html pdf: https://url.com/a_benefits_disclosure_premium_asset_token1234.pdf png: https://url.com/a_benefits_disclosure_premium_asset_token1234.png benefits_disclosure_traditional: asset_token: a_benefits_disclosure_traditional_asset_token1234 asset_urls: html: https://url.com/a_benefits_disclosure_traditional_asset_token1234.html pdf: https://url.com/a_benefits_disclosure_traditional_asset_token1234.pdf png: https://url.com/a_benefits_disclosure_traditional_asset_token1234.png card_member_agreement: asset_token: a_card_member_agreement_asset_token1234 asset_urls: html: https://url.com/a_card_member_agreement_asset_token1234.html pdf: https://url.com/a_card_member_agreement_asset_token1234.pdf png: https://url.com/a_card_member_agreement_asset_token1234.png created_time: 2025-04-01T23:41:58.802Z e_disclosure: asset_token: a_e_disclosure_asset_token1234 asset_urls: html: https://url.com/a_e_disclosure_asset_token1234.html pdf: https://url.com/a_e_disclosure_asset_token1234.pdf png: https://url.com/a_e_disclosure_asset_token1234.png name: My Document Policy noaa_multiple_reason_with_dodd_frank: template_token: an_noaa_multiple_reason_with_dodd_frank_template_token1234 template_urls: html: https://url.com/an_noaa_multiple_reason_with_dodd_frank_template_token1234.html noaa_single_reason: template_token: an_noaa_single_reason_template_token1234 template_urls: html: https://url.com/an_noaa_single_reason_template_token1234.html noaa_single_reason_with_dodd_frank: template_token: an_noaa_single_reason_with_dodd_frank_template_token1234 template_urls: html: https://url.com/an_noaa_single_reason_with_dodd_frank_template_token1234.html pre_qualification_disclosure: asset_token: a_pre_qualification_disclosure_asset_token1234 asset_urls: html: https://url.com/a_pre_qualification_disclosure_asset_token1234.html pdf: https://url.com/a_pre_qualification_disclosure_asset_token1234.pdf png: https://url.com/a_pre_qualification_disclosure_asset_token1234.png template_token: a_pre_qualification_disclosure_template_token1234 template_urls: html: https://url.com/a_pre_qualification_disclosure_template_token1234.html privacy_policy: asset_token: a_privacy_policy_asset_token1234 asset_urls: html: https://url.com/a_privacy_policy_asset_token1234.html pdf: https://url.com/a_privacy_policy_asset_token1234.pdf png: https://url.com/a_privacy_policy_asset_token1234.png rewards_disclosure: asset_token: a_rewards_disclosure_asset_token1234 asset_urls: html: https://url.com/a_rewards_disclosure_asset_token1234.html pdf: https://url.com/a_rewards_disclosure_asset_token1234.pdf png: https://url.com/a_rewards_disclosure_asset_token1234.png template_token: a_rewards_disclosure_template_token1234 template_urls: html: https://url.com/a_rewards_disclosure_template_token1234.html summary_of_credit_terms: asset_token: a_summary_of_credit_terms_asset_token1234 asset_urls: html: https://url.com/a_summary_of_credit_terms_asset_token1234.html pdf: https://url.com/a_summary_of_credit_terms_asset_token1234.pdf png: https://url.com/a_summary_of_credit_terms_asset_token1234.png template_token: a_summary_of_credit_terms_template_token1234 template_urls: html: https://asset-bucket.s3.amazonaws.com/short_code/a_summary_of_credit_terms_template_token1234/a_summary_of_credit_terms_template_token1234.html terms_schedule: template_token: a_terms_schedule_template_token1234 template_urls: html: https://url.com/a_terms_schedule_template_token1234.html token: my_document_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/PolicyDocumentResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create document policy tags: - Policies /policies/documents/{token}: get: description: |- Retrieve a specific document policy, which consists of all the pre- and post-application disclosures and credit program documents known as assets and templates. Assets contain finalized values after a bundle is created; templates do not contain finalized values. operationId: retrieveDocumentPolicy parameters: - description: |- Unique identifier of the document policy to retrieve. Send a `GET` request to `/policies/documents` to retrieve existing document policy tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing document policy token style: simple responses: '200': content: application/json: example: account_statement: template_token: an_account_statement_template_token1234 template_urls: html: https://url.com/an_account_statement_template_token1234.html benefits_disclosure_premium: asset_token: a_benefits_disclosure_premium_asset_token1234 asset_urls: html: https://url.com/a_benefits_disclosure_premium_asset_token1234.html pdf: https://url.com/a_benefits_disclosure_premium_asset_token1234.pdf png: https://url.com/a_benefits_disclosure_premium_asset_token1234.png benefits_disclosure_traditional: asset_token: a_benefits_disclosure_traditional_asset_token1234 asset_urls: html: https://url.com/a_benefits_disclosure_traditional_asset_token1234.html pdf: https://url.com/a_benefits_disclosure_traditional_asset_token1234.pdf png: https://url.com/a_benefits_disclosure_traditional_asset_token1234.png card_member_agreement: asset_token: a_card_member_agreement_asset_token1234 asset_urls: html: https://url.com/a_card_member_agreement_asset_token1234.html pdf: https://url.com/a_card_member_agreement_asset_token1234.pdf png: https://url.com/a_card_member_agreement_asset_token1234.png created_time: 2025-04-01T23:41:58.802Z e_disclosure: asset_token: a_e_disclosure_asset_token1234 asset_urls: html: https://url.com/a_e_disclosure_asset_token1234.html pdf: https://url.com/a_e_disclosure_asset_token1234.pdf png: https://url.com/a_e_disclosure_asset_token1234.png name: My Document Policy noaa_multiple_reason_with_dodd_frank: template_token: an_noaa_multiple_reason_with_dodd_frank_template_token1234 template_urls: html: https://url.com/an_noaa_multiple_reason_with_dodd_frank_template_token1234.html noaa_single_reason: template_token: an_noaa_single_reason_template_token1234 template_urls: html: https://url.com/an_noaa_single_reason_template_token1234.html noaa_single_reason_with_dodd_frank: template_token: an_noaa_single_reason_with_dodd_frank_template_token1234 template_urls: html: https://url.com/an_noaa_single_reason_with_dodd_frank_template_token1234.html pre_qualification_disclosure: asset_token: a_pre_qualification_disclosure_asset_token1234 asset_urls: html: https://url.com/a_pre_qualification_disclosure_asset_token1234.html pdf: https://url.com/a_pre_qualification_disclosure_asset_token1234.pdf png: https://url.com/a_pre_qualification_disclosure_asset_token1234.png template_token: a_pre_qualification_disclosure_template_token1234 template_urls: html: https://url.com/a_pre_qualification_disclosure_template_token1234.html privacy_policy: asset_token: a_privacy_policy_asset_token1234 asset_urls: html: https://url.com/a_privacy_policy_asset_token1234.html pdf: https://url.com/a_privacy_policy_asset_token1234.pdf png: https://url.com/a_privacy_policy_asset_token1234.png rewards_disclosure: asset_token: a_rewards_disclosure_asset_token1234 asset_urls: html: https://url.com/a_rewards_disclosure_asset_token1234.html pdf: https://url.com/a_rewards_disclosure_asset_token1234.pdf png: https://url.com/a_rewards_disclosure_asset_token1234.png template_token: a_rewards_disclosure_template_token1234 template_urls: html: https://url.com/a_rewards_disclosure_template_token1234.html summary_of_credit_terms: asset_token: a_summary_of_credit_terms_asset_token1234 asset_urls: html: https://url.com/a_summary_of_credit_terms_asset_token1234.html pdf: https://url.com/a_summary_of_credit_terms_asset_token1234.pdf png: https://url.com/a_summary_of_credit_terms_asset_token1234.png template_token: a_summary_of_credit_terms_template_token1234 template_urls: html: https://asset-bucket.s3.amazonaws.com/short_code/a_summary_of_credit_terms_template_token1234/a_summary_of_credit_terms_template_token1234.html terms_schedule: template_token: a_terms_schedule_template_token1234 template_urls: html: https://url.com/a_terms_schedule_template_token1234.html token: my_document_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/PolicyDocumentResponse' description: A JSON object containing document policy information default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve document policy tags: - Policies put: description: |- Update a specific document policy, which consists of all the pre- and post-application disclosures and credit program documents known as assets and templates. Assets contain finalized values after a bundle is created; templates do not contain finalized values. operationId: updateDocumentPolicy parameters: - description: |- Unique identifier of the document policy to update. Send a `GET` request to `/policies/documents` to retrieve existing document policy tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing document policy token style: simple requestBody: content: application/json: example: account_statement: template_token: an_account_statement_template_token321 benefits_disclosure_premium: asset_token: a_benefits_disclosure_asset_token321 benefits_disclosure_traditional: asset_token: a_benefits_disclosure_traditional_asset_token321 card_member_agreement: asset_token: a_card_member_agreement_asset_token321 e_disclosure: asset_token: a_e_disclosure_asset_token321 name: My Changed Document Policy noaa_multiple_reason_with_dodd_frank: template_token: an_noaa_multiple_reason_with_dodd_frank_template_token321 noaa_single_reason: template_token: an_noaa_single_reason_template_token321 noaa_single_reason_with_dodd_frank: template_token: an_noaa_single_reason_with_dodd_frank_template_token321 pre_qualification_disclosure: asset_token: a_pre_qualification_disclosure_asset_token321 template_token: a_pre_qualification_disclosure_template_token321 privacy_policy: asset_token: a_privacy_policy_asset_token321 rewards_disclosure: asset_token: a_rewards_disclosure_asset_token321 template_token: a_rewards_disclosure_template_token321 summary_of_credit_terms: asset_token: a_summary_of_credit_terms_asset_token321 template_token: a_summary_of_credit_terms_template_token321 terms_schedule: template_token: a_terms_schedule_template_token321 token: my_document_policy_token_1234 schema: $ref: '#/components/schemas/PolicyDocumentUpdateReq' required: true responses: '200': content: application/json: example: account_statement: template_token: an_account_statement_template_token321 template_urls: html: https://url.com/an_account_statement_template_token321.html benefits_disclosure_premium: asset_token: a_benefits_disclosure_premium_asset_token321 asset_urls: html: https://url.com/a_benefits_disclosure_premium_asset_token321.html pdf: https://url.com/a_benefits_disclosure_premium_asset_token321.pdf png: https://url.com/a_benefits_disclosure_premium_asset_token321.png benefits_disclosure_traditional: asset_token: a_benefits_disclosure_traditional_asset_token321 asset_urls: html: https://url.com/a_benefits_disclosure_traditional_asset_token321.html pdf: https://url.com/a_benefits_disclosure_traditional_asset_token321.pdf png: https://url.com/a_benefits_disclosure_traditional_asset_token321.png card_member_agreement: asset_token: a_card_member_agreement_asset_token321 asset_urls: html: https://url.com/a_card_member_agreement_asset_token321.html pdf: https://url.com/a_card_member_agreement_asset_token321.pdf png: https://url.com/a_card_member_agreement_asset_token321.png created_time: 2025-04-01T23:41:58.802Z e_disclosure: asset_token: a_e_disclosure_asset_token321 asset_urls: html: https://url.com/a_e_disclosure_asset_token321.html pdf: https://url.com/a_e_disclosure_asset_token321.pdf png: https://url.com/a_e_disclosure_asset_token321.png name: My Changed Document Policy noaa_multiple_reason_with_dodd_frank: template_token: an_noaa_multiple_reason_with_dodd_frank_template_token321 template_urls: html: https://url.com/an_noaa_multiple_reason_with_dodd_frank_template_token321.html noaa_single_reason: template_token: an_noaa_single_reason_template_token321 template_urls: html: https://url.com/an_noaa_single_reason_template_token321.html noaa_single_reason_with_dodd_frank: template_token: an_noaa_single_reason_with_dodd_frank_template_token321 template_urls: html: https://url.com/an_noaa_single_reason_with_dodd_frank_template_token321.html pre_qualification_disclosure: asset_token: a_pre_qualification_disclosure_asset_token321 asset_urls: html: https://url.com/a_pre_qualification_disclosure_asset_token321.html pdf: https://url.com/a_pre_qualification_disclosure_asset_token321.pdf png: https://url.com/a_pre_qualification_disclosure_asset_token321.png template_token: a_pre_qualification_disclosure_template_token321 template_urls: html: https://url.com/a_pre_qualification_disclosure_template_token321.html privacy_policy: asset_token: a_privacy_policy_asset_token321 asset_urls: html: https://url.com/a_privacy_policy_asset_token321.html pdf: https://url.com/a_privacy_policy_asset_token321.pdf png: https://url.com/a_privacy_policy_asset_token321.png rewards_disclosure: asset_token: a_rewards_disclosure_asset_token321 asset_urls: html: https://url.com/a_rewards_disclosure_asset_token321.html pdf: https://url.com/a_rewards_disclosure_asset_token321.pdf png: https://url.com/a_rewards_disclosure_asset_token321.png template_token: a_rewards_disclosure_template_token321 template_urls: html: https://url.com/a_rewards_disclosure_template_token321.html summary_of_credit_terms: asset_token: a_summary_of_credit_terms_asset_token321 asset_urls: html: https://url.com/a_summary_of_credit_terms_asset_token321.html pdf: https://url.com/a_summary_of_credit_terms_asset_token321.pdf png: https://url.com/a_summary_of_credit_terms_asset_token321.png template_token: a_summary_of_credit_terms_template_token321 template_urls: html: https://url.com/a_summary_of_credit_terms_template_token321.html terms_schedule: template_token: a_terms_schedule_template_token321 template_urls: html: https://url.com/a_terms_schedule_template_token321.html token: my_document_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/PolicyDocumentResponse' description: A JSON object containing document policy information. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Update document policy tags: - Policies /policies/documents/{token}/clone: post: description: |- Create a new document policy based on an existing document policy. A document policy consists of all the pre- and post-application disclosures and credit program documents known as assets and templates. Assets contain finalized values after a bundle is created; templates do not contain finalized values. operationId: cloneDocumentPolicy parameters: - description: |- Unique identifier of the document policy to clone. Send a `GET` request to `/policies/documents` to retrieve existing document policy tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing document policy token style: simple responses: '201': content: application/json: example: account_statement: template_token: an_account_statement_template_token1234 template_urls: html: https://url.com/an_account_statement_template_token1234.html benefits_disclosure: asset_token: a_benefits_disclosure_asset_token1234 asset_urls: html: https://url.com/a_benefits_disclosure_asset_token1234.html pdf: https://url.com/a_benefits_disclosure_asset_token1234.pdf png: https://url.com/a_benefits_disclosure_asset_token1234.png card_member_agreement: asset_token: a_card_member_agreement_asset_token1234 asset_urls: html: https://url.com/a_card_member_agreement_asset_token1234.html pdf: https://url.com/a_card_member_agreement_asset_token1234.pdf png: https://url.com/a_card_member_agreement_asset_token1234.png created_time: 2025-04-01T23:41:58.802Z e_disclosure: asset_token: a_e_disclosure_asset_token1234 asset_urls: html: https://url.com/a_e_disclosure_asset_token1234.html pdf: https://url.com/a_e_disclosure_asset_token1234.pdf png: https://url.com/a_e_disclosure_asset_token1234.png name: My Document Policy notice_of_adverse_action: template_token: a_notice_of_adverse_action_template_token1234 template_urls: html: https://url.com/a_notice_of_adverse_action_template_token1234.html pre_qualification_disclosure: asset_token: a_pre_qualification_disclosure_asset_token1234 asset_urls: html: https://url.com/a_pre_qualification_disclosure_asset_token1234.html pdf: https://url.com/a_pre_qualification_disclosure_asset_token1234.pdf png: https://url.com/a_pre_qualification_disclosure_asset_token1234.png template_token: a_pre_qualification_disclosure_template_token1234 template_urls: html: https://url.com/a_pre_qualification_disclosure_template_token1234.html privacy_policy: asset_token: a_privacy_policy_asset_token1234 asset_urls: html: https://url.com/a_privacy_policy_asset_token1234.html pdf: https://url.com/a_privacy_policy_asset_token1234.pdf png: https://url.com/a_privacy_policy_asset_token1234.png rewards_disclosure: asset_token: a_rewards_disclosure_asset_token1234 asset_urls: html: https://url.com/a_rewards_disclosure_asset_token1234.html pdf: https://url.com/a_rewards_disclosure_asset_token1234.pdf png: https://url.com/a_rewards_disclosure_asset_token1234.png template_token: a_rewards_disclosure_template_token1234 template_urls: html: https://url.com/a_rewards_disclosure_template_token1234.html summary_of_credit_terms: asset_token: a_summary_of_credit_terms_asset_token1234 asset_urls: html: https://url.com/a_summary_of_credit_terms_asset_token1234.html pdf: https://url.com/a_summary_of_credit_terms_asset_token1234.pdf png: https://url.com/a_summary_of_credit_terms_asset_token1234.png template_token: a_summary_of_credit_terms_template_token1234 template_urls: html: https://asset-bucket.s3.amazonaws.com/short_code/a_summary_of_credit_terms_template_token1234/a_summary_of_credit_terms_template_token1234.html terms_schedule: template_token: a_terms_schedule_template_token1234 template_urls: html: https://url.com/a_terms_schedule_template_token1234.html token: my_document_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/PolicyDocumentResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Clone document policy tags: - Policies /policies/fees: get: description: |- Retrieve an array of existing fee policies. This endpoint supports <>. operationId: getFeePolicies parameters: - description: Number of fee policy resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 2 data: - account: foreign_transaction_fee: default_method: PERCENTAGE default_value: 12.5 late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2025-04-01T23:41:58.802Z description: A gold fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z - account: foreign_transaction_fee: default_method: PERCENTAGE default_value: 12.5 late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2025-04-01T23:41:58.802Z description: A silver fee policy name: Silver Fee Policy token: my_fee_policy_token_4321 updated_time: 2025-04-05T16:04:48.643Z end_index: 2 is_more: true start_index: 0 schema: $ref: '#/components/schemas/PolicyFeesPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List fee policies tags: - Policies post: description: Create a new fee policy. operationId: createFeePolicy requestBody: content: application/json: example: account: foreign_transaction_fee: default_method: PERCENTAGE default_value: 12.5 late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 description: A gold fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 schema: $ref: '#/components/schemas/PolicyFeeCreateReq' required: true responses: '201': content: application/json: example: account: foreign_transaction_fee: default_method: PERCENTAGE default_value: 12.5 late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2025-04-01T23:41:58.802Z description: A gold fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/PolicyFeeResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create fee policy tags: - Policies /policies/fees/{token}: get: description: |- Retrieve a specific fee policy. This endpoint supports <>. operationId: getFeePolicyByToken parameters: - description: |- Unique identifier of the fee policy to retrieve. Send a `GET` request to `/policies/fee` to retrieve existing fee policy tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing fee policy token style: simple responses: '200': content: application/json: example: account: foreign_transaction_fee: default_method: PERCENTAGE default_value: 3 late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2025-04-01T23:41:58.802Z description: A gold fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/PolicyFeeResponse' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve fee policy tags: - Policies put: description: Update a specific fee policy. operationId: updateFeePolicyWithToken parameters: - description: |- Unique identifier of the fee policy to retrieve. Send a `GET` request to `/policies/fee` to retrieve existing fee policy tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing fee policy token style: simple requestBody: content: application/json: example: account: foreign_transaction_fee: default_method: PERCENTAGE default_value: 3 late_payment: default_method: FLAT default_value: 5 returned_payment: default_method: FLAT default_value: 5 description: Description for changed fee policy name: My Changed Fee Policy token: my_fee_policy_token_1234 schema: $ref: '#/components/schemas/PolicyFeeUpdateReq' required: true responses: '200': content: application/json: example: account: foreign_transaction_fee: default_method: PERCENTAGE default_value: 3 late_payment: default_method: FLAT default_value: 5 returned_payment: default_method: FLAT default_value: 5 created_time: 2025-04-01T23:41:58.802Z description: Description for changed fee policy name: My Changed Fee Policy token: my_fee_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/PolicyFeeResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Update fee policy tags: - Policies /policies/fees/{token}/clone: post: description: Create a new fee policy based on an existing fee policy. operationId: cloneFeePolicy parameters: - description: |- Unique identifier of the fee policy to clone. Send a `GET` request to `/policies/fee` to retrieve existing fee policy tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing fee policy token style: simple responses: '201': content: application/json: example: account: foreign_transaction_fee: default_method: PERCENTAGE default_value: 3 late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2025-04-01T23:41:58.802Z description: A gold fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/PolicyFeeResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Clone fee policy tags: - Policies /policies/products: get: description: |- Retrieve an array of existing credit product policies. This endpoint supports <>. operationId: listProductPolicies parameters: - description: Number of product policy resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 2 data: - card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER created_time: 2025-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A gold credit product policy interest_calculation: day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT - FOREIGN_TRANSACTION_FEE grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_PAYMENT_DATE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 name: Gold Credit Product Policy payments: allocation_order: - INTEREST - FEES - PRINCIPAL billing_cycle_day: 1 min_payment_calculation: include_overlimit_amount: true include_past_due_amount: false min_payment_flat_amount: 20 min_payment_percentage: include_fees_charged: - LATE_PAYMENT_FEE - FOREIGN_TRANSACTION_FEE include_interest_charged: false percentage_of_balance: 1 product_sub_type: CREDIT_CARD product_type: REVOLVING token: my_credit_product_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z usage: - PURCHASE - card_products: - level: TRADITIONAL network: VISA token: my_card_product_token4321 classification: CONSUMER created_time: 2025-04-01T23:41:58.802Z credit_line: max: 3100 min: 50 currency_code: USD description: A silver credit product policy interest_calculation: day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT - FOREIGN_TRANSACTION_FEE grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_PAYMENT_DATE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 name: Silver Credit Product Policy payments: allocation_order: - INTEREST - FEES - PRINCIPAL billing_cycle_day: 1 min_payment_calculation: include_overlimit_amount: true include_past_due_amount: false min_payment_flat_amount: 20 min_payment_percentage: include_fees_charged: - LATE_PAYMENT_FEE - FOREIGN_TRANSACTION_FEE include_interest_charged: false percentage_of_balance: 1 product_sub_type: CREDIT_CARD product_type: REVOLVING token: my_credit_product_policy_token_4321 updated_time: 2025-04-05T16:04:48.643Z usage: - PURCHASE end_index: 2 is_more: true start_index: 0 schema: $ref: '#/components/schemas/PoliciesProductPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List credit product policies tags: - Policies post: description: Create a new credit product policy. operationId: createProductPolicy parameters: [ ] requestBody: content: application/json: example: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER credit_line: max: 3500 min: 50 currency_code: USD description: A gold credit product policy interest_calculation: day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT - FOREIGN_TRANSACTION_FEE grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_PAYMENT_DATE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 name: Gold Credit Product Policy payments: allocation_order: - INTEREST - FEES - PRINCIPAL billing_cycle_day: 1 min_payment_calculation: include_overlimit_amount: true include_past_due_amount: false min_payment_flat_amount: 20 min_payment_percentage: include_fees_charged: - LATE_PAYMENT_FEE - FOREIGN_TRANSACTION_FEE include_interest_charged: false percentage_of_balance: 1 product_sub_type: CREDIT_CARD product_type: REVOLVING token: my_credit_product_policy_token_1234 usage: - PURCHASE schema: $ref: '#/components/schemas/PolicyProductCreateReq' required: true responses: '201': content: application/json: example: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER created_time: 2025-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A gold credit product policy interest_calculation: day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT - FOREIGN_TRANSACTION_FEE grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_PAYMENT_DATE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 name: Gold Credit Product Policy payments: allocation_order: - INTEREST - FEES - PRINCIPAL billing_cycle_day: 1 min_payment_calculation: include_overlimit_amount: true include_past_due_amount: false min_payment_flat_amount: 20 min_payment_percentage: include_fees_charged: - LATE_PAYMENT_FEE - FOREIGN_TRANSACTION_FEE include_interest_charged: false percentage_of_balance: 1 product_sub_type: CREDIT_CARD product_type: REVOLVING token: my_credit_product_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z usage: - PURCHASE schema: $ref: '#/components/schemas/PolicyProductResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create credit product policy tags: - Policies /policies/products/{token}: get: description: Retrieve a specific credit product policy. operationId: retrieveProductPolicy parameters: - description: |- Unique identifier of the credit product policy to retrieve. Send a `GET` request to `/policies/products` to retrieve existing credit product policy tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing credit product policy token style: simple responses: '200': content: application/json: example: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER created_time: 2025-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A gold credit product policy interest_calculation: day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT - FOREIGN_TRANSACTION_FEE grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_PAYMENT_DATE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 name: Gold Credit Product Policy payments: allocation_order: - INTEREST - FEES - PRINCIPAL billing_cycle_day: 1 due_day: 31 min_payment_calculation: include_overlimit_amount: true include_past_due_amount: false min_payment_flat_amount: 20 min_payment_percentage: include_fees_charged: - LATE_PAYMENT_FEE - FOREIGN_TRANSACTION_FEE include_interest_charged: false percentage_of_balance: 1 product_sub_type: CREDIT_CARD product_type: REVOLVING token: my_credit_product_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z usage: - PURCHASE schema: $ref: '#/components/schemas/PolicyProductResponse' description: A JSON object containing product policy information default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve credit product policy tags: - Policies put: description: Update a specific credit product policy. operationId: updateProductPolicy parameters: - description: |- Unique identifier of the credit product policy to retrieve. Send a `GET` request to `/policies/products` to retrieve existing credit product policy tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing credit product policy token style: simple requestBody: content: application/json: example: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER credit_line: max: 3500 min: 50 currency_code: USD description: Description of the renamed credit product policy interest_calculation: day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT - FOREIGN_TRANSACTION_FEE grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_PAYMENT_DATE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 name: Renamed Credit Product Policy payments: allocation_order: - INTEREST - FEES - PRINCIPAL billing_cycle_day: 1 due_day: 31 min_payment_calculation: include_overlimit_amount: true include_past_due_amount: false min_payment_flat_amount: 20 min_payment_percentage: include_fees_charged: - LATE_PAYMENT_FEE - FOREIGN_TRANSACTION_FEE include_interest_charged: false percentage_of_balance: 1 product_sub_type: CREDIT_CARD product_type: REVOLVING token: my_credit_product_policy_token_1234 usage: - PURCHASE schema: $ref: '#/components/schemas/PolicyProductUpdateReq' required: true responses: '200': content: application/json: example: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER created_time: 2025-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: Description of the renamed credit product policy interest_calculation: day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT - FOREIGN_TRANSACTION_FEE grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_PAYMENT_DATE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 name: Renamed Credit Product Policy payments: allocation_order: - INTEREST - FEES - PRINCIPAL billing_cycle_day: 1 due_day: 31 min_payment_calculation: include_overlimit_amount: true include_past_due_amount: false min_payment_flat_amount: 20 min_payment_percentage: include_fees_charged: - LATE_PAYMENT_FEE - FOREIGN_TRANSACTION_FEE include_interest_charged: false percentage_of_balance: 1 product_sub_type: CREDIT_CARD product_type: REVOLVING token: my_credit_product_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z usage: - PURCHASE schema: $ref: '#/components/schemas/PolicyProductResponse' description: A JSON object containing product policy information. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Update credit product policy tags: - Policies /policies/products/{token}/clone: post: description: Create a new credit product policy based on an existing credit product policy. operationId: cloneProductPolicy parameters: - description: |- Unique identifier of the credit product policy to clone. Send a `GET` request to `/policies/products` to retrieve existing credit product policy tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing credit product policy token style: simple responses: '201': content: application/json: example: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER created_time: 2025-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A gold credit product policy interest_calculation: day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT - FOREIGN_TRANSACTION_FEE grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_PAYMENT_DATE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 name: Gold Credit Product Policy payments: allocation_order: - INTEREST - FEES - PRINCIPAL billing_cycle_day: 1 due_day: 31 min_payment_calculation: include_overlimit_amount: true include_past_due_amount: false min_payment_flat_amount: 20 min_payment_percentage: include_fees_charged: - LATE_PAYMENT_FEE - FOREIGN_TRANSACTION_FEE include_interest_charged: false percentage_of_balance: 1 product_sub_type: CREDIT_CARD product_type: REVOLVING token: my_credit_product_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z usage: - PURCHASE schema: $ref: '#/components/schemas/PolicyProductResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Clone credit product policy tags: - Policies /policies/rewards: get: description: |- Retrieve an array of reward policies. This endpoint supports <>. operationId: listRewardPolicies parameters: - description: Number of reward policy resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 2 data: - accrual_strategy: DEFAULT conversions: - conversion_increment: 10 conversion_rate: 0.001 currency: USD type: STATEMENT_CREDIT created_time: 2025-04-01T23:41:58.802Z description: A gold reward policy exclusions: custom_exclusions: - 2000-2999 - '4321' use_default_exclusions: false name: Gold Reward Policy redemption_strategy: MANUAL rounding_strategy: ROUND_HALF_EVEN rules: - amount: null attributes: mcc: - 0001-1499 - '1500' calculation_type: PER_TRANSACTION description: Earn 3x on selected categories. multiplier: 3 type: MULTIPLIER_PER_TRANSACTION settlement_strategy: STATEMENT token: my_reward_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z end_index: 2 is_more: true start_index: 0 schema: $ref: '#/components/schemas/PolicyRewardPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List reward policies tags: - Policies post: description: Create a new reward policy. operationId: createRewardPolicy parameters: [ ] requestBody: content: application/json: example: accrual_strategy: DEFAULT conversions: - conversion_increment: 10 conversion_rate: 0.001 currency: USD type: STATEMENT_CREDIT description: A gold reward policy exclusions: custom_exclusions: - 2000-2999 - '4321' use_default_exclusions: false name: Gold Reward Policy redemption_strategy: MANUAL rounding_strategy: ROUND_HALF_EVEN rules: - amount: null attributes: { } calculation_type: PER_TRANSACTION description: Earn 1x on selected categories. multiplier: 1 type: MULTIPLIER_PER_TRANSACTION - amount: 30000 attributes: min_spend: 1500 spend_days: 90 calculation_type: SPEND_BALANCE description: Earn 30,000 welcome miles after $1,500 spend in first 90 days type: SIGNUP_BONUS settlement_strategy: STATEMENT token: my_reward_policy_token_1234 schema: $ref: '#/components/schemas/PolicyRewardReq' required: true responses: '201': content: application/json: example: accrual_strategy: DEFAULT conversions: - conversion_increment: 10 conversion_rate: 0.001 currency: USD type: STATEMENT_CREDIT created_time: 2025-04-01T23:41:58.802Z description: A gold reward policy exclusions: custom_exclusions: - 2000-2999 - '4321' use_default_exclusions: false name: Gold Reward Policy redemption_strategy: MANUAL rounding_strategy: ROUND_HALF_EVEN rules: - amount: null attributes: { } calculation_type: PER_TRANSACTION description: Earn 3x on all categories. multiplier: 3 type: MULTIPLIER_PER_TRANSACTION - amount: 30000 attributes: min_spend: 1500 spend_days: 90 calculation_type: SPEND_BALANCE description: Earn 30,000 welcome miles after $1,500 spend in first 90 days type: SIGNUP_BONUS settlement_strategy: STATEMENT token: my_reward_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/PolicyRewardResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create reward policy tags: - Policies /policies/rewards/{token}: get: description: Retrieve a reward policy. operationId: retrieveRewardPolicy parameters: - description: |- Unique identifier of the reward policy to retrieve. Send a `GET` request to `/policies/rewards` to retrieve existing reward policy tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward policy token style: simple responses: '200': content: application/json: example: accrual_strategy: DEFAULT conversions: - conversion_increment: 10 conversion_rate: 0.001 currency: USD type: STATEMENT_CREDIT created_time: 2025-04-01T23:41:58.802Z description: A gold reward policy exclusions: custom_exclusions: - 2000-2999 - '4321' use_default_exclusions: false name: Gold Reward Policy redemption_strategy: MANUAL rounding_strategy: ROUND_HALF_EVEN rules: - amount: null attributes: mcc: - 0001-1499 - '1500' calculation_type: PER_TRANSACTION description: Earn 3x on selected categories. multiplier: 3 type: MULTIPLIER_PER_TRANSACTION - amount: 30000 attributes: min_spend: 1500 spend_days: 90 calculation_type: SPEND_BALANCE description: Earn 30,000 welcome miles after $1,500 spend in first 90 days type: SIGNUP_BONUS settlement_strategy: STATEMENT token: my_reward_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/PolicyRewardResponse' description: A JSON object containing reward policy information. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve reward policy tags: - Policies put: description: Update a reward policy. operationId: updateRewardPolicy parameters: - description: |- Unique identifier of the reward policy to update. Send a `GET` request to `/policies/rewards` to retrieve existing reward policy tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward policy token style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyRewardReq' required: true responses: '200': content: application/json: example: accrual_strategy: DEFAULT conversions: - conversion_increment: 10 conversion_rate: 0.001 currency: USD type: STATEMENT_CREDIT created_time: 2025-04-01T23:41:58.802Z description: A gold reward policy exclusions: custom_exclusions: - 2000-2999 - '4321' use_default_exclusions: false name: Gold Reward Policy redemption_strategy: MANUAL rounding_strategy: ROUND_HALF_EVEN rules: - amount: null attributes: mcc: - 0001-1499 - '1500' calculation_type: PER_TRANSACTION description: Earn 3x on selected categories. multiplier: 3 type: MULTIPLIER_PER_TRANSACTION - amount: 30000 attributes: min_spend: 1500 spend_days: 90 calculation_type: SPEND_BALANCE description: Earn 30,000 welcome miles after $1,500 spend in first 90 days type: SIGNUP_BONUS settlement_strategy: STATEMENT token: my_reward_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/PolicyRewardResponse' description: A JSON object containing reward policy information. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Update reward policy tags: - Policies /policies/rewards/{token}/clone: post: description: Create a new reward policy based on existing reward policy. operationId: cloneRewardPolicy parameters: - description: |- Unique identifier of the reward policy to clone. Send a `GET` request to `/policies/rewards` to retrieve existing reward policy tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward policy token style: simple responses: '201': content: application/json: example: accrual_strategy: DEFAULT conversions: - conversion_increment: 10 conversion_rate: 0.001 currency: USD type: STATEMENT_CREDIT created_time: 2025-04-01T23:41:58.802Z description: A gold reward policy exclusions: custom_exclusions: - 2000-2999 - '4321' use_default_exclusions: false name: Gold Reward Policy redemption_strategy: MANUAL rounding_strategy: ROUND_HALF_EVEN rules: - amount: null attributes: mcc: - 0001-1499 - '1500' calculation_type: PER_TRANSACTION description: Earn 3x on selected categories. multiplier: 3 type: MULTIPLIER_PER_TRANSACTION settlement_strategy: STATEMENT token: my_reward_policy_token_1234 updated_time: 2025-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/PolicyRewardResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Clone reward policy tags: - Policies /products: get: description: |- Retrieve an array of credit products. This endpoint supports <>. operationId: listProducts parameters: - description: An array of statuses by which to filter credit products. explode: true in: query name: status required: false schema: items: $ref: '#/components/schemas/ResourceStatus' type: array style: form - description: Number of credit product resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 2 data: - card_product_tokens: - my_card_product1234 classification: CONSUMER config: billing_cycle_day: 1 fees: - LATE_PAYMENT_FEE fees_config: [ ] payment_due_day: 31 periodic_fees: - frequency: ANNUAL number_of_days_post_activation: 5 - frequency: MONTHLY number_of_days_post_activation: 28 rewards_config: [ ] created_time: 2023-09-03T19:03:21.035Z credit_line: max: 200000 min: 25 currency_code: USD description: Description of credit product interest_calculation: day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_FULL_CYCLE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 min_payment_calculation: include_overlimit_amount: false include_past_due_amount: false min_payment_flat_amount: 25 min_payment_percentage: include_fees_charged: [ ] include_interest_charged: false percentage_of_balance: 1 min_payment_flat_amount: 25 min_payment_percentage: 1 name: Gold Card payment_allocation_order: - INTEREST - FEES - PRINCIPAL product_sub_type: CREDIT_CARD product_type: REVOLVING status: ACTIVE token: my_credit_product_token1234 updated_time: 2023-09-03T19:03:21.035Z usage: - PURCHASE - card_product_tokens: - card-product-token-d308 - card-product-token-cc10 classification: CONSUMER config: billing_cycle_day: 1 fees: - LATE_PAYMENT_FEE fees_config: [ ] payment_due_day: 31 periodic_fees: - frequency: ANNUAL number_of_days_post_activation: 5 - frequency: MONTHLY number_of_days_post_activation: 28 rewards_config: [ ] created_time: 2023-10-26T14:46:26.678Z credit_line: max: 20000 min: 200 currency_code: USD description: Platinum consumer product interest_calculation: day_count: ACTUAL exclude_tran_types: - LATE_PAYMENT_FEE - ANNUAL_FEE - CASH_BACK_STATEMENT_CREDIT grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_FULL_CYCLE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 min_payment_flat_amount: 22 min_payment_percentage: 2 name: My Platinum Credit Product payment_allocation_order: - INTEREST - FEES - PRINCIPAL product_sub_type: CREDIT_CARD product_type: REVOLVING status: ACTIVE token: credit-product-token-9163 updated_time: 2023-10-26T16:45:19.908Z usage: - PURCHASE end_index: 0 is_more: true start_index: 0 schema: $ref: '#/components/schemas/ProductsPage' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List credit products tags: - Credit Products post: description: Create a credit product. operationId: createProduct parameters: [ ] requestBody: content: application/json: example: card_product_tokens: - my_card_product1234 classification: CONSUMER config: billing_cycle_day: 1 fees: - LATE_PAYMENT_FEE payment_due_day: 31 periodic_fees: [ ] credit_line: max: 200000 min: 25 currency_code: USD interest_calculation: day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_FULL_CYCLE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 min_payment_calculation: include_overlimit_amount: true include_past_due_amount: true min_payment_flat_amount: 25 min_payment_percentage: include_fees_charged: - LATE_PAYMENT_FEE include_interest_charged: false percentage_of_balance: 1 min_payment_flat_amount: 25 min_payment_percentage: 1 name: my_credit_product1234 payment_allocation_order: - INTEREST - FEES - PRINCIPAL product_sub_type: CREDIT_CARD product_type: REVOLVING status: ACTIVE usage: - PURCHASE schema: $ref: '#/components/schemas/ProductCreateReq' required: true responses: '201': content: application/json: example: card_product_tokens: - my_card_product1234 classification: CONSUMER config: billing_cycle_day: 1 fees: - LATE_PAYMENT_FEE fees_config: [ ] payment_due_day: 31 periodic_fees: [ ] rewards_config: [ ] created_time: 2021-09-03T19:03:21.035Z credit_line: max: 200000 min: 25 currency_code: USD description: Description of credit product interest_calculation: day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_FULL_CYCLE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 min_payment_calculation: include_overlimit_amount: false include_past_due_amount: false min_payment_flat_amount: 25 min_payment_percentage: include_fees_charged: [ ] include_interest_charged: false percentage_of_balance: 1 min_payment_flat_amount: 25 min_payment_percentage: 1 name: Gold Card payment_allocation_order: - INTEREST - FEES - PRINCIPAL product_sub_type: CREDIT_CARD product_type: REVOLVING status: ACTIVE token: my_credit_product_token1234 updated_time: 2021-09-03T19:03:21.035Z usage: - PURCHASE schema: $ref: '#/components/schemas/ProductResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create credit product tags: - Credit Products /products/{token}: get: description: Retrieve a credit product. operationId: retrieveProduct parameters: - description: |- Unique identifier of the credit product to retrieve. Send a `GET` request to `/credit/products` to retrieve existing credit product tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing credit product token style: simple responses: '200': content: application/json: example: card_product_tokens: - card-product-token-2222 classification: CONSUMER config: billing_cycle_day: 1 fees: - LATE_PAYMENT_FEE payment_due_day: 31 periodic_fees: - frequency: ANNUAL number_of_days_post_activation: 5 - frequency: MONTHLY number_of_days_post_activation: 28 created_time: 2020-12-17T00:11:46Z credit_line: max: 3500 min: 1500 currency_code: USD description: Description of Gold Product interest_calculation: day_count: ACTUAL exclude_tran_types: - ANNUAL_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_FULL_CYCLE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 min_payment_flat_amount: 0.01 min_payment_percentage: 1.0E-4 name: Gold Product payment_allocation_order: - INTEREST - FEES - PRINCIPAL product_sub_type: CREDIT_CARD product_type: REVOLVING status: DRAFT token: credit-product-token1111 updated_time: 2020-12-17T00:11:46Z usage: - PURCHASE schema: $ref: '#/components/schemas/ProductResponse' description: A JSON object containing product information default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve credit product tags: - Credit Products /products/{token}/lineage: get: description: |- Retrieve the lineage of a credit product, which is an array of related credit products whose lineage can be traced back to the same original credit product. This endpoint supports <>. operationId: lineageProducts parameters: - description: |- Unique identifier of the credit product whose lineage you want to retrieve. Send a `GET` request to `/credit/products` to retrieve existing credit product tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing credit product token style: simple - description: An array of statuses by which to filter credit products. explode: true in: query name: status required: false schema: items: $ref: '#/components/schemas/ResourceStatus' type: array style: form - description: Number of credit product resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 3 data: - card_product_tokens: - card-product-token-d308 - card-product-token-cc10 classification: CONSUMER config: billing_cycle_day: 1 payment_due_day: 31 created_time: 2023-10-26T14:46:26.678Z credit_line: max: 20000 min: 200 currency_code: USD description: Platinum consumer product interest_calculation: day_count: ACTUAL exclude_tran_types: - LATE_PAYMENT_FEE - ANNUAL_FEE - CASH_BACK_STATEMENT_CREDIT grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_FULL_CYCLE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 min_payment_calculation: include_overlimit_amount: false include_past_due_amount: true min_payment_flat_amount: 22 min_payment_percentage: include_fees_charged: [ ] include_interest_charged: false percentage_of_balance: 2 min_payment_flat_amount: 22 min_payment_percentage: 2 name: My Platinum Credit Product parent_product_token: credit-product-token-366b payment_allocation_order: - INTEREST - FEES - PRINCIPAL product_sub_type: CREDIT_CARD product_type: REVOLVING status: ACTIVE token: credit-product-token-9163 updated_time: 2023-10-26T16:45:19.908Z usage: - PURCHASE - card_product_tokens: - card-product-token-d308 classification: CONSUMER config: billing_cycle_day: 1 payment_due_day: 31 created_time: 2023-10-26T14:43:11.187Z credit_line: max: 20000 min: 200 currency_code: USD description: Platinum consumer product interest_calculation: day_count: ACTUAL exclude_tran_types: - LATE_PAYMENT_FEE - ANNUAL_FEE - CASH_BACK_STATEMENT_CREDIT grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_FULL_CYCLE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 min_payment_calculation: include_overlimit_amount: false include_past_due_amount: false min_payment_flat_amount: 22 min_payment_percentage: include_fees_charged: [ ] include_interest_charged: false percentage_of_balance: 2 min_payment_flat_amount: 22 min_payment_percentage: 2 name: My Platinum Credit Product payment_allocation_order: - INTEREST - FEES - PRINCIPAL product_sub_type: CREDIT_CARD product_type: REVOLVING status: ARCHIVED token: credit-product-token-366b updated_time: 2023-10-26T16:45:19.907Z usage: - PURCHASE - card_product_tokens: - card-product-token-d308 - card-product-token-cc10 classification: CONSUMER config: billing_cycle_day: 1 payment_due_day: 31 created_time: 2023-10-26T14:44:54.770Z credit_line: max: 20000 min: 200 currency_code: USD description: Platinum consumer product interest_calculation: day_count: ACTUAL exclude_tran_types: - LATE_PAYMENT_FEE - ANNUAL_FEE - CASH_BACK_STATEMENT_CREDIT grace_days_application: NEXT_CYCLE_DATE interest_application: - PRINCIPAL - FEES interest_on_grace_reactivation: ACCRUE_FULL_CYCLE method: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS minimum_interest: 1 min_payment_calculation: include_overlimit_amount: false include_past_due_amount: false min_payment_flat_amount: 22 min_payment_percentage: include_fees_charged: [ ] include_interest_charged: false percentage_of_balance: 2 min_payment_flat_amount: 22 min_payment_percentage: 2 name: My Platinum Credit Product parent_product_token: credit-product-token-366b payment_allocation_order: - INTEREST - FEES - PRINCIPAL product_sub_type: CREDIT_CARD product_type: REVOLVING status: REJECTED token: credit-product-token-4373 updated_time: 2023-10-26T14:45:26.015Z usage: - PURCHASE end_index: 2 is_more: false start_index: 0 schema: $ref: '#/components/schemas/ProductsPage' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve credit product lineage tags: - Credit Products /programgateways: get: description: |- Retrieve an array of existing Credit Program Gateways. This endpoint supports <>. operationId: listProgramGateways parameters: - description: Number of Program Gateway resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. *NOTE:* You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime enum: - lastModifiedTime - -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProgramGatewayPage' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List Program Gateways tags: - Program Gateways post: description: |- Create a new Credit Program Gateway. Use this endpoint to configure your Program Gateway to receive gateway requests from Marqeta's credit platform. You can create multiple Program Gateways, but only one can be active per credit program. [NOTE] To create a Program Gateway, you must have consumer or admin credentials. operationId: createProgramGateway requestBody: content: application/json: example: basic_auth_password: my_20-50_character_password basic_auth_username: my_username custom_header: my_header_name_1: my_value_1 name: My Program Gateway url: https://my-url schema: $ref: '#/components/schemas/ProgramGatewayCreateReq' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ProgramGatewayResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create Program Gateway tags: - Program Gateways /programgateways/{token}: get: description: Retrieve an existing Credit Program Gateway. operationId: retrieveProgramGateway parameters: - description: |- Unique identifier of the Program Gateway to retrieve. Send a `GET` request to `/credit/programgateways` to retrieve existing Program Gateway tokens. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing Program Gateway token style: simple responses: '200': content: application/json: example: active: false basic_auth_password: my_20-50_character_password basic_auth_username: my_username created_time: 2024-11-30T20:00:51Z last_modified_time: 2024-11-30T23:39:10Z name: My Program Gateway Name timeout_millis: 2000 token: my_pg_token_1234 url: https://my_secure_domain.com/my_gateway schema: $ref: '#/components/schemas/ProgramGatewayResponse' description: Response containing details for the requested Program Gateway. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve Program Gateway tags: - Program Gateways put: description: |- Update an existing Credit Program Gateway. You may want to update a Program Gateway if you are switching it to active or inactive, updating the URL, username, or password, and more. operationId: updateProgramGateway parameters: - description: Unique identifier of the Program Gateway to update. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing Program Gateway token style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/ProgramGatewayUpdateReq' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProgramGatewayResponse' description: Response containing updated Program Gateway. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Update Program Gateway tags: - Program Gateways /programreserve/balances: get: description: Use this endpoint to return balances for your program reserve account (sometimes referred to as a _program funding account_). operationId: getProgramreserveBalances responses: '200': content: application/json: example: available_balance: 10100.0 balances: USD: available_balance: 10100.0 currency_code: USD ledger_balance: 10100.0 pending_credits: 0.0 currency_code: USD ledger_balance: 10100.0 pending_credits: 0.0 schema: $ref: '#/components/schemas/program_reserve_account_balance' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Retrieve reserve account balances tags: - Program Reserve /programreserve/deposits: get: deprecated: true operationId: getProgramReserveDeposits parameters: - description: Number of items to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -createdTime type: string style: form responses: default: content: { } description: successful operation tags: - program reserve post: deprecated: true operationId: deposit requestBody: content: application/json: schema: $ref: '#/components/schemas/program_reserve_deposit_request' required: false responses: default: content: { } description: successful operation tags: - program reserve /programreserve/transactions: get: description: |- Use this endpoint to return a list of credits and debits made to your program reserve account. This endpoint supports <>. operationId: getProgramreserveTransactions parameters: - description: Number of resources to retrieve. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -createdTime type: string style: form responses: '200': content: application/json: example: count: 2 data: - amount: 120.0 created_time: 2024-02-10T21:52:18Z currency_code: USD last_modified_time: 2024-02-10T21:52:18Z memo: my_memo tags: my, tags token: my_deposit_02 transaction_token: '154' type: CREDIT - amount: 100.0 created_time: 2024-02-10T21:51:28Z currency_code: USD last_modified_time: 2024-02-10T21:51:28Z memo: my_memo tags: my, tags token: my_deposit_01 transaction_token: '153' type: CREDIT end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/ProgramReserveTransactionListResponse' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: List program reserve transactions tags: - Program Reserve /programs/funding: get: description: Retrieve an array of program funding entries. operationId: getProgramFundingsByShortCode parameters: - description: Number of program funding resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: Start date for filtering program funding entries. explode: true in: query name: start_date required: false schema: example: 2014-01-01 type: string style: form - description: End date for filtering program funding entries. explode: true in: query name: end_date required: false schema: example: 2014-04-01 type: string style: form responses: '200': content: application/json: example: count: 2 data: - amount: 1000 created_time: 2025-04-01T23:41:58.802Z currency_code: USD memo: This is a test memo post_time: 2025-04-01T23:41:58.802Z short_code: my_program_short_code_12 token: my_program_funding_token1234 updated_time: 2025-04-01T23:41:58.802Z - amount: 500 created_time: 2025-04-02T23:41:58.802Z currency_code: USD memo: Another test memo post_time: 2025-04-02T23:41:58.802Z short_code: my_program_short_code_34 token: my_program_funding_token5678 updated_time: 2025-04-02T23:41:58.802Z end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/ProgramFundingPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List program fundings tags: - ProgramFunding /programtransfers: get: description: |- Use this endpoint to list all program transfers. To narrow your result set to program transfers of a particular type or that are associated with a particular account holder, include the appropriate parameters from the following URL Query Parameters table. This endpoint also supports <>, <>, and <>. operationId: getProgramtransfers parameters: - description: Number of program transfers to retrieve. explode: true in: query name: count required: false schema: default: 5 format: int32 maximum: 100 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form - description: |- Unique identifier of the user account holder whose program transfers you want to retrieve. Send a `GET` request to `/users` to retrieve user tokens. explode: true in: query name: user_token required: false schema: type: string style: form - description: |- Unique identifier of the business account holder whose program transfers you want to retrieve. Send a `GET` request to `/businesses` to retrieve business tokens. explode: true in: query name: business_token required: false schema: type: string style: form - description: Unique identifier of the program transfer type to retrieve. explode: true in: query name: type_token required: false schema: type: string style: form responses: '200': content: application/json: example: count: 2 data[]: amount: 1.0 created_time: 2023-03-11T21:02:45Z currency_code: USD memo: This is my program transfer tags: tag1, tag2, tag3 token: my_program_transfer_02 transaction_token: '170' type_token: my_program_transfer_type_01 user_token: my_user_01 end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/ProgramTransferListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List program transfers tags: - Program Transfers post: description: |- Use this endpoint to create a program transfer. Add the program transfer details to the body of the request in link:http://www.json.org/[JSON, window="_blank"] format. Include either `user_token` or `business_token` in the message body to specify the account holder whose general purpose account (GPA) will be debited by the program transfer. The user or business must already exist. [NOTE] If the GPA has insufficient funds to cover both the amount of the program transfer and all attached fees, then no funds are transferred. operationId: postProgramtransfers requestBody: content: application/json: example: amount: 1.0 currency_code: USD memo: This is my program transfer tags: tag1, tag2, tag3 token: my_program_transfer_01 type_token: my_program_transfer_type_01 user_token: my_user_01 schema: $ref: '#/components/schemas/program_transfer' required: false responses: '201': content: application/json: example: amount: 1.0 created_time: 2023-03-11T20:58:30Z currency_code: USD memo: This is my program transfer tags: tag1, tag2, tag3 token: my_program_transfer_01 transaction_token: '169' type_token: my_program_transfer_type_01 user_token: my_user_01 schema: $ref: '#/components/schemas/program_transfer_response' description: Success '400': content: { } description: Bad request '404': content: { } description: Not found '409': content: { } description: Request already processed with a different payload '412': content: { } description: Pre-condition failed. Unload amount is greater than load amount '500': content: { } description: Server error summary: Create program transfer tags: - Program Transfers /programtransfers/types: get: description: |- Use this endpoint to list all program transfer types. This endpoint supports <>, <>, and <>. operationId: getProgramtransfersTypes parameters: - description: Number of program transfer types to retrieve. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 2 data[]: created_time: 2023-03-15T19:53:23Z last_modified_time: 2023-03-15T19:53:23Z memo: This is my other program transfer type. program_funding_source_token: pfs_test_01 tags: tag1, tag2, tag3 token: my_program_transfer_type_02 end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/ProgramTransferTypeListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List program transfer types tags: - Program Transfers post: description: |- Use this endpoint to create a program transfer type. Add the program transfer details to the body of the request in link:http://www.json.org/[JSON, window="_blank"] format. You are required to pass in a `program_funding_source_token` to associate a program funding source with the program transfer type. You must therefore create a program funding source before creating a program transfer type. operationId: postProgramtransfersTypes requestBody: content: application/json: example: memo: This is my program transfer type. program_funding_source_token: my_pfs_01 tags: tag1, tag2, tag3 token: my_program_transfer_type_01 schema: $ref: '#/components/schemas/program_transfer_type_request' required: false responses: '201': content: application/json: example: created_time: 2023-03-15T19:18:50Z last_modified_time: 2023-03-15T19:18:50Z memo: This is my program transfer type. program_funding_source_token: my_pfs_01 tags: tag1, tag2, tag3 token: my_program_transfer_type_01 schema: $ref: '#/components/schemas/program_transfer_type_response' description: Success '400': content: { } description: Bad request '404': content: { } description: Program funding source not found '409': content: { } description: Token already used '500': content: { } description: Server error summary: Create program transfer type tags: - Program Transfers /programtransfers/types/{type_token}: get: description: |- Use this endpoint to retrieve a specific program transfer. Include the `type_token` path parameter to indicate the program transfer type to return. operationId: getProgramtransfersTypesTypetoken parameters: - description: Unique identifier of the program transfer type. explode: false in: path name: type_token required: true schema: type: string style: simple responses: '200': content: application/json: example: created_time: 2023-03-15T19:18:50Z last_modified_time: 2023-03-15T19:18:50Z memo: This is my program transfer type. program_funding_source_token: pfs_test_01 tags: tag1, tag2, tag3 token: my_program_transfer_type_01 schema: $ref: '#/components/schemas/program_transfer_type_response' description: Success '400': content: { } description: Bad request '404': content: { } description: Program transfer type not found '500': content: { } description: Server error summary: Retrieve program transfer type tags: - Program Transfers put: description: |- Use this endpoint to update a program transfer type. Include the `type_token` path parameter to indicate the program transfer type to update. Add the modified detail parameters to the body of the request in link:http://www.json.org/[JSON, window="_blank"] format. Only values of parameters in the request are modified; all others are left unchanged. operationId: putProgramtransfersTypesTypetoken parameters: - description: Unique identifier of the program transfer type. explode: false in: path name: type_token required: true schema: type: string style: simple requestBody: content: application/json: example: memo: Update program funding source. program_funding_source_token: pfs_test_02 schema: $ref: '#/components/schemas/program_transfer_type_request' required: false responses: '200': content: application/json: example: created_time: 2023-03-15T19:53:23Z last_modified_time: 2023-03-15T19:58:33Z memo: Update program funding source. program_funding_source_token: pfs_test_02 tags: tag1, tag2, tag3 token: my_program_transfer_type_02 schema: $ref: '#/components/schemas/program_transfer_type_response' description: Success '400': content: { } description: Bad request '404': content: { } description: Program transfer type not found '500': content: { } description: Server error summary: Update program transfer type tags: - Program Transfers /programtransfers/{token}: get: description: |- Use this endpoint to retrieve a specific program transfer. Include the program transfer `token` path parameter to specify the program transfer to retrieve. operationId: getProgramtransfersToken parameters: - description: Unique identifier of the program transfer. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: amount: 1.0 created_time: 2023-03-11T21:02:45Z currency_code: USD memo: This is my program transfer tags: tag1, tag2, tag3 token: my_program_transfer_02 transaction_token: '170' type_token: my_program_transfer_type_01 user_token: my_user_01 schema: $ref: '#/components/schemas/program_transfer_response' description: Success '400': content: { } description: Bad request '404': content: { } description: Return not found '500': content: { } description: Server error summary: Retrieve program transfer tags: - Program Transfers /pushtocards/disburse: get: operationId: getPushtocardsDisburse parameters: - description: Number of push-to-card disbursements to retrieve explode: true in: query name: count required: false schema: default: 10 format: int32 type: integer style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -createdTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/PushToCardDisburseListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all push-to-card disbursements tags: - push to card post: operationId: postPushtocardsDisburse requestBody: content: application/json: schema: $ref: '#/components/schemas/push_to_card_disburse_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/push_to_card_disbursement_response' description: Success '400': content: { } description: User input error/Bad request '422': content: { } description: Payment instrument is not active '500': content: { } description: Server error summary: Initiates a push-to-card money disbursement tags: - push to card /pushtocards/disburse/{token}: get: operationId: getPushtocardsDisburseToken parameters: - description: Push-to-card disbursement token explode: false in: path name: token required: true schema: type: string style: simple - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/push_to_card_disbursement_response' description: Success '400': content: { } description: Bad request '404': content: { } description: Push-to-card disbursement not found '500': content: { } description: Server error summary: Returns a specific push-to-card disbursement tags: - push to card /pushtocards/paymentcard: get: operationId: getPushtocardsPaymentcard parameters: - description: Number of push-to-card payment cards to retrieve explode: true in: query name: count required: false schema: default: 10 format: int32 type: integer style: form - description: User token explode: true in: query name: user_token required: true schema: type: string style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -createdTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/PushToCardListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Returns all push-to-card payment card details tags: - push to card post: operationId: postPushtocardsPaymentcard requestBody: content: application/json: schema: $ref: '#/components/schemas/push_to_card_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/push_to_card_response' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Token already associated with a different payload '422': content: { } description: Push-to-card information is invalid '500': content: { } description: Server error summary: Adds an external card to which funds will be pushed tags: - push to card /pushtocards/paymentcard/{token}: get: operationId: getPushtocardsPaymentcardToken parameters: - description: Push-to-card token explode: false in: path name: token required: true schema: type: string style: simple - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/push_to_card_response' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Push-to-card details not found '500': content: { } description: Server error summary: Returns a specific paymentcard object tags: - push to card /realtimefeegroups: get: description: |- Use this endpoint to list existing real-time fee groups. This endpoint supports <> and <>. operationId: getRealtimefeegroups parameters: - description: Number of real-time fee groups to retrieve. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: The sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -createdTime type: string style: form responses: '200': content: application/json: example: count: 2 data[]: active: true created_time: 2022-11-28T00:36:11Z fee_tokens[]: my_fee_01 my_fee_05 last_modified_time: 2022-11-28T00:36:11Z name: My Real-Time Fee Group 01 token: my_rtfg_01 end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/RealTimeFeeGroupListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List real-time fee groups tags: - Real-Time Fee Groups post: description: Use this endpoint to create a real-time fee group. operationId: postRealtimefeegroups requestBody: content: application/json: example: fee_tokens[]: my_fee_01 my_fee_05 name: My Real-Time Fee Group 01 token: my_rtfg_01 schema: $ref: '#/components/schemas/real_time_fee_group_create_request' required: false responses: '201': content: application/json: example: active: true created_time: 2022-11-28T00:36:11Z fee_tokens[]: my_fee_01 my_fee_05 last_modified_time: 2022-11-28T00:36:11Z name: My Real-Time Fee Group 01 token: my_rtfg_01 schema: $ref: '#/components/schemas/real_time_fee_group' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Request already processed with a different payload '500': content: { } description: Server error summary: Create real-time fee group tags: - Real-Time Fee Groups /realtimefeegroups/{token}: get: description: |- Use this endpoint to retrieve a specific real-time fee group. Include the real-time fee group `token` path parameter to specify the real-time fee group to return. operationId: getRealtimefeegroupsToken parameters: - description: Unique identifier of the real-time fee group. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: active: true created_time: 2022-11-28T00:36:11Z fee_tokens[]: my_fee_01 my_fee_05 last_modified_time: 2022-11-28T00:36:11Z name: My Real-Time Fee Group 01 token: my_rtfg_01 schema: $ref: '#/components/schemas/real_time_fee_group' description: Success '404': content: { } description: Real-time fee group not found '500': content: { } description: Server error summary: Retrieve real-time fee group tags: - Real-Time Fee Groups put: description: |- Use this endpoint to update a real-time fee group. Include the real-time fee group `token` path parameter to specify the real-time fee group to update. operationId: putRealtimefeegroupsToken parameters: - description: Unique identifier of the real-time fee group. explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: example: active: false schema: $ref: '#/components/schemas/real_time_fee_group_request' required: false responses: '200': content: application/json: example: active: false created_time: 2022-11-28T00:36:11Z fee_tokens[]: my_fee_01 my_fee_05 last_modified_time: 2022-11-28T00:45:11Z name: My Real-Time Fee Group 01 token: my_rtfg_01 schema: $ref: '#/components/schemas/real_time_fee_group' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Update real-time fee group tags: - Real-Time Fee Groups /simulate/authorization: post: operationId: postSimulateAuthorization requestBody: content: application/json: schema: $ref: '#/components/schemas/auth_request_model' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Simulates an authorization tags: - simulate /simulate/authorization/advice: post: operationId: postSimulateAuthorizationAdvice requestBody: content: application/json: schema: $ref: '#/components/schemas/authorization_advice_model' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Original transaction not found '500': content: { } description: Server error summary: Simulates an authorization advice transaction tags: - simulate /simulate/clearing: post: operationId: postSimulateClearing requestBody: content: application/json: schema: $ref: '#/components/schemas/ClearingModel' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Original transaction not found '500': content: { } description: Server error summary: Simulates a clearing/settlement transaction tags: - simulate /simulate/directdeposits: post: operationId: postSimulateDirectdeposits requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectDepositRequest' description: Direct deposit simulate request model required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DepositDepositResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Simulates the creation of direct deposit tags: - simulate /simulate/financial: post: operationId: postSimulateFinancial requestBody: content: application/json: schema: $ref: '#/components/schemas/financial_request_model' description: Financial request model required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Simulates a financial request (PIN debit) transaction with optional cash back tags: - simulate /simulate/financial/advice: post: operationId: postSimulateFinancialAdvice requestBody: content: application/json: schema: $ref: '#/components/schemas/authorization_advice_model' description: Financial advice request model required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Original transaction not found '500': content: { } description: Server error summary: Simulates a financial advice transaction tags: - simulate /simulate/financial/balanceinquiry: post: operationId: postSimulateFinancialBalanceinquiry requestBody: content: application/json: schema: $ref: '#/components/schemas/balance_inquiry_request_model' description: Balance inquiry request model required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Simulates a balance inquiry tags: - simulate /simulate/financial/originalcredit: post: operationId: postSimulateFinancialOriginalcredit requestBody: content: application/json: schema: $ref: '#/components/schemas/orignalcredit_request_model' description: Orignal Credit request model required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Simulates an orignal credit transaction tags: - simulate /simulate/financial/withdrawal: post: operationId: postSimulateFinancialWithdrawal requestBody: content: application/json: schema: $ref: '#/components/schemas/withdrawal_request_model' description: ATM withdrawal request model required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Simulates an ATM withdrawal transaction tags: - simulate /simulate/reversal: post: operationId: postSimulateReversal requestBody: content: application/json: schema: $ref: '#/components/schemas/ReversalModel' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Original transaction not found '500': content: { } description: Server error summary: Simulates a reversal transaction tags: - simulate /simulation/accounts/{account_token}/refunds/{refund_token}/transitions: post: description: api to simulate status transition of a refund. operationId: simulateTransitionRefund parameters: - description: |- Unique identifier of the credit account for which you want to create a balance refund. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. explode: false in: path name: account_token required: true schema: type: string x-allowableValues: Existing account token style: simple - description: |- Unique identifier of the refund to retrieve. Send a `GET` request to `/credit/accounts/{account_token}/refunds/{refund_token}` to retrieve existing refunds. explode: false in: path name: refund_token required: true schema: type: string x-allowableValues: Existing refund token style: simple requestBody: content: application/json: example: status: COMPLETED token: my_refund_token schema: $ref: '#/components/schemas/SimulateRefundTransitionRequest' required: true responses: '201': content: application/json: example: account_token: my_account_token_12 amount: 10 created_time: 2025-01-02T20:17:28Z currency_code: USD description: credit balance refund method: ACH payment_source_token: my_payment_funding_source_token status: PENDING token: credit_balance_refund_token1234 type: CREDIT_BALANCE_REFUND updated_time: 2025-01-02T20:17:28Z schema: $ref: '#/components/schemas/RefundResponse' description: Expected response. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Simulate Refund Transition tags: - Refunds /spaces: get: operationId: getSpaces responses: default: content: { } description: successful operation summary: Get spaces. post: operationId: createSpace responses: default: content: { } description: successful operation summary: Create space. /spaces/redis-queue/{queueName}: delete: operationId: deleteQueue parameters: - explode: false in: path name: queueName required: true schema: type: string style: simple responses: default: content: { } description: successful operation /spaces/{space}/{key}: delete: operationId: deleteSpace parameters: - explode: false in: path name: space required: true schema: type: string style: simple - explode: false in: path name: key required: true schema: type: string style: simple responses: default: content: { } description: successful operation summary: Delete space. get: operationId: getSpace parameters: - explode: false in: path name: space required: true schema: type: string style: simple - explode: false in: path name: key required: true schema: type: string style: simple - explode: true in: query name: timeout required: false schema: format: int64 type: integer style: form responses: default: content: { } description: successful operation summary: Get space. post: operationId: createSpaceForKey parameters: - explode: false in: path name: space required: true schema: type: string style: simple - explode: false in: path name: key required: true schema: type: string style: simple - explode: true in: query name: timeout required: false schema: format: int64 type: integer style: form responses: default: content: { } description: successful operation summary: Create space for key. /substatuses: get: description: |- Retrieve an array of substatuses. This endpoint supports <>. operationId: listSubStatuses parameters: - description: |- Unique identifier of the account for which to retrieve substatuses. Send a `GET` request to `/credit/accounts` to retrieve existing account tokens. explode: true in: query name: account_token required: false schema: type: string x-allowableValues: Existing account token style: form - description: |- Unique identifier of the user for which to retrieve substatuses. Send a `GET` request to `/users` to retrieve existing user tokens. explode: true in: query name: user_token required: false schema: type: string x-allowableValues: Existing user token style: form - description: Denotes whether a substatus is active. explode: true in: query name: is_active required: false schema: type: boolean x-allowableValues: '`true`, `false`' style: form - description: |- Comma-delimited list of substatus types to include. Allowable values: `HARDSHIP`, `FRAUD`, `MLA`, `SCRA`, `DECEASED`, `BANKRUPTCY`, `POWER_OF_ATTORNEY`, `BLOCKED`, `CEASE_AND_DESIST`, `OPT_OUT` explode: true in: query name: substatuses required: false schema: items: enum: - HARDSHIP - FRAUD - MLA - SCRA - DECEASED - BANKRUPTCY - POWER_OF_ATTORNEY - BLOCKED - CEASE_AND_DESIST - OPT_OUT type: string type: array style: form - description: The number of resources to retrieve. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 minimum: 0 type: integer style: form - description: |- Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -createdTime enum: - createdTime - -createdTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubstatusPage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: List substatuses tags: - Credit Substatuses post: description: Create a new substatus for a credit account, user, or business. operationId: createSubStatus parameters: [ ] requestBody: content: application/json: example: attributes: - key: military_start_date value: 2024-04-02T11:23:23Z events: - channel: ADMIN reason: Documents submitted and verified state: ACTIVE resource_token: my_user_token resource_type: USER substatus: SCRA schema: $ref: '#/components/schemas/SubstatusCreateReq' required: true responses: '201': content: application/json: example: attributes: - key: military_start_date value: 2024-04-02T11:23:23Z created_time: 2024-05-17T21:50:13.729Z events: - channel: ADMIN created_time: 2024-05-17T21:50:13.740Z effective_date: 2024-05-17T21:50:13.738Z reason: Documents submitted and verified state: ACTIVE is_active: true resource_token: my_user_token resource_type: USER state: ACTIVE substatus: SCRA token: substatus_token updated_time: 2024-05-17T21:51:39.774Z schema: $ref: '#/components/schemas/SubstatusResponse' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Create substatus tags: - Credit Substatuses /substatuses/{substatus_token}: get: description: Retrieve a user or account substatus. operationId: retrieveSubStatus parameters: - description: |- Unique identifier of the substatus to retrieve. Send a `GET` request to `/credit/substatuses` to retrieve existing substatus tokens. explode: false in: path name: substatus_token required: true schema: type: string x-allowableValues: Existing substatus token style: simple responses: '200': content: application/json: example: attributes: - key: military_start_date value: 2024-04-02T11:23:23Z created_time: 2024-04-02T11:23:23Z events: - channel: ADMIN created_time: 2024-04-02T11:23:23Z effective_date: 2024-04-02T11:23:23Z reason: Documents submitted and verified state: ACTIVE is_active: true resource_token: my_user_token resource_type: USER state: ACTIVE substatus: SCRA token: substatus_token updated_time: 2024-04-02T11:23:23Z schema: $ref: '#/components/schemas/SubstatusResponse' description: A JSON object containing substatus information default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Retrieve substatus tags: - Credit Substatuses put: description: Updating a substatus registers a new event that changes the substatus' state. operationId: updateSubStatus parameters: - description: |- Unique identifier of the account substatus resource to retrieve. Send a `GET` request to `/credit/substatuses` to retrieve existing substatus tokens. explode: false in: path name: substatus_token required: true schema: type: string x-allowableValues: Existing substatus token style: simple requestBody: content: application/json: example: channel: ADMIN effective_date: 2024-04-09T11:23:23Z reason: Remove substatus from account state: INACTIVE schema: $ref: '#/components/schemas/SubstatusUpdateReq' required: true responses: '200': content: application/json: example: attributes: [ ] created_time: 2024-04-02T11:23:23Z events: - channel: SYSTEM created_time: 2024-04-02T11:23:23Z effective_date: 2024-04-02T11:23:23Z reason: Fraud system detected suspicious activity state: ACTIVE - channel: ADMIN created_time: 2024-04-02T11:23:23Z effective_date: 2024-04-02T11:23:23Z reason: Verified non-fraud with cardholder state: INACTIVE is_active: false resource_token: my_account_token resource_type: ACCOUNT state: INACTIVE substatus: FRAUD token: substatus_token updated_time: 2024-04-02T11:23:23Z schema: $ref: '#/components/schemas/SubstatusResponse' description: Updated substatus response. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Update substatus tags: - Credit Substatuses /transactions: get: description: |- List all transactions. By default, this endpoint returns transactions conducted within the last 30 days. To return transactions older than 30 days, you must include the `start_date` and `end_date` query parameters in your request. By default, `GET /transactions` returns transactions having either `PENDING` or `COMPLETION` states. This endpoint supports <> and <>. operationId: getTransactions parameters: - description: The number of transactions to retrieve. explode: true in: query name: count required: false schema: default: 10 format: int32 type: integer style: form - description: The sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -user_transaction_time enum: - -created_time - created_time - -user_transaction_time - user_transaction_time type: string style: form - description: |- The starting date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the `start_date` and `end_date` fields. explode: true in: query name: start_date required: false schema: type: string style: form - description: |- The ending date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the `end_date` and `start_date` fields. explode: true in: query name: end_date required: false schema: type: string style: form - description: Comma-delimited list of transaction types to include. explode: true in: query name: type required: false schema: type: string style: form - description: The unique identifier of the user account holder. explode: true in: query name: user_token required: false schema: type: string style: form - description: The unique identifier of the business account holder. explode: true in: query name: business_token required: false schema: type: string style: form - description: The unique identifier of the acting user. explode: true in: query name: acting_user_token required: false schema: type: string style: form - description: The unique identifier of the card. explode: true in: query name: card_token required: false schema: type: string style: form - description: Account token explode: true in: query name: account_token required: false schema: type: string style: form - description: Comma-delimited list of transaction states to display. explode: true in: query name: state required: false schema: default: PENDING,COMPLETION type: string style: form - description: Specifies the API version for the request. explode: true in: query name: version required: false schema: type: string style: form - description: If `true`, the query returns additional information for diagnostic purposes. explode: true in: query name: verbose required: false schema: type: boolean style: form - description: Start identifier explode: true in: query name: start_identifier required: false schema: format: int64 type: integer style: form responses: '200': content: application/json: example: count: 2 data: - acquirer: institution_country: '840' institution_id_code: '428399181' retrieval_reference_number: '528294182583' system_trace_audit_number: '656761' acting_user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 amount: 10.0 card: metadata: null card_security_code_verification: response: code: '0000' memo: Card security code match type: CVV1 card_token: 02cc766c-24a5-4c3b-adcf-0e5e27b09329 created_time: 2024-08-21T17:26:29Z currency_code: USD duration: 537 fraud: network: account_risk_score: '7' transaction_risk_score: 97 gpa: available_balance: 0.0 balances: USD: available_balance: 0.0 credit_balance: 0.0 currency_code: USD impacted_amount: 10.0 ledger_balance: 20.0 pending_credits: 0.0 credit_balance: 0.0 currency_code: USD impacted_amount: 10.0 ledger_balance: 20.0 pending_credits: 0.0 gpa_order: amount: 10.0 created_time: 2024-08-21T17:26:30Z currency_code: USD funding: amount: 10.0 gateway_log: duration: 481 message: Approved or completed successfully order_number: '1200' response: code: '200' data: jit_funding: address_verification: gateway: on_file: postal_code: '94601' street_address: 2000 High St response: code: '0000' memo: Address and postal code match amount: 10.0 method: pgfs.authorization original_jit_funding_token: your-jit-funding-token token: your-jit-funding-token user_token: your-jit-funding-user timed_out: false transaction_id: your-jit-funding-token source: active: true created_time: 2024-08-21T17:25:43Z is_default_account: false last_modified_time: 2024-08-21T17:25:43Z name: PGFS for simulating transactions token: '**********dd5f' type: programgateway funding_source_token: '**********dd5f' jit_funding: acting_user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 amount: 10.0 method: pgfs.authorization token: 251bdc52-588a-4291-8c5d-6ded3a67e1a8 user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 last_modified_time: 2024-08-21T17:26:30Z response: code: '0000' memo: Approved or completed successfully state: PENDING token: 592b8164-a4af-45ee-ab24-13a4bb43e6b2 transaction_token: cd22cff7-2845-4508-a916-cf89fd9edae1 user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 issuer_payment_node: b9a60cd41a2cc1c23090ed3666bdbf1z issuer_received_time: 2024-08-21T17:26:29Z network: MARQETA pos: card_holder_presence: false card_presence: false is_recurring: false pan_entry_mode: MAG_STRIPE partial_approval_capable: false pin_entry_mode: 'TRUE' purchase_amount_only: false terminal_attendance: ATTENDED preceding_related_transaction_token: 06a8fe88-58b1-4682-a8ad-96eb973e1d74 response: code: '0000' memo: Approved or completed successfully state: PENDING subnetwork: GATEWAY_JIT token: cd22cff7-2845-4508-a916-cf89fd9edae1 transaction_metadata: payment_channel: OTHER type: gpa.credit.authorization user: metadata: null user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 user_transaction_time: 2024-08-21T17:26:29Z - acquirer: institution_country: '840' institution_id_code: '428399181' retrieval_reference_number: '528294182583' system_trace_audit_number: '656761' acquirer_fee_amount: 0.0 acting_user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 amount: 10.0 approval_code: '761515' card: metadata: null card_acceptor: city: Berkeley country_code: USA mcc: '6411' mid: '000000000011111' name: Aegis Fleet Services street_address: 111 Main St card_security_code_verification: response: code: '0000' memo: Card security code match type: CVV1 card_token: 02cc766c-24a5-4c3b-adcf-0e5e27b09329 created_time: 2024-08-21T17:26:29Z currency_code: USD duration: 622 fraud: network: account_risk_score: '7' transaction_risk_score: 97 gpa: available_balance: 0.0 balances: USD: available_balance: 0.0 credit_balance: 0.0 currency_code: USD impacted_amount: -10.0 ledger_balance: 20.0 pending_credits: 0.0 credit_balance: 0.0 currency_code: USD impacted_amount: -10.0 ledger_balance: 20.0 pending_credits: 0.0 gpa_order: amount: 10.0 created_time: 2024-08-21T17:26:30Z funding: amount: 10.0 currency_code: USD funding_source_token: '**********dd5f' gateway_log: duration: 481 message: Approved or completed successfully order_number: '1200' response: code: '200' data: jit_funding: address_verification: gateway: on_file: postal_code: '94601' street_address: 2000 High St response: code: '0000' memo: Address and postal code match amount: 10.0 method: pgfs.authorization original_jit_funding_token: your-jit-funding-token token: your-jit-funding-token user_token: your-jit-funding-user timed_out: false transaction_id: your-jit-funding-token jit_funding: acting_user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 amount: 10.0 method: pgfs.authorization token: 251bdc52-588a-4291-8c5d-6ded3a67e1a8 user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 source: active: true created_time: 2024-08-21T17:25:43Z is_default_account: false last_modified_time: 2024-08-21T17:25:43Z name: PGFS for simulating transactions token: '**********dd5f' type: programgateway user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 last_modified_time: 2024-08-21T17:26:30Z response: code: '0000' memo: Approved or completed successfully state: PENDING token: 592b8164-a4af-45ee-ab24-13a4bb43e6b2 transaction_token: cd22cff7-2845-4508-a916-cf89fd9edae1 issuer_payment_node: b9a60cd41a2cc1c23090ed3666bdbf1z issuer_received_time: 2024-08-21T17:26:29Z network: VISA pos: card_holder_presence: false card_presence: false is_recurring: false pan_entry_mode: MAG_STRIPE partial_approval_capable: false pin_entry_mode: 'TRUE' purchase_amount_only: false terminal_attendance: ATTENDED terminal_id: TR100000 request_amount: 10.0 response: code: '0000' memo: Approved or completed successfully settlement_date: 2024-08-21T00:00:00Z state: PENDING subnetwork: VISANET token: 06a8fe88-58b1-4682-a8ad-96eb973e1d74 transaction_metadata: payment_channel: OTHER type: authorization user: metadata: null user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 user_transaction_time: 2024-08-21T17:26:29Z end_index: 1 is_more: true start_index: 0 schema: $ref: '#/components/schemas/TransactionModelListResponse' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: List transactions tags: - Transactions /transactions/fundingsource/{funding_source_token}: get: description: |- List transactions for a specific funding source. By default, this endpoint returns transactions conducted within the last 30 days. To return transactions older than 30 days, you must include the `start_date` and `end_date` query parameters in your request. By default, `GET /transactions/fundingsource/{funding_source_token}` returns transactions having either `PENDING` or `COMPLETION` states. This endpoint supports <> and <>. operationId: getTransactionsFundingsourceFundingsourcetoken parameters: - description: The unique identifier of the funding account. explode: false in: path name: funding_source_token required: true schema: type: string style: simple - description: The number of transactions to retrieve. explode: true in: query name: count required: false schema: default: 10 format: int32 type: integer style: form - description: The sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -user_transaction_time enum: - -created_time - created_time - -user_transaction_time - user_transaction_time type: string style: form - description: |- The starting date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the `start_date` and `end_date` fields. explode: true in: query name: start_date required: false schema: type: string style: form - description: |- The ending date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the `end_date` and `start_date` fields. explode: true in: query name: end_date required: false schema: type: string style: form - description: Comma-delimited list of transaction types to include. explode: true in: query name: type required: false schema: type: string style: form - description: Specifies whether to return credit or debit transactions. explode: true in: query name: polarity required: false schema: enum: - CREDIT - DEBIT - PENDING_CREDIT - PENDING_DEBIT type: string style: form - description: Specifies the API version for the request. explode: true in: query name: version required: false schema: type: string style: form - description: If `true`, the query returns additional information for diagnostic purposes. explode: true in: query name: verbose required: false schema: type: boolean style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/TransactionModelListResponse' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: List transactions for a funding account tags: - Transactions /transactions/{token}: get: description: |- Retrieve a specific transaction. Include the `token` path parameter to identify the transaction. [NOTE] Transactions are not available in real time via this endpoint, and typically appear after 30 seconds. On occasion, a transaction may require up to four hours to appear. operationId: getTransactionsToken parameters: - description: The unique identifier of the transaction. explode: false in: path name: token required: true schema: type: string style: simple - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Specifies the API version for the request. explode: true in: query name: version required: false schema: type: string style: form - description: If `true`, the query returns additional information for diagnostic purposes. explode: true in: query name: verbose required: false schema: type: boolean style: form responses: '200': content: application/json: example: acquirer: institution_country: '840' institution_id_code: '428399181' retrieval_reference_number: '528294182583' system_trace_audit_number: '656761' acquirer_fee_amount: 0.0 acting_user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 amount: 10.0 approval_code: '761515' card: metadata: null card_acceptor: city: Berkeley country_code: USA mcc: '6411' mid: '000000000011111' name: Aegis Fleet Services street_address: 111 Main St card_security_code_verification: response: code: '0000' memo: Card security code match type: CVV1 card_token: 02cc766c-24a5-4c3b-adcf-0e5e27b09329 cardholder_authentication_data: electronic_commerce_indicator: authentication_successful verification_result: verified verification_value_created_by: issuer_acs created_time: 2024-08-21T17:26:29Z currency_code: USD currency_conversion: network: conversion_rate: 1.0 dynamic_currency_conversion: false original_amount: 10.0 original_currency_code: '840' duration: 622 fraud: network: account_risk_score: '7' transaction_risk_score: 97 gpa: available_balance: 0.0 balances: USD: available_balance: 0.0 credit_balance: 0.0 currency_code: USD impacted_amount: -10.0 ledger_balance: 20.0 pending_credits: 0.0 credit_balance: 0.0 currency_code: USD impacted_amount: -10.0 ledger_balance: 20.0 pending_credits: 0.0 gpa_order: amount: 10 created_time: 2024-08-21T17:26:30Z currency_code: USD funding: amount: 10.0 gateway_log: duration: 481 message: Approved or completed successfully order_number: '1200' response: code: '200' data: - jit_funding: address_verification: gateway: on_file: postal_code: '94601' street_address: 2000 High St response: code: '0000' memo: Address and postal code match amount: 10.0 method: pgfs.authorization original_jit_funding_token: your-jit-funding-token token: your-jit-funding-token user_token: your-jit-funding-user timed_out: false transaction_id: your-jit-funding-token source: active: true created_time: 2024-08-21T17:25:43Z is_default_account: false last_modified_time: 2024-08-21T17:25:43Z name: PGFS for simulating transactions token: '**********dd5f' type: programgateway funding_source_token: '**********dd5f' jit_funding: acting_user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 amount: 10.0 method: pgfs.authorization token: 251bdc52-588a-4291-8c5d-6ded3a67e1a8 user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 last_modified_time: 2024-08-21T17:26:30Z response: code: '0000' memo: Approved or completed successfully state: PENDING token: 592b8164-a4af-45ee-ab24-13a4bb43e6b2 transaction_token: cd22cff7-2845-4508-a916-cf89fd9edae1 user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 issuer_payment_node: b9a60cd41a2cc1c23090ed3666bdbf1z issuer_received_time: 2024-08-21T17:26:29Z network: VISA pos: card_holder_presence: false card_presence: false is_recurring: false pan_entry_mode: MAG_STRIPE partial_approval_capable: false pin_entry_mode: 'TRUE' purchase_amount_only: false terminal_attendance: ATTENDED terminal_id: TR100000 request_amount: 10.0 response: code: '0000' memo: Approved or completed successfully settlement_date: 2024-08-21T00:00:00Z state: PENDING subnetwork: VISANET token: 06a8fe88-58b1-4682-a8ad-96eb973e1d74 transaction_metadata: payment_channel: OTHER type: authorization user: metadata: null user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 user_transaction_time: 2024-08-21T17:26:29Z schema: $ref: '#/components/schemas/transaction_model' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Transaction token not found '500': content: { } description: Server error summary: Retrieve transaction tags: - Transactions /transactions/{token}/related: get: description: |- List all transactions related to the specified transaction. By default, this endpoint returns transactions conducted within the last 30 days. To return transactions older than 30 days, you must include the `start_date` and `end_date` query parameters in your request. By default, this endpoint returns transactions of any state. To return transactions in specific states, you must include the `state` query parameter in your request. This endpoint supports <> and <>. operationId: getTransactionsTokenRelated parameters: - description: The unique identifier of the transaction. explode: false in: path name: token required: true schema: type: string style: simple - description: The number of transactions to retrieve. explode: true in: query name: count required: false schema: default: 10 format: int32 type: integer style: form - description: The sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -user_transaction_time enum: - -created_time - created_time - -user_transaction_time - user_transaction_time type: string style: form - description: |- The starting date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the `start_date` and `end_date` fields. explode: true in: query name: start_date required: false schema: type: string style: form - description: |- The ending date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the `end_date` and `start_date` fields. explode: true in: query name: end_date required: false schema: type: string style: form - description: Comma-delimited list of transaction types to include. explode: true in: query name: type required: false schema: type: string style: form - description: Comma-delimited list of transaction states to display. explode: true in: query name: state required: false schema: default: ALL type: string style: form - description: Specifies the API version for the request. explode: true in: query name: version required: false schema: type: string style: form - description: If `true`, the query returns additional information for diagnostic purposes. explode: true in: query name: verbose required: false schema: type: boolean style: form responses: '200': content: application/json: example: count: 1 data: - acquirer: institution_country: '840' institution_id_code: '428399181' retrieval_reference_number: '528294182583' system_trace_audit_number: '656761' acting_user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 amount: 10.0 card: metadata: null card_security_code_verification: response: code: '0000' memo: Card security code match type: CVV1 card_token: 02cc766c-24a5-4c3b-adcf-0e5e27b09329 created_time: 2024-08-21T17:26:29Z currency_code: USD duration: 537 fraud: network: account_risk_score: '7' transaction_risk_score: 97 gpa: available_balance: 0.0 balances: USD: available_balance: 0.0 credit_balance: 0.0 currency_code: USD impacted_amount: 10.0 ledger_balance: 20.0 pending_credits: 0.0 credit_balance: 0.0 currency_code: USD impacted_amount: 10.0 ledger_balance: 20.0 pending_credits: 0.0 gpa_order: amount: 10.0 created_time: 2024-08-21T17:26:30Z funding: amount: 10.0 currency_code: USD funding_source_token: '**********dd5f' gateway_log: duration: 481 message: Approved or completed successfully order_number: '1200' response: code: '200' data: jit_funding: address_verification: gateway: on_file: postal_code: 94601 street_address: 2000 High St response: code: '0000' memo: Address and postal code match amount: 10.0 method: pgfs.authorization original_jit_funding_token: your-jit-funding-token token: your-jit-funding-token user_token: your-jit-funding-user timed_out: false transaction_id: your-jit-funding-token jit_funding: acting_user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 amount: 10.0 method: pgfs.authorization token: 251bdc52-588a-4291-8c5d-6ded3a67e1a8 user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 source: active: true created_time: 2024-08-21T17:25:43Z is_default_account: false last_modified_time: 2024-08-21T17:25:43Z name: PGFS for simulating transactions token: '**********dd5f' type: programgateway user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 last_modified_time: 2024-08-21T17:26:30Z response: code: '0000' memo: Approved or completed successfully state: PENDING token: 592b8164-a4af-45ee-ab24-13a4bb43e6b2 transaction_token: cd22cff7-2845-4508-a916-cf89fd9edae1 issuer_payment_node: b9a60cd41a2cc1c23090ed3666bdbf1z issuer_received_time: 2024-08-21T17:26:29Z network: MARQETA pos: card_holder_presence: false card_presence: false is_recurring: false pan_entry_mode: MAG_STRIPE partial_approval_capable: false pin_entry_mode: 'TRUE' purchase_amount_only: false terminal_attendance: ATTENDED preceding_related_transaction_token: 06a8fe88-58b1-4682-a8ad-96eb973e1d74 response: code: '0000' memo: Approved or completed successfully state: PENDING subnetwork: GATEWAY_JIT token: cd22cff7-2845-4508-a916-cf89fd9edae1 transaction_metadata: payment_channel: OTHER type: gpa.credit.authorization user: metadata: null user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 user_transaction_time: 2024-08-21T17:26:29Z end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/TransactionModelListResponse' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: List related transactions tags: - Transactions /users: get: description: |- To return an array of all of a program's users, send a `GET` request to the `/users` endpoint. This endpoint supports <> and <>. To narrow your result set to users that match certain criteria, see the <> endpoint. The `business_token` field is conditionally returned in the response (it cannot be set through the API). You can use this field in conjunction with the `parent_token` field to determine whether the user has a parent or grandparent that is a business: [cols="1,1,1"] |=== | parent_token | business_token | Description | Not populated | Not populated | User does not have a parent. | Populated | Not populated | User's parent is a user. | Populated; matches `business_token` | Populated; matches `parent_token` | User's parent is a business. | Populated; does not match `business_token` | Populated; does not match `parent_token` | User's parent is a user and their grandparent is a business. |=== operationId: getUsers parameters: - description: Number of user resources to retrieve. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Search type. explode: true in: query name: search_type required: false schema: type: string style: form - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 2 data: - account_holder_group_token: DEFAULT_AHG active: true address1: 1234 Grove Street birth_date: 1991-01-01 city: Berkeley country: USA created_time: 2022-08-16T19:43:02Z email: jane.doe@company.com first_name: Jane gender: F identifications: - type: SSN value: '5555' last_modified_time: 2022-08-16T19:43:02Z last_name: Doe metadata: authentication_answer1: Cashier authentication_answer2: Trabant authentication_answer3: Blue authentication_question1: What was your first job? authentication_question2: What make was your first car? authentication_question3: What is your favorite color? notification_email: jane.doe@home.com notification_language: spa password: P@ssw0rd phone: '15105551212' postal_code: '94702' state: CA status: ACTIVE token: my_user_01 uses_parent_account: false - account_holder_group_token: DEFAULT_AHG active: true address1: 2345 Main Street birth_date: 1992-02-02 city: Berkeley country: USA created_time: 2023-03-14T00:45:00Z email: john.doe@company.com first_name: John gender: M identifications: - type: SSN value: '4444' last_modified_time: 2023-03-14T00:45:00Z last_name: Doe metadata: key1: value1 key2: value2 password: my-password phone: '15105551212' postal_code: '94702' state: CA status: ACTIVE token: my_user_02 uses_parent_account: false end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/UserCardHolderListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List users tags: - Users post: description: |- This endpoint enables you to create a user. A new user's initial status depends on the <> of the program or associated <>. [cols="1,1,1,1"] |=== | KYC Required | Initial User Status | User Active on Creation | User Limitations | Always | `UNVERIFIED` | Optional | Cannot load funds; cannot activate cards. | Conditionally | `LIMITED` | Optional | Restricted by rules in `accountholdergroups.pre_kyc_controls`. | Never | `ACTIVE` | Required | None. |=== [NOTE] Use the `/usertransitions` endpoints to transition user resources between statuses and to view the history of a user's status. Do not set the value of the `user.active` field directly. For more information on status changes, see <>. To perform KYC verification on users, the user object must have the following fields configured: * `first_name` (legal first name only, no prefixes) * `last_name` (legal last name only, no suffixes) * `address1` (cannot be a PO Box) * `city` * `state` * `postal_code` * `country` * `birth_date` * `identifications` * `phone` (required in some cases) * `email` (required in some cases) [NOTE] The `identifications` requirement depends on your program's configuration. To determine if you should provide a full or abbreviated identification number, contact your Marqeta representative. KYC verification requires the full Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) of the user. To create a child user, you must identify the parent user or business and determine whether the child user shares an account with the parent. The parent must be an existing user or business. On the child user, set the `parent_token` field to the value of the parent's `token` field. If either the parent or the grandparent is a business, a `business_token` field is added to the user. This field's value is set to the token of either the parent or grandparent (whichever is the business). The `uses_parent_account` field determines whether the child shares balances with the parent (`true`) or whether the child balances are independent of the parent (`false`). If you do not specify a value for `uses_parent_account`, it is set to `false` by default (the user does not share the parent's balance) and returned in the response body. This field cannot be updated, so you must decide upon creation whether the child user shares the parent balance. Sharing an account with a parent user affects how the child user interacts with cards as follows: * A child user cannot spend funds if its parent is not active. * An active child user can activate cards, whether the parent is active or not. operationId: postUsers requestBody: content: application/json: example: address1: 1234 Grove Street birth_date: 1991-01-01 birth_place: US city: Berkeley country: USA email: jane.doe@company.com first_name: Jane gender: F identifications: - type: SSN value: '111234444' last_name: Doe metadata: authentication_answer1: Cashier authentication_answer2: Trabant authentication_answer3: Blue authentication_question1: What was your first job? authentication_question2: What make was your first car? authentication_question3: What is your favorite color? notification_email: jane.doe@home.com notification_language: spa password: P@ssw0rd phone: '15105551212' postal_code: '94702' state: CA title: Chief Comptroller token: my_user_01 uses_parent_account: false schema: $ref: '#/components/schemas/card_holder_model' required: false responses: '201': content: application/json: example: account_holder_group_token: DEFAULT_AHG active: true address1: 1234 Grove Street birth_date: 1991-01-01 birth_place: US city: Berkeley corporate_card_holder: false country: USA created_time: 2023-03-26T20:21:24Z email: jane.doe6@company.com first_name: Jane gender: F last_modified_time: 2023-03-26T20:21:24Z last_name: Doe metadata: authentication_answer1: Cashier authentication_answer2: Trabant authentication_answer3: Blue authentication_question1: What was your first job? authentication_question2: What make was your first car? authentication_question3: What is your favorite color? notification_email: jane.doe@home.com notification_language: spa password: P@ssw0rd phone: '15105551212' ssn: '5555' state: CA status: ACTIVE title: Chief Comptroller token: my_user_01 uses_parent_account: false zip: '94702' schema: $ref: '#/components/schemas/user_card_holder_response' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Request already processed with a different payload '412': content: { } description: Pre-condition setup issue '500': content: { } description: Server error summary: Create user tags: - Users /users/auth/changepassword: post: description: |- To change a user password, send a `POST` request to the `/users/auth/changepassword` endpoint and include the `current_password` and `new_password` in link:http://www.json.org/[JSON, window="_blank"] format in the body of the request. This endpoint operates in the context of a currently logged-in user. A successful password change returns an empty response body with a response code of `204 No Content`. operationId: postUsersAuthChangepassword requestBody: content: application/json: example: current_password: my_old_password new_password: my_new_password schema: $ref: '#/components/schemas/password_update_model' description: Password update object required: true responses: '204': content: { } description: Success '400': content: { } description: User input error/Bad request '401': content: { } description: Unauthorized '500': content: { } description: Server error summary: Update user password tags: - Users /users/auth/clientaccesstoken: post: description: |- Each time you want to display a virtual card's sensitive data (for example, when using `marqeta.js`), you must first request a new, single-use client access token from the Marqeta platform by sending a `POST` request to the `/users/auth/clientaccesstoken` endpoint. Unredeemed client access tokens expire after five minutes. operationId: postUsersAuthClientaccesstoken requestBody: content: application/json: example: card_token: my_card_01 schema: $ref: '#/components/schemas/client_access_token_request' required: false responses: '201': content: application/json: example: created: 2022-07-29T12:00:00Z expires: 2022-07-29T12:05:00Z token: ewogICJ0b2tlbiI6ICI5NzIwMDkwNS00ODc0LTRkMWEtODEzMS1jMWI3NDAwNzJjM2MmYXBwbGljYXRpb25fdG9rZW49eW91cl9hcHBsaWNhdGlvbl90b2tlbiIsCiAgImFwcGxpY2F0aW9uIjogewogICAgInRva2VuIjogInlvdXJfYXBwbGljYXRpb25fdG9rZW4iLAogICAgImFjdGl2ZSI6IHRydWUsCiAgICAiY2xpZW50X2FwaV9iYXNlX3VybCI6ICJodHRwOi8vd2lkZ2V0cy1lbnYubWFycWV0YS5jb20vY2xpZW50L2FwaS92MSIsCiAgICAiYXNzZXRzX3VybCI6ICJodHRwOi8vd2lkZ2V0cy1lbnYubWFycWV0YS5jb20vY2xpZW50L2Fzc2V0cy8xLjAuMCIsCiAgICAiY2xpZW50dG9rZW5hcHBsaWNhdGlvbklkIjogIjU3MDI2OTJhMGI4ZGNlOTg1YWVmNTExMiIKICB9LAogICJhcHBsaWNhdGlvbl90b2tlbiI6IG51bGwsCiAgImV4cGlyZXMiOiAiMjAxOC0xMi0zMVQyMzo1OTo1OSswMDAwIiwKICAiY2FyZF90b2tlbiI6ICJ0b2tlbl9vZl90aGVfY2FyZF95b3VfbmVlZF90b19wcmVzZW50IiwKICAiYWNjZXNzZWQiOiBudWxsLAogICJjbGllbnR0b2tlbklkIjogIjU5MTc2Y2JlMGI4ZGNlOTg1YWVmNTEzMCIsCiAgImNyZWF0ZWQiOiAiMjAxOC0wMS0wMVQwMDowMDowMCswMDAwIgp9 schema: $ref: '#/components/schemas/client_access_token_response' description: Created '400': content: { } description: User input error/Bad request '401': content: { } description: Unauthorized '500': content: { } description: Server error summary: Create client access token tags: - Users /users/auth/clientaccesstoken/{token}: get: description: To retrieve application and card information using a client access token, send a `GET` request to the `/users/auth/clientaccesstoken/{token}` endpoint. operationId: getUsersAuthClientaccesstokenToken parameters: - description: Client access token. explode: false in: path name: token required: true schema: type: string style: simple - description: Unique identifier of the `application` object. explode: true in: query name: application_token required: false schema: type: string style: form responses: '200': content: application/json: example: created: 2022-07-29T12:00:00Z expires: 2022-07-29T12:05:00Z token: ewogICJ0b2tlbiI6ICI5NzIwMDkwNS00ODc0LTRkMWEtODEzMS1jMWI3NDAwNzJjM2MmYXBwbGljYXRpb25fdG9rZW49eW91cl9hcHBsaWNhdGlvbl90b2tlbiIsCiAgImFwcGxpY2F0aW9uIjogewogICAgInRva2VuIjogInlvdXJfYXBwbGljYXRpb25fdG9rZW4iLAogICAgImFjdGl2ZSI6IHRydWUsCiAgICAiY2xpZW50X2FwaV9iYXNlX3VybCI6ICJodHRwOi8vd2lkZ2V0cy1lbnYubWFycWV0YS5jb20vY2xpZW50L2FwaS92MSIsCiAgICAiYXNzZXRzX3VybCI6ICJodHRwOi8vd2lkZ2V0cy1lbnYubWFycWV0YS5jb20vY2xpZW50L2Fzc2V0cy8xLjAuMCIsCiAgICAiY2xpZW50dG9rZW5hcHBsaWNhdGlvbklkIjogIjU3MDI2OTJhMGI4ZGNlOTg1YWVmNTExMiIKICB9LAogICJhcHBsaWNhdGlvbl90b2tlbiI6IG51bGwsCiAgImV4cGlyZXMiOiAiMjAxOC0xMi0zMVQyMzo1OTo1OSswMDAwIiwKICAiY2FyZF90b2tlbiI6ICJ0b2tlbl9vZl90aGVfY2FyZF95b3VfbmVlZF90b19wcmVzZW50IiwKICAiYWNjZXNzZWQiOiBudWxsLAogICJjbGllbnR0b2tlbklkIjogIjU5MTc2Y2JlMGI4ZGNlOTg1YWVmNTEzMCIsCiAgImNyZWF0ZWQiOiAiMjAxOC0wMS0wMVQwMDowMDowMCswMDAwIgp9 schema: $ref: '#/components/schemas/client_access_token_response' description: Success '400': content: { } description: Bad request '401': content: { } description: Unauthorized '403': content: { } description: Forbidden '500': content: { } description: Server error summary: Retrieve client access token tags: - Users /users/auth/login: post: description: |- To log in a user and return a user access token, send a `POST` request to the `/users/auth/login` endpoint and include the user details in link:http://www.json.org/[JSON, window="_blank"] format in the body of the request. [TIP] To check a user's credentials without logging out the user, call the `/users/auth/onetime` endpoint. operationId: postUsersAuthLogin requestBody: content: application/json: example: email: jane.doe@company.com password: P@ssw0rd user_token: my_user_01 schema: $ref: '#/components/schemas/login_request_model' description: User login object required: false responses: '204': content: application/json: example: access_token: expires: 2027-03-01T21:02:04Z one_time: false token: e12b1f64-1444-4aa3-83d9-347800c68e94 user: active: true created_time: 2023-04-01T17:52:39Z email: jane.doe@company.com last_modified_time: 2023-04-01T17:52:39Z password: P@ssw0rd token: my_user_01 uses_parent_account: false schema: $ref: '#/components/schemas/login_response_model' description: Success '400': content: { } description: User input error/Bad request '401': content: { } description: Unauthorized '500': content: { } description: Server error summary: Log in user tags: - Users /users/auth/logout: post: description: |- To log out a user, send a `POST` request to the `/users/auth/logout` endpoint. A successful logout returns an empty response body with a response code of `204 No Content`. operationId: postUsersAuthLogout responses: '204': content: { } description: Success '400': content: { } description: User input error/Bad request '401': content: { } description: Unauthorized '500': content: { } description: Server error summary: Log out user tags: - Users /users/auth/onetime: post: description: |- This endpoint returns a single-use access token. This type of token authorizes a single request to access API endpoints and data associated with a particular user. A single-use access token differs from a user access token (as returned by `POST` `/users/auth/login`) only in the number of times it can be used. To return a single-use access token, send a `POST` request to the `/users/auth/onetime` endpoint. Provide one of these sets of input data: * *Case #1* – Application token and user access token * *Case #2* – Application token, admin access token, and user token * *Case #3* – Application token, user's Marqeta password, and user's email address In each case, provide the application token as the HTTP Basic Authentication username in the request header's Authorization field. When applicable, provide the user access token or admin access token as the HTTP Basic Authentication password. When applicable, provide the user token or user's Marqeta password and email address in link:http://www.json.org/[JSON, window="_blank"] format in the request body. Before instantiating an embedded Marqeta widget, call this endpoint to obtain the single-use access token required as input (cases #1 and #2). This endpoint is also useful when you want to check a user's credentials before performing a sensitive operation without having to log out the user (case #3). [NOTE] Calling this endpoint and returning a single-use access token does not invalidate the user's current user access token. operationId: postUsersAuthOnetime requestBody: content: application/json: examples: case_one: summary: '*Case 1:* Authorization: Basic `my_application_token:my_user_access_token`' value: { } case_three: summary: '*Case 3:* Authorization: Basic `my_application_token`' value: email: jane.doe@company.com password: P@ssw0rd case_two: summary: '*Case 2:* Authorization: Basic `my_application_token:my_admin_access_token`' value: user_token: my_user_token schema: $ref: '#/components/schemas/one_time_request_model' description: One-time object required: false responses: '201': content: application/json: example: expires: 2024-04-01T00:00:00Z one_time: true token: 697e0bde-ea52-44bd-8150-0e0f83e9625d schema: $ref: '#/components/schemas/access_token_response' description: Created '400': content: { } description: User input error/Bad request '401': content: { } description: Unauthorized '500': content: { } description: Server error summary: Create single-use token tags: - Users /users/auth/resetpassword: post: description: |- Use this endpoint to generate a password reset token for a user. Send a `POST` request to the `/users/auth/resetpassword` endpoint and include the user's email address in link:http://www.json.org/[JSON, window="_blank"] format in the body of the request. This request generates and sends an email message containing the `user_token` and `password_reset_token` to the user's email address. You must customize the email message with a link that passes the `user_token` and `password_reset_token` to a web page where a subsequent request updates the password. A successful request returns an empty response body with a response code of `204 No Content`. operationId: postUsersAuthResetpassword requestBody: content: application/json: example: email: jane.doe@company.com schema: $ref: '#/components/schemas/reset_user_password_email_model' required: false responses: '204': content: { } description: Success '400': content: { } description: User input error/Bad request '401': content: { } description: Unauthorized '500': content: { } description: Server error summary: Request user password reset token tags: - Users /users/auth/resetpassword/{token}: post: description: |- To reset the user's password, send a `POST` request to the `/users/auth/resetpassword/{token}` endpoint that includes a password reset token generated using the `POST /users/auth/resetpassword` operation. Include the `user_token` and `new_password` in link:http://www.json.org/[JSON, window="_blank"] format in the body of the request. Include the `password_reset_token` as a path parameter. A successful password reset returns an empty response body with a response code of `204 No Content`. operationId: postUsersAuthResetpasswordToken parameters: - description: Password reset token generated using the `POST /users/auth/resetpassword` operation. explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: example: new_password: newPassword123@ user_token: my_user_01 schema: $ref: '#/components/schemas/reset_user_password_model' required: false responses: '204': content: { } description: Success '400': content: { } description: User input error/Bad request '401': content: { } description: Unauthorized '500': content: { } description: Server error summary: Reset user password tags: - Users /users/auth/verifyemail: post: description: |- Send a `POST` request to the `/users/auth/verifyemail` endpoint to request an email verification token. No input parameters are required because this operation is performed in the context of an authenticated user. This initial request generates and sends an email message containing the email verification token to the cardholder's email address. This email message must include a link that passes the email verification token to a web page where a subsequent request verifies the email address. A successful request returns an empty response body with a response code of `204 No Content`. operationId: postUsersAuthVerifyemail responses: '204': content: { } description: Success '400': content: { } description: User input error/Bad request '401': content: { } description: Unauthorized '500': content: { } description: Server error summary: Request email verification token tags: - Users /users/auth/verifyemail/{token}: post: description: |- To verify a user's email address, send a `POST` request to the `/users/auth/verifyemail/{email_verification_token}` endpoint that includes an `email_verification_token` generated using the `POST /users/auth/verifyemail` operation. Include the `email_verification_token` as a path parameter. A successful email verification returns an empty response body with a response code of `204 No Content`. operationId: postUsersAuthVerifyemailToken parameters: - description: Email verification token generated using the `POST /users/auth/verifyemail` operation. explode: false in: path name: token required: true schema: type: string style: simple responses: '204': content: { } description: Success '400': content: { } description: User input error/Bad request '401': content: { } description: Unauthorized '500': content: { } description: Server error summary: Verify email address tags: - Users /users/lookup: post: description: |- To search for one or more users, send a `POST` request to the `/users/lookup` endpoint. Include in the message body any parameters by which you want to query. This endpoint supports <> and <>. operationId: postUsersLookup parameters: - description: Number of user resources to retrieve. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Search type. explode: true in: query name: search_type required: false schema: type: string style: form - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form requestBody: content: application/json: example: first_name: Jane schema: $ref: '#/components/schemas/user_card_holder_search_model' required: false responses: '200': content: application/json: example: count: 1 data: - account_holder_group_token: DEFAULT_AHG active: true address1: 1234 Grove Street birth_date: 1991-01-01 city: Berkeley country: USA created_time: 2023-03-16T20:26:28Z email: jane.doe@company.com first_name: Jane gender: F identifications: - type: DRIVERS_LICENSE value: '12345' last_modified_time: 2023-03-16T20:26:29Z last_name: Doe metadata: { } password: P@ssw0rd phone: '15105551212' postal_code: '94702' state: CA status: ACTIVE token: my_user_01 uses_parent_account: false end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/UserCardHolderListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Search users tags: - Users /users/phonenumber/{phone_number}: get: operationId: getUsersPhonenumberPhonenumber parameters: - description: Phone number explode: false in: path name: phone_number required: true schema: type: string style: simple - description: Number of users to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserCardHolderListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Lists all users who match a phone number tags: - users /users/{parent_token}/children: get: description: |- To retrieve users who are children of a parent user or business, send a `GET` request to the `/users/{parent_token}/children` endpoint. Include the parent's user or business token as a URL path parameter. The `business_token` field is conditionally returned in the response (it cannot be set through the API). You can use this field in conjunction with the `parent_token` field to determine whether the user has a parent or grandparent that is a business: [cols="1,1,1"] |=== | parent_token | business_token | Description | Not populated | Not populated | User does not have a parent. | Populated | Not populated | User's parent is a user. | Populated; matches `business_token` | Populated; matches `parent_token` | User's parent is a business. | Populated; does not match `business_token` | Populated; does not match `parent_token` | User's parent is a user and their grandparent is a business. |=== This endpoint supports <>. operationId: getUsersParenttokenChildren parameters: - description: Number of user resources to retrieve. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Unique identifier of the parent account holder. explode: false in: path name: parent_token required: true schema: type: string style: simple - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 1 data: - account_holder_group_token: DEFAULT_AHG active: true address1: 123 Main Street city: Oakland country: USA created_time: 2022-08-16T19:46:58Z email: john_smith@company.com first_name: John gender: M identifications: - birth_date: 1986-04-01 type: SSN value: '7777' last_modified_time: 2022-08-16T19:46:58Z last_name: Smith metadata: { } parent_token: my_user_01 password: P@55word phone: '15101111111' postal_code: '94601' state: CA status: ACTIVE token: child_of_parent uses_parent_account: true end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/UserCardHolderListResponse' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: List user child accounts tags: - Users /users/{token}: get: description: |- To retrieve a specific user, send a `GET` request to the `/users/{token}` endpoint. Include the user `token` path parameter to specify the user to return. The `business_token` field is conditionally returned in the response (it cannot be set through the API). You can use this field in conjunction with the `parent_token` field to determine whether the user has a parent or grandparent that is a business: [cols="1,1,1"] |=== | parent_token | business_token | Description | Not populated | Not populated | User does not have a parent. | Populated | Not populated | User's parent is a user. | Populated; matches `business_token` | Populated; matches `parent_token` | User's parent is a business. | Populated; does not match `business_token` | Populated; does not match `parent_token` | User's parent is a user and their grandparent is a business. |=== This endpoint supports <>. operationId: getUsersToken parameters: - description: Unique identifier of the user resource. explode: false in: path name: token required: true schema: type: string style: simple - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: example: account_holder_group_token: DEFAULT_AHG active: true address1: 1234 Grove Street birth_date: 1991-01-01 birth_place: US city: Berkeley country: USA created_time: 2022-08-16T19:39:34Z email: jane.doe@company.com first_name: Jane gender: F identifications: - type: SSN value: '5555' last_modified_time: 2022-08-16T19:39:34Z last_name: Doe metadata: authentication_answer1: Cashier authentication_answer2: Trabant authentication_answer3: Blue authentication_question1: What was your first job? authentication_question2: What make was your first car? authentication_question3: What is your favorite color? notification_email: jane.doe@home.com notification_language: spa password: P@ssw0rd phone: '15105551212' postal_code: '94702' state: CA status: ACTIVE title: Chief Comptroller token: my_user_01 uses_parent_account: false schema: $ref: '#/components/schemas/user_card_holder_response' description: Success '400': content: { } description: Bad request '404': content: { } description: Cardholder not found '500': content: { } description: Server error summary: Retrieve user tags: - Users put: description: |- To update a specific user resource, send a `PUT` request to the `/users/{token}` endpoint. Include the user `token` path parameter to specify the user to update. To unlink a child user account from a parent account, pass a null value to the `parent_token` field of the child user resource. operationId: putUsersToken parameters: - description: Unique identifier of the user resource you want to update. explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: example: address1: 4321 Grove Street schema: $ref: '#/components/schemas/UserCardHolderUpdateModel' description: User object required: true responses: '200': content: application/json: example: account_holder_group_token: DEFAULT_AHG active: true address1: 4321 Grove Street corporate_card_holder: false created_time: 2023-01-29T00:12:20Z last_modified_time: 2023-09-23T21:41:24Z metadata: { } status: ACTIVE token: my_user_01 uses_parent_account: false schema: $ref: '#/components/schemas/card_holder_model' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Update user tags: - Users /users/{token}/notes: get: operationId: getUsersTokenNotes parameters: - description: User token explode: false in: path name: token required: true schema: type: string style: simple - description: Start index explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: Number of notes to retrieve explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Created by explode: true in: query name: created_by required: false schema: type: string style: form - description: Comma-delimited list of created by user roles explode: true in: query name: created_by_user_role required: false schema: type: string style: form - description: Include private notes and private fields in note response explode: true in: query name: include_private required: false schema: type: boolean style: form - description: Search type explode: true in: query name: search_type required: false schema: type: string style: form - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: Sort order explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/CardHolderNoteListResponse' description: Success '400': content: { } description: Bad request '401': content: { } description: Unauthorized '403': content: { } description: Forbidden '404': content: { } description: Cardholder not found '500': content: { } description: Server error summary: Lists cardholder notes tags: - users post: operationId: postUsersTokenNotes parameters: - description: User token explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/cardholder_note_request_model' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/cardholder_note_response_model' description: Success '400': content: { } description: Bad request '401': content: { } description: Unauthorized '403': content: { } description: Forbidden '500': content: { } description: Server error summary: Creates a note for the cardholder tags: - users /users/{token}/notes/{notes_token}: put: operationId: putUsersTokenNotesNotestoken parameters: - description: User token explode: false in: path name: token required: true schema: type: string style: simple - description: Notes token explode: false in: path name: notes_token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/cardholder_note_update_request_model' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/cardholder_note_response_model' description: Success '400': content: { } description: Bad request '401': content: { } description: Unauthorized '403': content: { } description: Forbidden '500': content: { } description: Server error summary: Updates a specific note for a cardholder tags: - users /users/{token}/ssn: get: description: |- To retrieve the government-issued identification number for a user, send a `GET` request to the `/users/{token}/ssn` endpoint. Include the `token` path parameter to specify the user whose identification number (SSN, ITIN, TIN, NIN, SIN) you wish to return. You can indicate whether to return the full number or the last four digits only. operationId: getUsersTokenSsn parameters: - description: Unique identifier of the user resource. explode: false in: path name: token required: true schema: type: string style: simple - description: |- To return the full identification number, set to `true`. To return only the last four digits, set to `false`. If the identifications array contains only the last four digits of the identification number, the `/users/{token}/ssn` endpoint will return only the last four digits, regardless of the `full_ssn` parameter. explode: true in: query name: full_ssn required: false schema: type: boolean style: form responses: '200': content: application/json: example: ssn: '5555' schema: $ref: '#/components/schemas/ssn_response_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Retrieve user identification number tags: - Users /usertransitions: post: description: |- This endpoint enables you to change a user's status, depending on your role and the previous status change. By changing a user's status, you can control the user's capabilities and the setting of the `user.active` field. Do not set the value of the `user.active` field directly. [cols="2a,4a,3a"] |=== | The user.status Field | Description | User Limitations | `UNVERIFIED` | Initial status of a new user belonging to an account holder group where KYC is always required. *Allowable Transitions:* + `ACTIVE`, `CLOSED`, `TERMINATED` | Cannot activate cards or load funds. *user.active Field:* + `false` | `LIMITED` | Initial status of a new user belonging to an account holder group where KYC is conditionally required. *Allowable Transitions:* + `ACTIVE`, `SUSPENDED`, `CLOSED` | Restricted by rules in `accountholdergroups.pre_kyc_controls`. *user.active Field:* + `true` | `ACTIVE` | Status of a user who has passed KYC, or initial status of a new user belonging to an account holder group where KYC is never required. *Allowable Transitions:* + `SUSPENDED`, `CLOSED`, `UNVERIFIED` | None. *user.active Field:* + `true` | `SUSPENDED` | The user is temporarily inactive. Transitioning a suspended user to the `ACTIVE` status is restricted, based on your role and the details of the previous status change. *Allowable Transitions:* + `ACTIVE`, `LIMITED`, `UNVERIFIED`, `CLOSED`, `TERMINATED` | Cannot activate cards, load funds, or transact. *user.active Field:* + `false` | `CLOSED` | The user is permanently inactive. In general, the `CLOSED` status should be terminal. For exceptional cases, you can transition a user to other statuses, depending on your role and the details of the previous status change. Contact your Marqeta representative for more information. *Allowable Transitions:* + `ACTIVE`, `LIMITED`, `UNVERIFIED`, `SUSPENDED`, `TERMINATED` | Cannot activate cards, load funds, or transact. *user.active Field:* + `false` | `TERMINATED` | The user account is permanently closed. Use the `TERMINATED` state to comply with regulatory requirements, such as the requirement that a user account be irreversibly closed when it does not pass Know Your Customer (KYC) verification. *NOTE:* `TERMINATED` is a terminal status. You must have the Admin or Program Manager role to transition a user to the `TERMINATED` state. You cannot transition a user from `TERMINATED` to any other state. Contact your Marqeta representative for more information. *Allowable Transitions:* + None | Cannot load funds, activate cards, or transact. *The user.active field:* + `false` |=== [NOTE] The Marqeta platform transitions a user's status in response to certain events. For example, a user in the `UNVERIFIED` status is transitioned to `ACTIVE` when the user passes KYC verification. operationId: postUsertransitions requestBody: content: application/json: example: channel: API reason: Activating user reason_code: '00' status: ACTIVE token: activate_05 user_token: my_user_01 schema: $ref: '#/components/schemas/UserTransitionRequest' required: false responses: '201': content: application/json: example: channel: API created_time: 2025-03-15T00:00:00Z metadata: my_name_1: my_value_1 my_name_2: my_value_2 reason: Activating user reason_code: '00' status: ACTIVE token: activate_05 user_token: my_user_01 schema: $ref: '#/components/schemas/UserTransitionResponse' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Request already processed with a different payload '412': content: { } description: Pre-condition setup issue '500': content: { } description: Server error summary: Create user transition tags: - User Transitions /usertransitions/user/{user_token}: get: description: List all transitions for a given user. operationId: getUsertransitionsUserUsertoken parameters: - description: Unique identifier of the user resource. explode: false in: path name: user_token required: true schema: type: string style: simple - description: Number of user transitions to retrieve. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -id type: string style: form responses: '200': content: application/json: example: count: 1 data: - channel: API created_time: 2025-03-15T00:00:00Z metadata: my_name_1: my_value_1 my_name_2: my_value_2 reason: Activating user reason_code: '00' status: ACTIVE token: activate_05 user_token: my_user_01 end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/UserTransitionListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List transitions for user tags: - User Transitions /usertransitions/{token}: get: description: Retrieve a user transition. operationId: getUsertransitionsToken parameters: - description: Unique identifier of the user transition you want to retrieve. explode: false in: path name: token required: true schema: type: string style: simple - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: example: channel: API created_time: 2025-03-15T00:00:00Z metadata: my_name_1: my_value_1 my_name_2: my_value_2 reason: Activating user reason_code: '00' status: ACTIVE token: activate_05 user_token: my_user_01 schema: $ref: '#/components/schemas/UserTransitionResponse' description: Success '400': content: { } description: Bad request '404': content: { } description: Cardholder not found '500': content: { } description: Server error summary: Retrieve user transition tags: - User Transitions /velocitycontrols: get: description: |- Retrieves a list of all the velocity controls associated with a specific user or card product, or lists all the velocity controls defined for your program. Include either a `user` or a `card_product` query parameter to indicate the user or card product whose associated velocity controls you want to retrieve (do not include both). To list all velocity controls for your program, omit the `user` and `card_product` query parameters from your request. This endpoint supports <> and <>. operationId: getVelocitycontrols parameters: - description: |- Unique identifier of the card product. Enter the string `null` to retrieve velocity controls that are not associated with any card product. explode: true in: query name: card_product required: false schema: type: string style: form - description: |- Unique identifier of the user. Enter the string `null` to retrieve velocity controls that are not associated with any user. explode: true in: query name: user required: false schema: type: string style: form - description: Number of velocity control resources to retrieve. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 1 data: - active: true amount_limit: 500.25 approvals_only: true association: user_token: my_user_04 currency_code: USD include_cashback: true include_credits: false include_purchases: true include_transfers: true include_withdrawals: true merchant_scope: { } token: my_velocitycontrol_01 usage_limit: 10 velocity_window: DAY end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/VelocityControlListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List velocity controls tags: - Velocity Controls post: description: |- Limits how much and how frequently a user can spend funds. If multiple velocity controls apply to the same user, the user cannot exceed any of the defined spending limits. [TIP] You can create program-level controls in the sandbox environment. However, you must work with your Marqeta representative to create program-level controls in a production environment. operationId: postVelocitycontrols requestBody: content: application/json: example: amount_limit: 500.25 association: user_token: my_user_04 currency_code: USD token: my_velocitycontrol_01 usage_limit: 10 velocity_window: DAY schema: $ref: '#/components/schemas/velocity_control_request' description: Velocity control object required: true responses: '201': content: application/json: example: active: true amount_limit: 500.25 approvals_only: true association: user_token: my_user_04 currency_code: USD include_cashback: true include_credits: false include_purchases: true include_transfers: true include_withdrawals: true merchant_scope: { } token: my_velocitycontrol_01 usage_limit: 10 velocity_window: DAY schema: $ref: '#/components/schemas/velocity_control_response' description: Created '400': content: { } description: Bad request '409': content: { } description: Token already associated with a different payload '500': content: { } description: Server error summary: Create velocity control tags: - Velocity Controls /velocitycontrols/account/{account_token}/available: get: operationId: getVelocitycontrolsAccountAccountTokenAvailable parameters: - description: Account token explode: false in: path name: account_token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/VelocityControlBalanceListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Retrieve velocity control available balances for an account token tags: - velocity controls /velocitycontrols/cardgroup/{card_group_token}/available: get: description: Get a list of all Velocity Controls Card Group Balances in the program operationId: listVelocityControlsCardGroupBalances parameters: - description: Unique identifier of the card group for which to retrieve balances. explode: false in: path name: card_group_token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/VelocityControlBalancePage' description: Expected response to a valid request. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: List Velocity Controls Card Group Balances tags: - Velocity Controls Card Group Balance /velocitycontrols/user/{user_token}/available: get: description: |- Retrieves a list of the available balances of the velocity controls associated with a user. This operation is unavailable for velocity controls with a window of `TRANSACTION`, because available balances do not apply to single-transaction velocity windows. Depending on the control, the balance can include an available monetary amount, the number of transactions remaining, and the number of days remaining in the time window. This endpoint supports <> and <>. operationId: getVelocitycontrolsUserUsertokenAvailable parameters: - description: Unique identifier of the cardholder. explode: false in: path name: user_token required: true schema: type: string style: simple - description: Number of available balance resources to retrieve. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: The sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 2 data: - active: true amount_limit: 296.25 approvals_only: true association: { } available: amount: 296.0 days_remaining: 1 uses: 1 currency_code: USD include_cashback: true include_credits: false include_purchases: true include_transfers: true include_withdrawals: true merchant_scope: mcc: '3058' name: Jane Doe token: card_3 usage_limit: 1 velocity_window: DAY - active: true amount_limit: 500.25 approvals_only: true association: { } available: amount: 500.5 days_remaining: 1 uses: 1000 currency_code: '840' include_cashback: true include_credits: false include_purchases: true include_transfers: true include_withdrawals: true merchant_scope: mcc: '1234' token: card_4 usage_limit: 1000 velocity_window: DAY end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/VelocityControlBalanceListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List user velocity control balances tags: - Velocity Controls /velocitycontrols/{token}: delete: operationId: deleteVelocitycontrolsToken parameters: - description: Velocity control token explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/velocity_control_response' description: Success '404': content: { } description: Velocity control not found '500': content: { } description: Server error summary: Sets a specific velocity control to inactive to soft delete it tags: - velocity controls get: description: Retrieves a specific velocity control. operationId: getVelocitycontrolsToken parameters: - description: Unique identifier of the velocity control resource. explode: false in: path name: token required: true schema: type: string style: simple - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: example: active: true amount_limit: 500.25 approvals_only: true association: user_token: my_user_04 currency_code: USD include_cashback: true include_credits: false include_purchases: true include_transfers: true include_withdrawals: true merchant_scope: { } token: my_velocitycontrol_01 usage_limit: 10 velocity_window: DAY schema: $ref: '#/components/schemas/velocity_control_response' description: Success '400': content: { } description: Bad request '404': content: { } description: Velocity control not found '500': content: { } description: Server error summary: Returns a specific velocity control tags: - Velocity Controls put: description: Updates a specific velocity control. operationId: putVelocitycontrolsToken parameters: - description: Unique identifier of the velocity control resource. explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: example: amount_limit: 1000.25 token: my_velocitycontrol_01 usage_limit: 20 schema: $ref: '#/components/schemas/velocity_control_update_request' description: Velocity control object required: true responses: '200': content: application/json: example: active: true amount_limit: 1000.25 approvals_only: true association: user_token: my_user_04 currency_code: USD include_cashback: true include_credits: false include_purchases: true include_transfers: true include_withdrawals: true merchant_scope: { } token: my_velocitycontrol_01 usage_limit: 20 velocity_window: DAY schema: $ref: '#/components/schemas/velocity_control_response' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Update velocity control tags: - Velocity Controls /webhooks: get: description: "Returns an array of all webhooks.\n\nThis endpoint supports <>, <>, and <>.\n\n[NOTE]\nAs shown in the example, `config.secret`, `config.basic_auth_username`,\ \ and `config.basic_auth_password` are masked in responses to this and all\ \ other requests. \nTo ensure you can access these values as needed, update\ \ them on your endpoint, store them securely, and then <>." operationId: getWebhooks parameters: - description: Set to `true` to return only active webhook configurations, otherwise all webhook configurations will be returned. explode: true in: query name: active required: false schema: default: false type: boolean style: form - description: Number of resources to retrieve. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Sort order index of the first resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: |- Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. explode: true in: query name: fields required: false schema: type: string style: form - description: |- Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. explode: true in: query name: sort_by required: false schema: default: -createdTime type: string style: form responses: '200': content: application/json: example: count: 1 data: - active: true config: basic_auth_password: m**********d basic_auth_username: m**********e custom_header: my_header_name_1: my_value_1 my_header_name_2: my_value_2 my_header_name_3: my_value_3 secret: m**********t signature_algorithm: HMAC_SHA_256 url: https://my_secure_domain.com/webhook created_time: 2023-02-24T23:20:28Z events: - '*' last_modified_time: 2023-02-24T23:20:28Z name: my_webhook_name token: my_webhook_token end_index: 0 is_more: true start_index: 0 schema: $ref: '#/components/schemas/WebhookResponseModelListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List webhooks tags: - Webhooks post: description: "Creates a webhook.\n\n[NOTE]\nAs shown in the example, `config.secret`,\ \ `config.basic_auth_username`, and `config.basic_auth_password` are masked\ \ in responses to this and all other requests. \nTo access these values later,\ \ store them securely before making the request." operationId: postWebhooks requestBody: content: application/json: example: active: true config: basic_auth_password: my_20-to-50-character_password basic_auth_username: my_username custom_header: my_header_name_1: my_value_1 my_header_name_2: my_value_2 secret: my_20-character-min_secret signature_algorithm: HMAC_SHA_256 url: https://my_secure_domain.com/webhook events: - '*' name: my_webhook_name token: my_webhook_token schema: $ref: '#/components/schemas/webhook_request_model' required: false responses: '201': content: application/json: example: active: true config: basic_auth_password: m**********d basic_auth_username: m**********e custom_header: my_header_name_1: my_value_1 my_header_name_2: my_value_2 secret: m**********t signature_algorithm: HMAC_SHA_256 url: https://my_secure_domain.com/webhook created_time: 2023-02-24T23:20:28Z events: - '*' last_modified_time: 2023-02-24T23:20:28Z name: my_webhook_name token: my_webhook_token schema: $ref: '#/components/schemas/webhook_response_model' description: Success '400': content: { } description: User input error/Bad request '409': content: { } description: Request already processed with a different payload '500': content: { } description: Server error summary: Create webhook tags: - Webhooks /webhooks/customheaders/{token}: put: description: Adds or updates a webhook's custom HTTP headers. operationId: putWebhooksCustomHeadersToken parameters: - description: Unique identifier of the webhook. explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: example: custom_header: my_header_name_1: my_value_1 my_header_name_2: my_value_2 my_header_name_3: my_value_3 schema: $ref: '#/components/schemas/WebhookUpdateCustomHeaderRequest' required: false responses: '200': content: application/json: example: active: true config: basic_auth_password: m**********d basic_auth_username: m**********e custom_header: my_header_name_1: my_value_1 my_header_name_2: my_value_2 my_header_name_3: my_value_3 secret: m**********t signature_algorithm: HMAC_SHA_256 url: https://my_secure_domain.com/webhook created_time: 2023-02-06T08:12:32Z events: - transaction.* last_modified_time: 2023-02-26T22:07:23Z name: my_webhook_name token: my_webhook_01 schema: $ref: '#/components/schemas/webhook_response_model' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Resource not found '500': content: { } description: Server error summary: Update webhook custom headers tags: - Webhooks /webhooks/{event_type}/{resource_token}: post: description: |- Resends a credit event notification to your webhook endpoint. Although you send this request as a `POST`, all parameters are passed in the URL and the body is empty. The event notification is resent to your webhook endpoint and also returned in the response to this request. For details on how to configure your webhook endpoint, see the About Webhooks <>. For the complete `/webhooks` endpoint reference, see <>. operationId: resendWebhookEvent parameters: - description: Specifies the type of event you want to resend. explode: false in: path name: event_type required: true schema: enum: - ledgerentry - journalentry - accounttransition - accountstatement - paymenttransition - delinquencytransition - paymentreminders - substatus - accountsignupbonus type: string style: simple - description: |- Unique identifier of the resource for which you want to resend a notification. * Send a `GET` request to `/credit/accounts/{account_token}/journalentries` to retrieve existing journal entry tokens. * Send a `GET` request to `/credit/accounts/{account_token}/ledgerentries` to retrieve existing ledger entry tokens. * Send a `GET` request to `/accounts/{account_token}/accounttransitions` to retrieve existing account transition tokens. * Send a `GET` request to `/credit/accounts/{account_token}/payments/{payment_token}` to retrieve existing payment transition tokens. * Send a `GET` request to `/accounts/{account_token}/statements` to retrieve existing statement summary tokens. * Send a `GET` request to `/accounts/{account_token}/delinquencystate/transitions` to retrieve existing delinquency state transition tokens. * Send a `GET` request to `/accounts/{account_token}/statements/{statement_summary_token}/paymentreminders/{token}` to retrieve existing payment reminder tokens. * Send a `GET` request to `/credit/substatuses` to retrieve existing substatus tokens. * Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens and identify the specific account for the resend event. explode: false in: path name: resource_token required: true schema: type: string x-allowableValues: Existing journal entry token, ledger entry token, account transition token, payment transition token, statement summary token, delinquency transition token, or substatus token style: simple responses: '200': content: application/json: examples: account_statement_sample: summary: The following code block shows a sample of a resent `creditaccountstatements` event. value: account_token: my_credit_account_token available_credit: 0 closing_balance: 506.41 closing_date: 2025-04-01T03:59:59.999Z created_time: 2023-08-18T22:04:31.261Z credit_limit: 500 credits: 0 cycle_type: REVOLVING days_in_billing_cycle: 31 fees: 15 interest: 4.96 opening_balance: 496.45 opening_date: 2025-03-01T05:00:00.000Z past_due_amount: 10 payments: 10 purchases: 0 token: my_credit_account_statement_token account_transition_sample: summary: The following code block shows a sample of a resent `creditaccounttransitions` event. value: account_token: my_credit_account_token1234 created_time: 2024-08-18T20:25:10.408Z original_status: UNACTIVATED status: ACTIVE token: my_credit_account_transition_token1234 accountsignupbonus_example: summary: The following code block shows a sample of a resent `accountsignupbonus` event. value: account_token: my_account_token accrual_start_time: 2024-04-02T11:23:23Z journal_entry_token: my_journal_entry_token maturity_time: 2024-04-02T11:23:23Z reward_token: my_reward_token spend_total: 10 status: ISSUED token: my_accountsignupbonus_token type: STATEMENT_CREDIT delinquency_transition_example: summary: The following code block shows a sample of a resent `creditdelinquencytransitions` event. value: account_token: my_credit_account_token1234 bucket_count: 2 created_time: 2024-03-01 04:59:59.999 current_due: 40 impact_time: 2024-03-01 04:59:59.999 is_rolled_back: false oldest_payment_due_date: 2023-02-01 04:59:59.999 original_status: CURRENT status: DELINQUENT token: my_delinquency_transition_token1234 total_due: 140 total_past_due: 100 transition_trigger_reason: STATEMENT_GENERATION transition_trigger_time: 2024-03-01 04:59:59.999 updated_time: 2024-03-01 04:59:59.999 journal_entry_example: summary: The following code block shows a sample of a resent `creditjournalentries` event. value: account_token: my_credit_account_token1234 amount: 10 card_token: my_credit_card_token1234 created_time: 2024-08-18T22:07:21.422Z currency_code: USD detail_object: acquirer: system_trace_audit_number: '376582' acquirer_fee_amount: 0 acting_user_token: my_user_token amount: 10 approval_code: '974406' card: last_four: '9949' metadata: { } card_acceptor: city: San Francisco country_code: USA mcc: '6411' mid: '1234' name: Jane's Bakery postal_code: '94115' state: CA street_address: 1989 Fillmore St card_token: my_credit_card_token1234 created_time: 2024-08-18T22:06:52Z currency_code: USD duration: 837 gpa: available_balance: 0 balances: USD: available_balance: 0 credit_balance: 0 currency_code: USD impacted_amount: -10 ledger_balance: 510.87 pending_credits: 0 credit_balance: 0 currency_code: USD impacted_amount: -10 ledger_balance: 510.87 pending_credits: 0 gpa_order: amount: 10 created_time: 2024-08-18T22:06:53Z currency_code: USD funding: amount: 10 gateway_log: duration: 485 message: Approved or completed successfully order_number: my_gateway_token12345 response: code: '200' data: jit_funding: acting_user_token: my_user_token amount: 10 method: pgfs.authorization token: my_jit_funding_token1234 user_token: my_user_token timed_out: false transaction_id: my_transaction_id1234 source: active: true created_time: 2024-10-14T17:26:35Z is_default_account: false last_modified_time: 2024-10-14T17:26:35Z name: credit_backed_funding_source token: '**********1ab2' type: programgateway funding_source_token: '**********1ab2' jit_funding: acting_user_token: my_user_token amount: 10 method: pgfs.authorization token: my_transaction_id1234 user_token: my_user_token last_modified_time: 2024-08-18T22:06:53Z response: code: '0000' memo: Approved or completed successfully state: PENDING token: my_gpa_order_token1234 transaction_token: my_transaction_token1234 user_token: my_user_token identifier: '234' issuer_payment_node: f8205a67b12b90d695b15704a64c074b issuer_received_time: 2024-08-18T22:06:52.771Z network: DISCOVER network_reference_id: '484311571095' pos: is_installment: false is_recurring: false partial_approval_capable: true pin_present: false purchase_amount_only: false request_amount: 10 response: code: '0000' memo: Approved or completed successfully settlement_date: 2024-08-18T00:00:00Z state: PENDING token: my_detail_token1234 type: authorization user: metadata: key1: value1 key2: value2 notification_email: user@domain.com notification_language: spa user_token: my_user_token user_transaction_time: 2024-08-18T22:06:52Z detail_token: my_detail_token1234 dispute_token: null group: PURCHASE id: '12345678' impact_time: 2024-08-18T22:07:21.422Z memo: Jane's Bakery related_token: null request_time: 2024-08-18T22:06:52.000Z root_token: null status: PENDING token: my_journal_entry_token1234 type: authorization ledger_entry_sample: summary: The following code block shows a sample of a resent `creditledgerentries` event. value: account_token: my_credit_account_token1234 amount: 10 card_token: my_credit_card_token1234 created_time: 2024-08-18T22:07:21.422Z currency_code: USD detail_object: acquirer: system_trace_audit_number: '376582' acquirer_fee_amount: 0 acting_user_token: my_user_token amount: 10 approval_code: '974406' card: last_four: '9949' metadata: { } card_acceptor: city: San Francisco country_code: USA mcc: '6411' mid: '1234' name: Jane's Bakery postal_code: '94115' state: CA street_address: 1989 Fillmore St card_token: my_credit_card_token1234 created_time: 2024-08-18T22:06:52Z currency_code: USD duration: 837 gpa: available_balance: 0 balances: USD: available_balance: 0 credit_balance: 0 currency_code: USD impacted_amount: -10 ledger_balance: 510.87 pending_credits: 0 credit_balance: 0 currency_code: USD impacted_amount: -10 ledger_balance: 510.87 pending_credits: 0 gpa_order: amount: 10 created_time: 2024-08-18T22:06:53Z currency_code: USD funding: amount: 10 gateway_log: duration: 485 message: Approved or completed successfully order_number: my_gateway_token12345 response: code: '200' data: jit_funding: acting_user_token: my_user_token amount: 10 method: pgfs.authorization token: my_jit_funding_token1234 user_token: my_user_token timed_out: false transaction_id: my_transaction_id1234 source: active: true created_time: 2024-10-14T17:26:35Z is_default_account: false last_modified_time: 2024-10-14T17:26:35Z name: credit_backed_funding_source token: '**********1ab2' type: programgateway funding_source_token: '**********1ab2' jit_funding: acting_user_token: my_user_token amount: 10 method: pgfs.authorization token: my_transaction_id1234 user_token: my_user_token last_modified_time: 2024-08-18T22:06:53Z response: code: '0000' memo: Approved or completed successfully state: PENDING token: my_gpa_order_token1234 transaction_token: my_transaction_token1234 user_token: my_user_token identifier: '234' issuer_payment_node: f8205a67b12b90d695b15704a64c074b issuer_received_time: 2024-08-18T22:06:52.771Z network: DISCOVER network_reference_id: '484311571095' pos: is_installment: false is_recurring: false partial_approval_capable: true pin_present: false purchase_amount_only: false request_amount: 10 response: code: '0000' memo: Approved or completed successfully settlement_date: 2024-08-18T00:00:00Z state: PENDING token: my_detail_token1234 type: authorization user: metadata: key1: value1 key2: value2 notification_email: user@domain.com notification_language: spa user_token: my_user_token user_transaction_time: 2024-08-18T22:06:52Z detail_token: my_detail_token1234 dispute_token: null group: PURCHASE id: '12345678' impact_time: 2024-08-18T22:07:21.422Z memo: Jane's Bakery related_token: null request_time: 2024-08-18T22:06:52.000Z root_token: null status: PENDING token: my_ledger_entry_token1234 type: authorization payment_transition_example: summary: The following code block shows a sample of a resent `creditpaymenttransitions` event. value: account_token: my_credit_account_token1234 created_time: 2024-08-17T18:26:47.591Z payment_token: my_credit_account_payment_token1234 refund_details: null status: COMPLETED token: my_payment_transition_token1234 substatus_example: summary: The following code block shows a sample of a resent `substatus` event. value: attributes: [ ] created_time: 2024-04-02T11:23:23Z events: - channel: SYSTEM created_time: 2024-04-02T11:23:23Z effective_date: 2024-04-02T11:23:23Z reason: Fraud system detected suspicious activity state: ACTIVE - channel: ADMIN created_time: 2024-04-02T11:23:23Z effective_date: 2024-04-02T11:23:23Z reason: Verified non-fraud with cardholder state: INACTIVE is_active: false resource_token: my_account_token resource_type: ACCOUNT state: INACTIVE substatus: FRAUD token: substatus_token updated_time: 2024-04-02T11:23:23Z schema: $ref: '#/components/schemas/WebhookEventResendContainerResponse' description: Event response for which the webhook event was resent default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error security: - zionToken: [ ] summary: Resend credit event notification tags: - Account Transitions - Journal Entries - Ledger Entries - Payments - Statements - Delinquency - Credit Substatuses - Account Signup Bonus /webhooks/{token}: get: description: "Retrieves a webhook.\n\n[NOTE]\nAs shown in the example, `config.secret`,\ \ `config.basic_auth_username`, and `config.basic_auth_password` are masked\ \ in responses to this and all other requests. \nTo ensure you can access\ \ these values as needed, update them on your endpoint, store them securely,\ \ and then <>." operationId: getWebhooksToken parameters: - description: Unique identifier of the webhook. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/webhook_response_model' description: Success '404': content: { } description: Resource not found '500': content: { } description: Server error summary: Retrieve webhook tags: - Webhooks put: description: "Updates a webhook.\n\nYou can also use this endpoint to disable\ \ webhooks you no longer want to receive—there is no `DELETE` method available\ \ to remove unneeded webhooks.\nTo disable a webhook, use this endpoint to\ \ set its `active` field to `false`.\n\n[NOTE]\nAs shown in the example, `config.secret`,\ \ `config.basic_auth_username`, and `config.basic_auth_password` are masked\ \ in responses to this and all other requests. \nTo access these values later,\ \ store them securely before making the request. \nWhen modifying authentication\ \ credentials, update the endpoint configuration before updating your webhook\ \ subscription to avoid missing any important event notifications.\n\nFor\ \ instructions on managing your webhooks via the Developer Dashboard, see\ \ the <> guide." operationId: putWebhooksToken parameters: - description: Unique identifier of the webhook. explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/webhook_base_model' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/webhook_response_model' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Resource not found '500': content: { } description: Server error summary: Update webhook tags: - Webhooks /webhooks/{token}/ping: post: description: |- Pings your webhook endpoint. Send a ping request to your webhook endpoint to validate credentials and connectivity. Your webhook endpoint must be configured to respond. === Configuring your webhook endpoint When the Marqeta platform receives the ping request, it sends a `POST` request containing the following body to the URL of your webhook endpoint: [#ping-webhook-sample] [source,json] ---- { "pings": [ { "token": "marqeta", "payload": "healthcheck" } ] } ---- To indicate that it is functioning properly, your webhook endpoint must respond with a status code of `200` (see <> for a code example that identifies a ping request). The response can optionally include a link:http://www.json.org/[JSON, window="_blank"]-formatted body, for example: [#ping-webhook-sample-2] [source,json] ---- {"my_endpoint_status": "alive"} ---- The Marqeta platform then responds to its requestor by echoing, as-is, the response code and body received from your webhook endpoint. === Using the ping facility To ping a webhook endpoint, send a `POST` request to `/webhooks/{token}/ping` and use the `token` path parameter to specify which webhook you want to reach. Include an empty, link:http://www.json.org/[JSON, window="_blank"]-formatted body in the request, that is: [#ping-webhook-sample-3] [source,json] ---- {} ---- The following chain of actions occurs during the successful execution of a ping operation: . The Marqeta platform receives the ping request (`POST` to `/webhooks/{token}/ping`). . The Marqeta platform sends a request to your webhook endpoint. . Your webhook endpoint responds with a status code of "200" and an optional body. . The Marqeta platform responds to its requestor by echoing, as-is, the response code and body it received from your webhook endpoint. [NOTE] If the customer-hosted endpoint fails to respond within five seconds, the Marqeta platform times out the request and responds with the following message body (where `` represents additional details you can choose to include in the response): [#ping-webhook-sample-4] [source,json] ---- { "error_message": "Webhook operation failed " + , "error_code": "422600" } ---- Failed pings are not automatically retried. operationId: postWebhooksTokenPing parameters: - description: Unique identifier of the webhook. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: pings: - my_endpoint_status: alive schema: $ref: '#/components/schemas/webhook_ping_model' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Resource not found '500': content: { } description: Server error summary: Ping webhook tags: - Webhooks /webhooks/{token}/{event_type}/{event_token}: post: description: |- Resends an event notification to your webhook endpoint. Although you send this request as a `POST`, all parameters are passed in the URL and the body is empty. The event notification is resent to your webhook endpoint and is also returned in the response to this request. operationId: postWebhooksTokenEventtypeEventtoken parameters: - description: Unique identifier of the webhook. explode: false in: path name: token required: true schema: type: string style: simple - description: Specifies the type of event you want to resend. explode: false in: path name: event_type required: true schema: enum: - chargebacktransition - digitalwallettokentransition - cardtransition - usertransition - businesstransition - transaction - threedstransition type: string style: simple - description: Unique identifier of the event for which you want to resend a notification. explode: false in: path name: event_token required: true schema: type: string style: simple responses: '200': content: { } description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Resource not found '500': content: { } description: Server error summary: Resend event notification tags: - Webhooks components: parameters: { } schemas: ACHListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/base_ach_response_model' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object ATCInformationModel: properties: atc_discrepancy_indicator: type: string atc_discrepancy_value: type: number atc_value: type: number type: object AcceptedCountriesListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/accepted_countries_model' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object AccountAdjustmentPage: description: Returns paginated account adjustments. properties: count: description: Number of resources returned. type: integer data: description: Contains one or more account adjustments. items: $ref: '#/components/schemas/AccountAdjustmentResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object AccountAdjustmentReq: description: Contains information relevant to creating an account adjustment. properties: amount: description: |- Amount of the adjustment. Value must be negative if `original_ledger_entry_token` is not passed. maximum: 1000000 type: number currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the adjustment. maxLength: 255 minLength: 1 type: string external_adjustment_id: description: Unique identifier you provide of an associated external adjustment that exists outside Marqeta's credit platform. format: uuid type: string note: description: Additional information on the adjustment. maxLength: 255 type: string original_ledger_entry_token: description: |- Unique identifier of the original journal entry needing the adjustment. Required when adjusting an existing journal entry. format: uuid type: string reason: description: |- Reason for the adjustment. * `DISPUTE` - The adjustment occurred because a dispute was initiated. * `DISPUTE_RESOLUTION` - The adjustment occurred because of the result of a dispute resolution. * `RETURNED_OR_CANCELED_PAYMENT` - The adjustment occurred because a payment was returned or canceled. * `OTHER` - Any other reason the adjustment occurred. For example, a waived fee or account write-off. enum: - DISPUTE - DISPUTE_RESOLUTION - RETURNED_OR_CANCELED_PAYMENT - OTHER type: string source_account_type: description: The source account type. enum: - NETWORK - SPONSOR_BANK - MQ_RESERVE - PROGRAM_FUNDING type: string token: description: Unique identifier of the adjustment. maxLength: 36 type: string required: - amount - currency_code - description type: object AccountAdjustmentResponse: description: Contains information returned for account adjustment. properties: account_token: description: Unique identifier of the credit account on which the adjustment was made. maxLength: 36 type: string adjustment_detail_object: description: |- Contains the adjustment's full details. The fields returned in this object depend on the adjustment type. Interest returns interest details. For the specific fields returned, see the `detail_object` fields marked "Returned for interest journal entries" in the <>. Disputes return dispute details. For the specific fields returned, see the <>. nullable: true type: object amount: description: Amount of the adjustment. type: number created_time: description: Date and time when the account adjustment was applied, in UTC. format: date-time type: string currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the adjustment. minLength: 1 type: string detail_token: description: |- Unique identifier of the adjustment detail. For example, the token of the dispute, the interest charge, or the returned payment that prompted the adjustment. Returned when the system automatically applies an adjustment. maxLength: 36 nullable: true type: string external_adjustment_id: description: Unique identifier you provide of an associated external adjustment that exists outside Marqeta's credit platform. format: uuid nullable: true type: string note: description: Additional information on the adjustment. nullable: true type: string original_ledger_entry_token: description: Unique identifier of the original journal entry needing the adjustment. format: uuid type: string reason: description: |- Reason for the adjustment. * `DISPUTE` - The adjustment occurred because a dispute was initiated. * `DISPUTE_RESOLUTION` - The adjustment occurred because of the result of a dispute resolution. * `RETURNED_OR_CANCELED_PAYMENT` - The adjustment occurred because a payment was returned or canceled. * `OTHER` - Any other reason the adjustment occurred. For example, a waived fee. enum: - DISPUTE - DISPUTE_RESOLUTION - RETURNED_OR_CANCELED_PAYMENT - OTHER type: string related_detail_object: description: |- Contains full details of the related dispute or returned payment. The fields returned in this object depend on whether a dispute or returned payment led to the interest adjustment. A dispute returns dispute details; a returned payment returns payment details. For more on the dispute details returned, see the <>. For more on the returned payment details returned, see the <>. This field is returned for interest adjustments only. nullable: true type: object related_detail_token: description: |- Unique identifier of the dispute or returned payment that prompted the interest adjustment. This field is returned for interest adjustments only. maxLength: 36 nullable: true type: string source_account_type: description: The source account type. enum: - NETWORK - SPONSOR_BANK - MQ_RESERVE - PROGRAM_FUNDING type: string token: description: |- Unique identifier of the adjustment. If in the `detail_object`, unique identifier of the detail object. type: string type: description: |- Type of adjustment. The adjustment is made on its correlating amount (for example, purchase adjustments are made on purchase amounts). You can use general adjustments for standalone adjustments made on the credit account balance itself, which includes account write-offs, credits, and more. enum: - PURCHASE - FEE - REWARD - INTEREST - GENERAL type: string required: - account_token - amount - currency_code - description - reason - source_account_type - token - type type: object AccountAndDocumentAssetType: description: Type of document. enum: - TERMS_SCHEDULE - ACCOUNT_STATEMENT - SUMMARY_OF_CREDIT_TERMS - REWARDS_DISCLOSURE - PRIVACY_POLICY - E_DISCLOSURE - BENEFITS_DISCLOSURE - CARD_MEMBER_AGREEMENT type: string AccountAprType: description: |- Type of APR. * `GO_TO` - Default APR rate that is applicable when any promotional periods expire. * `PROMOTIONAL` - A temporary rate that is applicable for a specified period of time. enum: - GO_TO - PROMOTIONAL type: string AccountBillingCycleResponse: description: Details of a billing cycle. properties: account_token: description: Token of the associated account. type: string created_time: description: Date and time when the Billing Cycle was created on Marqeta's credit platform format: date-time type: string current_end_time: description: End time of the current billing cycle. format: date-time type: string current_payment_due_date: description: Payment due date for the current billing cycle. format: date-time type: string current_start_time: description: Start time of the current billing cycle. format: date-time type: string next_end_time: description: End time of the next billing cycle. format: date-time type: string next_payment_due_date: description: Payment due date for the next billing cycle. format: date-time type: string next_start_time: description: Start time of the next billing cycle. format: date-time type: string short_code: description: Unique identifier of the billing cycle's short code. type: string updated_time: description: Date and time when the BillingCycle was last updated on Marqeta's credit platform format: date-time type: string required: - account_token - created_time - current_end_time - current_payment_due_date - current_start_time - next_end_time - next_payment_due_date - next_start_time - short_code - updated_time type: object AccountCardsPage: description: Returns paginated account cards. properties: count: description: Number of resources returned. type: integer data: description: Contains one or more credit cards. items: $ref: '#/components/schemas/CardResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object AccountConfigMinPayment: description: Contains configurations for a minimum payment override on a credit account, which overrides the minimum payment configurations on the associated credit product. properties: active: description: Whether the minimum payment override is currently active. type: boolean min_payment_flat_amount: description: Flat amount of the minimum payment override. minimum: 0 type: number min_payment_percentage: description: Percentage of the total statement balance used to calculate the minimum payment override amount. minimum: 0 type: number override_end_time: description: Date and time when the minimum payment override ends, in UTC. format: date-time type: string override_start_time: description: Date and time when the minimum payment override starts, in UTC. format: date-time type: string type: object AccountConfigPaymentHolds: description: Contains configurations for a payment hold. properties: ach_hold_days: description: Number of days to hold an ACH payment. maximum: 30 minimum: 0 type: integer check_hold_days: description: Number of days to hold a check payment. maximum: 30 minimum: 0 type: integer type: object AccountConfigResponse: description: Contains information returned when configuring an account's billing cycle day, payment due day, fees, and more. properties: billing_cycle_day: description: |- Day of the month when the billing cycle starts. If an override value is not provided, the default value is derived from the bundle. maximum: 28 minimum: 1 type: integer card_level: default: NA description: Level of the credit card. enum: - PREMIUM - TRADITIONAL - NA type: string e_disclosure_active: default: false description: A value of `true` indicates that the account holder consents to receiving disclosures and statements electronically. type: boolean fees: description: Contains one or more fees associated with the credit account. items: $ref: '#/components/schemas/ConfigFeeScheduleResponse' type: array min_payment: $ref: '#/components/schemas/AccountConfigMinPayment' payment_due_day: deprecated: true description: Day of the month when the payment for the previous billing cycle is due. maximum: 31 minimum: 31 type: integer payment_due_interval: default: -1 description: |- Specifies the payment due interval that is used to determine the payment due date for a billing cycle. A value of -1 indicates one day prior to the next billing cycle date. minimum: -1 type: integer payment_holds: $ref: '#/components/schemas/AccountConfigPaymentHolds' rewards: description: Contains one or more rewards associated with the credit account. items: $ref: '#/components/schemas/AccountReward' type: array required: - billing_cycle_day - card_level - e_disclosure_active - payment_holds type: object AccountConfigUpdateReq: description: Contains information relevant for updating configurations for electronic disclosures, fees, payment holds, and minimum payment. properties: e_disclosure_active: default: false description: A value of `true` indicates that the account holder consents to receiving disclosures and statements electronically. type: boolean fees: description: Contains one or more fees associated with the credit account. items: $ref: '#/components/schemas/ConfigFeeScheduleReq' type: array min_payment: $ref: '#/components/schemas/AccountConfigMinPayment' payment_due_interval: description: |- Specifies the payment due interval that is used to determine the payment due date for a billing cycle. A value of -1 indicates one day prior to the next billing cycle date. For consumer programs, a minimum gap of 21 days is required between when a statement is delivered and the payment due date. minimum: -1 type: integer payment_holds: $ref: '#/components/schemas/AccountConfigPaymentHolds' type: object AccountCreditBalanceRefundReq: description: Contains details on a credit balance refund. properties: amount: description: |- Amount of the credit balance refund. The maximum refund amount is the amount that brings the account balance to $0. For example, $4000 is the maximum refund amount for a -$4000 account balance. minimum: 0.01 type: number currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description for the credit balance refund. type: string method: $ref: '#/components/schemas/RefundMethod' token: description: Unique identifier of the credit balance refund. type: string required: - amount - currency_code - description - method type: object AccountCreditBalanceRefundResponse: description: Contains details on a credit balance refund. properties: account_token: description: Unique identifier of the credit account that needs the credit balance refund. maxLength: 36 type: string amount: description: |- Amount of the credit balance refund. The maximum refund amount is the amount that brings the account balance to $0. For example, $4000 is the maximum refund amount for a -$4000 account balance. type: number created_time: description: Date and time when the credit balance refund was created. format: date-time type: string description: description: Description for the credit credit balance refund. type: string method: $ref: '#/components/schemas/RefundMethod' status: $ref: '#/components/schemas/PaymentStatus' token: description: |- Unique identifier of the credit balance refund. If in the `detail_object`, unique identifier of the detail object. type: string updated_time: description: Date and time when the credit balance refund was last updated. format: date-time type: string required: - account_token - amount - created_time - description - method - status - token - updated_time type: object AccountDocumentResponse: description: Account document response. properties: accepted_at: description: Date and time when the user accepted the document on Marqeta's credit platform, in UTC. format: date-time type: string asset_token: description: Unique identifier of the document on a credit account. type: string asset_urls: $ref: '#/components/schemas/PolicyDocumentAssetURLs' effective_from: description: Date and time when the document goes into effect on Marqeta's credit platform, in UTC. format: date-time type: string type: object AccountDocumentsPage: description: Account document response. properties: count: description: Number of resources returned. type: integer data: description: Array of documents on the credit account. items: $ref: '#/components/schemas/AccountDocumentResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object AccountDocumentsResponse: description: Account documents response. properties: account_statement: $ref: '#/components/schemas/AccountDocumentResponse' benefits_disclosure: $ref: '#/components/schemas/AccountDocumentResponse' card_member_agreement: $ref: '#/components/schemas/AccountDocumentResponse' e_disclosure: $ref: '#/components/schemas/AccountDocumentResponse' privacy_policy: $ref: '#/components/schemas/AccountDocumentResponse' rewards_disclosure: $ref: '#/components/schemas/AccountDocumentResponse' summary_of_credit_terms: $ref: '#/components/schemas/AccountDocumentResponse' terms_schedule: $ref: '#/components/schemas/AccountDocumentResponse' type: object AccountFee: description: Contains fee configurations on a credit account. properties: method: $ref: '#/components/schemas/Method' type: $ref: '#/components/schemas/FeeType' value: description: Value of the fee, either a flat fee amount or percentage value. maximum: 9999.99 minimum: 0 type: number required: - method - type type: object AccountFeePage: description: Returns paginated account fees. properties: count: description: Number of resources returned. type: integer data: description: Contains one or more account fees. items: $ref: '#/components/schemas/AccountFeeResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object AccountFeeReq: description: Contains information relevant to creating an account fee. properties: amount: description: |- Amount of the fee. Value must be positive. maximum: 1000000 type: number currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the fee. maxLength: 255 minLength: 1 type: string subtype: description: Subtype of the fee. Required if fee type is ACCOUNT_FEE that can have ACCOUNT_OPENING_FEE or UPGRADE_FEE subtypes. enum: - ACCOUNT_OPENING_FEE - UPGRADE_FEE - CASH_FEE type: string token: description: Unique identifier of the fee. maxLength: 36 type: string type: description: Type of the fee. enum: - ACCOUNT_FEE - RETURNED_PAYMENT_FEE type: string required: - amount - currency_code - type type: object AccountFeeResponse: description: Contains information returned for account fee. properties: account_token: description: Unique identifier of the credit account on which the fee was made. maxLength: 36 type: string amount: description: Amount of the fee. type: number applied_to_amount: description: The amount to which the fee was applied (applicable only for certain fees). nullable: true type: number channel: description: Indicates how the fee was created. enum: - API - SYSTEM type: string created_time: description: Date and time when the account fee was applied, in UTC. format: date-time type: string currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the fee. type: string journal_tokens: items: description: A list of associated journal tokens. type: string type: array method: description: The way fee is calculated. enum: - PERCENTAGE - FLAT type: string status: description: Status of the fee. enum: - PENDING - POSTED - REVERSED type: string subtype: description: Subtype of fee. enum: - ACCOUNT_OPENING_FEE - UPGRADE_FEE - CASH_FEE type: string token: description: Unique identifier of the fee. type: string type: description: Type of fee. enum: - ACCOUNT_FEE - RETURNED_PAYMENT_FEE - FOREIGN_TRANSACTION_FEE - OVER_LIMIT_FEE - LATE_PAYMENT_FEE - CARD_REPLACEMENT_FEE - MINIMUM_INTEREST_FEE - ANNUAL_FEE - MONTHLY_FEE - MINIMUM_INTEREST_FEE_REVERSAL type: string value: description: Value of the fee. type: number required: - account_token - amount - channel - currency_code - description - journal_tokens - method - status - subtype - token - type - value type: object AccountHolderGroupListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/account_holder_group_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object AccountProductFeeType: description: Type of fee. enum: - LATE_PAYMENT_FEE - RETURNED_PAYMENT_FEE - MONTHLY_FEE - ANNUAL_FEE - FOREIGN_TRANSACTION_FEE type: string AccountResponse: description: Contains information on a credit account. properties: activation_time: description: Date and time when the credit account was activated on Marqeta's credit platform, in UTC. format: date-time type: string available_credit: description: |- Amount of credit available for use on the credit account. Optional for light responses. type: number bundle_token: description: Unique identifier of the associated bundle product. type: string business_substatuses: description: Substatuses of the business under the credit account. items: description: Substatus of the business under the credit account. type: string type: array business_token: description: |- Unique identifier of the parent business program. Either a `user_token` or `business_token` is returned, not both. type: string config: $ref: '#/components/schemas/AccountConfigResponse' created_time: description: Date and time when the credit account was created on Marqeta's credit platform, in UTC. format: date-time type: string credit_limit: description: |- Maximum balance the credit account can carry. Optional for light responses. exclusiveMinimum: true maximum: 1000000 minimum: 0 type: number credit_product_token: description: Unique identifier of the associated credit product. type: string currency_code: $ref: '#/components/schemas/CurrencyCode' current_balance: description: |- Current purchase balance on the credit account. Optional for light responses. type: number description: description: Description for the credit account. type: string external_offer_id: description: Unique identifier you provide of the associated external credit offer. type: string latest_statement_cycle_type: $ref: '#/components/schemas/CycleType' max_apr_schedules: description: |- Contains `max_apr_schedule` objects, which provide information about any temporary overrides of the APRs on the credit account. This could include special APR rates due to `account/user` substatus changes. items: $ref: '#/components/schemas/MaxAPRSchedulesResponse' minItems: 0 type: array name: description: Name of the credit account. type: string remaining_min_payment_due: description: |- Amount remaining on the latest statement's minimum payment after it is adjusted for payments, returned payments, and applicable credits that occurred after the latest statement's closing date. Optional for light responses. type: number remaining_statement_balance: description: |- Amount remaining on the latest statement's balance after it is adjusted for payments, returned payments, and applicable credits that occurred after the latest statement's closing date. Optional for light responses. type: number secured_account_token: description: Unique identifier of the secured account. maxLength: 36 type: string status: $ref: '#/components/schemas/AccountStatusEnum' substatuses: description: Substatuses of the credit account. items: description: Substatus of the credit account. type: string type: array token: description: Unique identifier of the credit account. maxLength: 36 type: string type: $ref: '#/components/schemas/AccountType' updated_time: description: Date and time when the credit account was last updated on Marqeta's credit platform, in UTC. format: date-time type: string usages: description: |- Contains one or more `usages` objects that contain information on how a credit account is used and what types of balances are permitted on the account. Optional for light responses. items: $ref: '#/components/schemas/AccountUsageResponse' type: array user_substatuses: description: Substatuses of the users under the credit account. items: description: Substatus of the user under the credit account. type: string type: array user_token: description: |- Unique identifier of the primary account holder or an administrative user of a business account. Either a `user_token` or `business_token` is returned, not both. type: string required: - config - created_time - currency_code - status - token - type - updated_time type: object AccountReward: description: TODO Add description here properties: method: $ref: '#/components/schemas/Method' type: $ref: '#/components/schemas/RewardType' value: description: Value of the reward, either a flat reward amount or percentage value. maximum: 100 minimum: 0 type: number required: - method - type type: object AccountSignupBonusProgressResponse: properties: accrual_start_time: description: Date and time when the account started tracking spend accrued towards the signup bonus on Marqeta's credit platform, in UTC. format: date-time type: string maturity_time: description: Date and time when transactions must be posted by to be eligible towards signup bonus on Marqeta's credit platform, in UTC. format: date-time type: string retrieval_time: description: Date and time when the account signup bonus progress was retrieved from Marqeta's credit platform, in UTC. format: date-time type: string target_spend: description: Minimum spend required to earn the signup bonus on Marqeta's credit platform within the given timeframe. type: number total_spend: description: Total eligible spend accrued towards the signup bonus on Marqeta's credit platform at the time of retrieval if the signup bonus is still active. type: number required: - accrual_start_time - maturity_time - target_spend - total_spend type: object AccountStatusEnum: description: |- Status of the credit account. *NOTE* `CHARGE_OFF` is not an allowable value for `original_status`. enum: - UNACTIVATED - ACTIVE - SUSPENDED - TERMINATED - CHARGE_OFF type: string AccountTransitionReq: description: Information on the credit account transition. properties: status: $ref: '#/components/schemas/AccountStatusEnum' token: description: Unique identifier of the credit account transition. type: string required: - status type: object AccountTransitionResponse: description: Information on the credit account transition. properties: account_token: description: Unique identifier of the credit account for which to transition a status. maxLength: 36 type: string created_time: description: Date and time when the transition record was created on Marqeta's credit platform, in UTC. format: date-time type: string original_status: $ref: '#/components/schemas/AccountStatusEnum' status: $ref: '#/components/schemas/AccountStatusEnum' token: description: Unique identifier of the credit account transition. type: string required: - account_token - created_time - original_status - status - token type: object AccountTransitionsPage: description: Return paginated account transitions. properties: count: description: Number of resources returned. type: integer data: description: Contains one or more account transitions. items: $ref: '#/components/schemas/AccountTransitionResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object AccountType: description: Type of credit account. enum: - CONSUMER - BUSINESS type: string AccountUpdateReq: properties: config: $ref: '#/components/schemas/AccountConfigUpdateReq' credit_limit: description: Contains information on the credit limit. properties: value: description: Maximum balance the credit account can carry. exclusiveMinimum: true maximum: 9.9999999999999E11 minimum: 0 type: number required: - value type: object latest_statement_cycle_type: $ref: '#/components/schemas/CycleType' usages: description: |- Contains one or more `usages` objects that contain information on how a credit account is used and what types of balances are permitted on the account. You can pass only one `usages` object per `usages.type`. items: $ref: '#/components/schemas/AccountUsageUpdateReq' type: array user_token: description: |- User token tied to the credit account. You can only update the value of the user token for business accounts. type: string type: object AccountUsageResponse: description: Contains information on how a credit account is used and what types of balances are permitted on the account. properties: aprs: description: Contains one or more APRs associated with the type of balance on the credit account. items: $ref: '#/components/schemas/AprScheduleResponse' type: array fees: description: Contains one or more fees associated with the usage type. items: $ref: '#/components/schemas/AccountFee' type: array type: $ref: '#/components/schemas/BalanceType' required: - aprs - type type: object AccountUsageUpdateReq: description: Contains information on how a credit account is used and what types of balances are permitted on the account. properties: aprs: description: Contains one or more annual percentage rates (APRs) associated with the credit account. items: $ref: '#/components/schemas/AprScheduleUpdateReq' type: array type: $ref: '#/components/schemas/BalanceType' required: - apr_type - apr_value - type type: object AccountUserResponse: description: Object containing user information properties: address1: type: string address2: type: string city: type: string country: type: string credit_accounts: items: properties: is_primary: type: boolean token: type: string type: object type: array email: type: string first_name: type: string last_name: type: string phone: type: string state: type: string token: type: string zip: type: string type: object AccountsPage: description: Return paginated accounts. properties: count: description: Number of resources returned. type: integer data: description: Contains one or more credit accounts. items: $ref: '#/components/schemas/AccountResponse' type: array end_index: description: Sort order index of the first resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object AddressRequestModel: properties: address1: maxLength: 35 minLength: 0 type: string address2: maxLength: 35 minLength: 0 type: string city: maxLength: 35 minLength: 0 type: string country: maxLength: 40 minLength: 0 type: string postal_code: maxLength: 10 minLength: 0 type: string state: maxLength: 35 minLength: 0 type: string zip: maxLength: 10 minLength: 0 type: string type: object AddressResponseModel: properties: address1: maxLength: 35 minLength: 0 type: string address2: maxLength: 35 minLength: 0 type: string city: maxLength: 35 minLength: 0 type: string country: maxLength: 40 minLength: 0 type: string postal_code: maxLength: 20 minLength: 0 type: string state: maxLength: 35 minLength: 0 type: string zip: maxLength: 20 minLength: 0 type: string type: object AndroidPushTokenRequestAddress: description: Specifies the cardholder address. properties: address1: description: Street address of the cardholder. type: string address2: description: |- Additional address information for the cardholder, such as a suite or apartment number. `Suite 600`, for example. type: string city: description: City of the cardholder. type: string country: description: |- Two-character link:https://www.iso.org/iso-3166-country-codes.html[ISO alpha-2 country code, window="_blank"]. `US`, for example. type: string name: description: Name of the cardholder. type: string phone: description: Telephone number of the cardholder. type: string postal_code: description: |- Postal code of the cardholder, such as a United States ZIP code. `94612`, for example. type: string state: description: |- Two-character state, provincial, or territorial abbreviation. For the complete list, see <>. type: string zip: type: string type: object Application: description: Contains client application information. properties: access_code: description: Access code of the client application. type: string assets_url: description: URL of the client application assets. type: string client_api_base_url: description: Base URL of the client API. type: string environment: description: Client application's environment. type: string program: description: Name of the program on the Marqeta platform. type: string program_short_code: description: Short code of the program on the Marqeta platform. type: string token: description: Unique identifier of the `application` object. type: string type: object AprScheduleEntryResponse: properties: apply_next_cycle: default: false description: Whether the APR is ignored for the current billing cycle and applied on the next. type: boolean effective_date: description: Date and time when the APR goes into effect, in UTC. format: date-time type: string margin: description: |- Number of percentage points added to the prime rate, used to calculate a variable value. Used for variable values only. format: float type: number type: default: FIXED description: Indicates whether the APR value is fixed or variable. enum: - FIXED - VARIABLE type: string value: description: |- Percentage value of the APR. If the APR type is `FIXED`, this is the value of the fixed rate. If the APR type is `VARIABLE`, the value is calculated by adding the margin to the prime rate that was stored on Marqeta's credit platform when your credit program was created. When backdating an APR, this value cannot be greater than the value of the effective APR on the backdated date. maximum: 100 minimum: 0 type: number required: - value type: object AprScheduleEntryUpdateReq: properties: apply_next_cycle: default: false description: Whether the APR can be ignored for the current billing cycle and applied on the next. type: boolean effective_date: description: |- Date and time when the APR goes into effect, in UTC. If you do not include a date-time value, the system uses the date and time when the API request was received. *NOTE:* When passing multiple `schedule` objects, this field is required in all objects but the first. If you do not include `effective_date` in the first `schedule`, the system uses the date and time when the API request was received. format: date-time type: string margin: description: |- Number of percentage points added to the prime rate, used to calculate a variable value. Used for variable values only. format: float type: number type: default: FIXED description: Indicates whether the APR value is fixed or variable. enum: - FIXED - VARIABLE type: string value: description: |- Percentage value of the APR. If the APR type is `FIXED`, this is the value of the fixed rate. If the APR type is `VARIABLE`, the value is calculated by adding the margin to the prime rate that was stored on Marqeta's credit platform when your credit program was created. When backdating an APR, this value cannot be greater than the value of the effective APR on the backdated date. maximum: 100 minimum: 0 type: number required: - value type: object AprScheduleResponse: properties: active: description: Whether the APR is active. type: boolean created_date: description: Date and time when the APR was created on Marqeta's credit platform, in UTC. format: date-time type: string schedule: description: Contains one or more `schedule` objects, which contain information about the annual percentage rates (APRs) associated with the type of balance on the credit account and when they are effective. items: $ref: '#/components/schemas/AprScheduleEntryResponse' minItems: 1 type: array type: $ref: '#/components/schemas/AccountAprType' updated_date: description: Date and time when the APR was last updated on Marqeta's credit platform, in UTC. format: date-time type: string required: - schedule - type type: object AprScheduleUpdateReq: properties: schedule: description: Contains one or more `schedule` objects, which contain information about the annual percentage rates (APRs) associated with the type of balance on the credit account and when they are effective. items: $ref: '#/components/schemas/AprScheduleEntryUpdateReq' type: array type: $ref: '#/components/schemas/AccountAprType' required: - schedule - type type: object Association: description: Defines to which the velocity control applies. properties: card_group_token: description: Unique identifier of the card group. maxLength: 36 minLength: 1 type: string type: object AuthControlExemptMidsListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/auth_control_exempt_mids_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object AuthControlListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/auth_control_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object AuthControls: properties: hold_expiration_days: default: 7 format: int32 type: integer hold_increase: $ref: '#/components/schemas/hold_increase' type: object Authentication: description: Contains the cardholder's email address and password information. properties: email_verified: default: false description: Specifies whether the email address has been verified. type: boolean email_verified_time: description: Date and time when the email address was verified. format: date-time type: string last_password_update_channel: description: Specifies the channel through which the password was last changed. enum: - USER_CHANGE - USER_RESET type: string last_password_update_time: description: Date and time when the password was last changed. format: date-time type: string type: object AutoReloadListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/auto_reload_response_model' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object BadRequestError: properties: error_code: enum: - '400' type: string error_message: type: string required: - error_code - error_message type: object BalanceType: description: |- Type of balance. * `PURCHASE` - The balance on purchases. enum: - PURCHASE type: string BankTransferListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/bank_transfer_response_model' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object BankTransferTransitionListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/bank_transfer_transition_response_model' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object BillPayResponse: properties: amount: type: string biller_token: type: string created_time: type: string delivery_date: type: string last_modified_time: type: string payment_token: type: string payment_type: type: string processing_date: type: string status: type: string user_token: type: string type: object BillingAddress: properties: address: type: string compressed_zip: type: string first_name: type: string last_name: type: string zip: type: string type: object BinPoolCreateRequest: description: Request to create a new BIN pool properties: bin_prefixes: description: List of BIN prefixes to add to the pool items: type: string type: array config: description: JSON configuration object example: '{\"reserved_capacity\": 10, \"min_available_bins\": 2}' type: string description: description: Description of the BIN pool example: Primary pool for standard Visa cards type: string name: description: Name of the BIN pool example: Standard Visa Pool type: string pool_type: description: Type of pool enum: - STANDARD - GOOGLE_VCN example: STANDARD type: string token: description: Unique token for the BIN pool example: standard-visa-pool-01 type: string usage_type: description: BIN selection strategy enum: - RANDOM - LEAST_EXHAUSTED - SEQUENTIAL example: LEAST_EXHAUSTED type: string required: - name - token type: object BinPoolUpdateRequest: description: Request to update a BIN pool properties: active: description: Whether the pool is active example: false type: boolean config: description: JSON configuration object example: '{\"reserved_capacity\": 20, \"min_available_bins\": 5}' type: string description: description: Description of the BIN pool example: Updated description type: string name: description: Name of the BIN pool example: Updated Pool Name type: string usage_type: description: BIN selection strategy enum: - RANDOM - LEAST_EXHAUSTED - SEQUENTIAL example: RANDOM type: string type: object BinPrefixRequest: properties: bin_prefix: description: 6-14 digit BIN prefix example: '411111111' maxLength: 14 minLength: 6 pattern: ^\d+$ type: string status: description: Status of this BIN prefix enum: - ACTIVE - INACTIVE example: ACTIVE type: string required: - bin_prefix - status type: object BulkCardOrderListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/bulk_issuance_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object BundleCreateReq: description: Contains information on a bundle. properties: apr_policy_token: description: Unique identifier of the APR policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string credit_product_policy_token: description: Unique identifier of the credit product policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string description: description: Description of the bundle. maxLength: 255 type: string document_policy_token: description: Unique identifier of the document policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string fee_policy_token: description: Unique identifier of the fee policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string name: description: Name of the bundle. maxLength: 255 type: string offer_policy_token: description: Unique identifier of the offer policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string reward_policy_token: description: Unique identifier of the reward policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string status: $ref: '#/components/schemas/BundleResourceStatus' token: description: Unique identifier of the bundle. maxLength: 36 pattern: (?!^ +$)^.+$ type: string required: - apr_policy_token - credit_product_policy_token - description - document_policy_token - fee_policy_token - name - status type: object BundleResourceStatus: description: |- Status of the bundle. * `DRAFT` - The bundle is in the process of being created. * `PENDING_APPROVAL` - The bundle has been created and is awaiting approval. * `SENT_FOR_REVISION` - The bundle has been returned for revision. * `ACTIVE` - The bundle is active. * `REJECTED` - The bundle has been rejected; this status cannot be changed. * `ARCHIVED` - The previously active bundle has been archived. * `APPROVED` - The bundle has been approved (after having been sent for approval). enum: - DRAFT - PENDING_APPROVAL - SENT_FOR_REVISION - ACTIVE - REJECTED - ARCHIVED - APPROVED type: string BundleResponse: description: Contains information on a bundle. properties: apr_policy_detail: $ref: '#/components/schemas/PolicyAprResponse' apr_policy_token: description: Unique identifier of the bundle's APR policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string created_time: description: Date and time when the bundle was created on Marqeta's credit platform, in UTC. format: date-time type: string credit_product_policy_detail: $ref: '#/components/schemas/PolicyProductResponse' credit_product_policy_token: description: Unique identifier of the bundle's credit product policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string description: description: Description of the bundle. type: string document_policy_detail: $ref: '#/components/schemas/PolicyDocumentResponse' document_policy_token: description: Unique identifier of the bundle's document policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string fee_policy_detail: $ref: '#/components/schemas/PolicyFeeResponse' fee_policy_token: description: Unique identifier of the bundle's fee policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string name: description: Name of the bundle. type: string offer_policy_detail: $ref: '#/components/schemas/PolicyOfferResponse' offer_policy_token: description: Unique identifier of the bundle's offer policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string reward_policy_detail: $ref: '#/components/schemas/PolicyRewardResponse' reward_policy_token: description: Unique identifier of the bundle's reward policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string status: $ref: '#/components/schemas/BundleResourceStatus' token: description: Unique identifier of the bundle. maxLength: 36 type: string updated_time: description: Date and time when the bundle was last updated on Marqeta's credit platform, in UTC. format: date-time type: string type: object BundleResponsePage: description: Returns paginated bundles. properties: count: description: Number of resources returned. type: integer data: description: Contains one or more bundles. items: $ref: '#/components/schemas/BundleResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object BundleTransitionReq: description: Contains information on a bundle transition. properties: status: $ref: '#/components/schemas/BundleResourceStatus' required: - status type: object BundleTransitionResponse: description: Contains information on a bundle transition. properties: bundle_token: description: Unique identifier of the bundle. maxLength: 36 type: string created_time: description: Date and time when the bundle was changed the status on Marqeta's credit platform, in UTC. format: date-time type: string original_status: $ref: '#/components/schemas/BundleResourceStatus' status: $ref: '#/components/schemas/BundleResourceStatus' token: description: Unique identifier of the bundle transition. maxLength: 36 type: string type: object BundleUpdateReq: description: Specifies bundles for a credit program. properties: apr_policy_token: description: Unique identifier of the bundle's APR policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string credit_product_policy_token: description: Unique identifier of the bundle's credit product policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string description: description: Description of the bundle. maxLength: 255 type: string document_policy_token: description: Unique identifier of the bundle's document policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string fee_policy_token: description: Unique identifier of the bundle's fee policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string name: description: Name of the bundle. maxLength: 255 type: string offer_policy_token: description: Unique identifier of the bundle's offer policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string reward_policy_token: description: Unique identifier of the bundle's reward policy. maxLength: 36 pattern: (?!^ +$)^.+$ type: string required: - apr_policy_token - credit_product_policy_token - description - document_policy_token - fee_policy_token - name type: object BusinessCardHolderListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/business_card_holder_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object BusinessTransitionListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/BusinessTransitionResponse' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object BusinessTransitionRequest: properties: business_token: type: string channel: enum: - API - IVR - FRAUD - ADMIN - SYSTEM type: string idempotentHash: type: string reason: maxLength: 255 minLength: 0 type: string reason_code: enum: - '00' - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' - '09' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '86' type: string status: enum: - UNVERIFIED - LIMITED - ACTIVE - SUSPENDED - CLOSED - TERMINATED type: string token: type: string required: - business_token - channel - reason_code - status type: object BusinessTransitionResponse: properties: business_token: type: string channel: enum: - API - IVR - FRAUD - ADMIN - SYSTEM type: string created_time: format: date-time type: string created_timestamp: format: date-time type: string last_modified_time: format: date-time type: string metadata: additionalProperties: type: string type: object reason: type: string reason_code: enum: - '00' - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' - '09' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '86' type: string status: enum: - UNVERIFIED - LIMITED - ACTIVE - SUSPENDED - CLOSED - TERMINATED type: string token: type: string required: - channel - reason_code - status - token type: object BusinessUserCardHolderListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/user_card_holder_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object CalculatedBalanceResponse: properties: available_credit: description: the latest balance of the account from the migrated program type: number current_balance: description: the latest balance of the account from the migrated program type: number type: object CardFulfillmentRequest: properties: card_fulfillment_reason: enum: - NEW - LOST_STOLEN - EXPIRED type: string card_personalization: $ref: '#/components/schemas/card_personalization' shipping: $ref: '#/components/schemas/shipping' required: - card_personalization type: object CardFulfillmentResponse: description: Determines physical characteristics of a card and shipment information. properties: card_fulfillment_reason: description: Descriptive reason for the card fulfillment. enum: - NEW - LOST_STOLEN - EXPIRED type: string card_personalization: $ref: '#/components/schemas/card_personalization' shipping: $ref: '#/components/schemas/ShippingInformationResponse' required: - card_personalization type: object CardGroup: description: Request body for a Card Group object properties: card_tokens: description: Array of card tokens associated with group. There will be at least one card token in the array. items: type: string type: array created_time: description: |- Date and time the card group was created in the system. The date and time is provided in ISO 8601 format. format: date-time type: string last_issued_card_token: description: Unique identifier of the last reissued card token associated with group. It may be empty if there is no reissued card. maxLength: 36 minLength: 1 type: string source_card_token: description: |- Unique identifier of the card token associated with group. This is the card that will be used to create the card group. The Card Group Service will send a request to JCard to verify that this card is not a reissue or replacement. maxLength: 36 minLength: 1 type: string token: description: |- Unique identifier of the card group. If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. maxLength: 36 minLength: 1 type: string updated_time: description: |- Date and time the card group was last updated in the system. The date and time is provided in ISO 8601 format. format: date-time type: string user_token: description: Unique identifier of the user this card group belongs to. maxLength: 36 minLength: 1 type: string required: - source_card_token - token type: object CardGroupPage: properties: count: description: |- Number of resources retrieved. This field is returned if there are resources in your returned array. format: int32 type: integer data: description: |- Array of Card Group objects. Objects are returned as appropriate to your query. items: $ref: '#/components/schemas/CardGroup' type: array end_index: description: |- Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer is_more: default: false description: |- A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. type: boolean start_index: description: |- Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer type: object CardGroupReq: description: Request body for creating a new Card Group object properties: card_token: description: Unique identifier token of the card token to be associated with the group. maxLength: 36 minLength: 1 type: string required: - card_token type: object CardHolderNoteListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/cardholder_note_response_model' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object CardListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/card_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object CardProductListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/card_product_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object CardResponse: description: Information about a credit card. properties: account_token: description: Unique identifier of the associated credit account. maxLength: 36 type: string created_time: description: Date and time when the card was created on Marqeta's credit platform, in UTC. format: date-time type: string token: description: Unique identifier of the credit card. type: string updated_time: description: Date and time when the card was last modified on Marqeta's credit platform, in UTC. format: date-time type: string user_token: description: Unique identifier of the credit cardholder. type: string required: - account_token - created_time - token - updated_time - user_token type: object CardTransitionListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/card_transition_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object CardholderAddressListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/CardholderAddressResponse' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object CardholderAddressResponse: description: Contains information about the billing address of the funding source. properties: active: default: false description: Whether the address is active. type: boolean address_1: description: Street address of the funding source. maxLength: 255 minLength: 0 type: string address_2: description: |- Additional address information for the funding source. This field is returned if it exists in the resource. maxLength: 255 minLength: 0 type: string business_token: description: |- Unique identifier of the business account holder associated with the address. This field is returned if it exists in the resource. maxLength: 36 minLength: 1 type: string city: description: City of the funding source. maxLength: 40 minLength: 0 type: string country: description: Country of the funding source. maxLength: 40 minLength: 1 type: string created_time: description: Date and time when the address was created, in UTC. format: date-time type: string first_name: description: First name of the account holder associated with the funding source. maxLength: 40 minLength: 0 type: string is_default_address: default: false description: Whether this address is the default address used by the funding source. type: boolean last_modified_time: description: |- Date and time when the address was last modified, in UTC. This field is returned if it exists in the resource. format: date-time type: string last_name: description: Last name of the account holder associated with the funding source. maxLength: 40 minLength: 0 type: string phone: description: |- Phone number of the funding source. This field is returned if it exists in the resource. maxLength: 255 minLength: 0 type: string postal_code: description: Postal code of the funding source. maxLength: 10 minLength: 0 type: string state: description: |- Two-character state, provincial, or territorial abbreviation. For the complete list, see <>. maxLength: 2 minLength: 0 type: string token: description: Unique identifier of the `funding_source_address` object. maxLength: 36 minLength: 1 type: string user_token: description: |- Unique identifier of the user account holder associated with the address. This field is returned if it exists in the resource. maxLength: 36 minLength: 1 type: string zip: description: United States ZIP code of the funding source. maxLength: 10 minLength: 0 type: string required: - address_1 - city - country - created_time - first_name - last_modified_time - last_name - postal_code - state - token - zip type: object CashloadsResponseModel: properties: vendor_product_id: type: string type: object ChargebackListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/chargeback_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object ChargebackTransitionListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/chargeback_transition_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object ChargebackUpdateRequest: properties: reason_code: description: Either 'reason_code' or 'reason_description' is required type: string reason_description: description: Either 'reason_description' or 'reason_code' is required enum: - SERVICE_NOT_PROVIDED_MERCHANDISE_NOT_RECEIVED - CANCELLED_RECURRING_TRANSACTION - NOT_AS_DESCRIBED_OR_DEFECTIVE_MERCHANDISE - FRAUD_MULTIPLE_TRANSACTIONS - FRAUD_TRANSACTION - NO_AUTHORIZATION - LATE_PRESENTMENT - TRANSACTION_NOT_RECOGNIZED - INCORRECT_CURRENCY - INCORRECT_TRANSACTION_CODE - INCORRECT_CURRENCY_OR_TRANSACTION_CODE - INCORRECT_TRANSACTION_AMOUNT - INCORRECT_ACCOUNT_NUMBER - INCORRECT_TRANSACTION_AMOUNT_OR_ACCOUNT_NUMBER - NOT_AUTHORIZED_CARD_PRESENT - NOT_AUTHORIZED_CARD_ABSENT - CREDIT_NOT_PROCESSED - NON_RECEIPT_OF_CASH_OR_LOAD_TRANSACTION_VALUE_AT_ATM - DUPLICATE_PROCESSING_OR_PAID_BY_OTHER_MEANS type: string status: enum: - ARBITRATION - CASE_LOST - CASE_WON - INITIATED - NETWORK_REJECTED - PREARBITRATION - PRE_INITIATED - REPRESENTMENT - WITHDRAWN - WRITTEN_OFF_ISSUER - WRITTEN_OFF_PROGRAM type: string type: object ClearingModel: properties: amount: type: number card_acceptor: $ref: '#/components/schemas/card_acceptor_model' force_post: default: false type: boolean is_refund: default: false type: boolean mid: maxLength: 50 minLength: 1 type: string network_fees: items: $ref: '#/components/schemas/network_fee_model' type: array original_transaction_token: maxLength: 36 minLength: 1 type: string webhook: $ref: '#/components/schemas/webhook' required: - amount - original_transaction_token type: object CommandoModeListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/commando_mode_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object CommandoModeTransitionListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/commando_mode_transition_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object ConfigFeeScheduleEntry: description: Contains information on a fee schedule. properties: effective_date: description: Date and time when the fee goes into effect, in UTC. format: date-time type: string method: $ref: '#/components/schemas/FeeMethod' value: description: Amount of the fee. maximum: 9999.99 minimum: 0 type: number required: - method - value type: object ConfigFeeScheduleReq: description: Contains information relevant to configuring fees. properties: schedule: description: Contains one or more fee schedules. items: $ref: '#/components/schemas/ConfigFeeScheduleEntry' type: array type: $ref: '#/components/schemas/AccountProductFeeType' required: - schedule - type type: object ConfigFeeScheduleResponse: description: Contains information returned when configuring fees. properties: active: description: Whether the fee is active. type: boolean created_date: description: Date and time when the fee was created on Marqeta's credit platform, in UTC. format: date-time type: string schedule: description: Contains one or more fee schedules. items: $ref: '#/components/schemas/ConfigFeeScheduleEntry' type: array type: $ref: '#/components/schemas/AccountProductFeeType' updated_date: description: Date and time when the fee was last updated on Marqeta's credit platform, in UTC. format: date-time type: string type: object CurrencyBalance: properties: available_balance: type: number cached_balance: type: number credit_balance: type: number impacted_amount: type: number ledger_balance: type: number pending_credits: type: number type: object CurrencyCode: default: USD description: Valid three-digit link:https://www.iso.org/iso-4217-currency-codes.html[ISO 4217 currency code, window="_blank"]. enum: - USD type: string CustomerDueDiligenceRequest: properties: answer: type: string question: type: string token: maxLength: 36 minLength: 1 type: string required: - answer - question type: object CustomerDueDiligenceUpdateRequest: properties: answer: type: string type: object CycleType: description: |- Type of cycle. * `BEGINNING_REVOLVING` - Account is beginning to revolve and just started carrying a balance from the previous month. * `REVOLVING` - Account is revolving and has been carrying a balance from month to month for more than one month. * `END_REVOLVING` - Account is no longer revolving and the previous month's balance is paid off. * `TRANSACTING` - Account is not revolving and the balance is paid off each month. enum: - BEGINNING_REVOLVING - REVOLVING - END_REVOLVING - TRANSACTING type: string DDARequest: properties: dda: type: string required: - dda type: object DelinquencyBucketResponse: description: |- One or more delinquency buckets for an account. Each delinquency bucket represents a billing cycle during which the account was delinquent. properties: bucket_number: description: |- Delinquency bucket number in the returned array. Delinquency buckets are returned from most recent to least; the most recent delinquency bucket is `1`. type: integer current_due: description: Current amount that is due for this delinquency bucket. type: number days_past_due: description: Total number of days that the payment is past due for this delinquency bucket. type: integer past_due_carried_forward: description: Amount that is past due and carried forward from previous delinquency buckets. type: number payment_due_date: description: Date that the payment was due for this delinquency bucket. format: date-time type: string total_due: description: Total amount that is due for this delinquency bucket; the sum of `past_due_carried_forward` and `current_due`. type: number required: - bucket_number - current_due - days_past_due - past_due_carried_forward - payment_due_date - total_due type: object DelinquencyStateResponse: description: Contains details of the delinquency state of an account. properties: account_token: description: Unique identifier of the credit account. format: string type: string buckets: description: |- One or more delinquency buckets for an account. Each delinquency bucket represents a billing cycle during which the account was delinquent. items: $ref: '#/components/schemas/DelinquencyBucketResponse' type: array current_due: description: Amount that is due for the current billing cycle. type: number date_account_current: description: |- Date and time when the account was last made current on the Marqeta platform, in UTC. If the account was never delinquent, this field returns the date and time the account was created on the Marqeta platform, in UTC. If `is_delinquent` is `true`, a null value is returned. format: date-time nullable: true type: string date_account_delinquent: description: |- Date and time when the account last fell delinquent on the Marqeta platform, in UTC. If `is_delinquent` is `false`, a null value is returned. format: date-time nullable: true type: string delinquent_days_past_statement_end_date: description: Total number of days that the account is past the oldest bucket's statement end date. type: integer is_delinquent: description: A value of `true` indicates that the account is currently delinquent. type: boolean total_days_past_due: description: Total number of days that the account is past due. type: integer total_due: description: Total amount that is due for the current billing cycle; the sum of `total_past_due_amount` and `current_due_amount`. type: number total_past_due: description: Total amount that is past due. type: number required: - account_token - current_due - is_delinquent - total_days_past_due - total_due - total_past_due type: object DelinquencyStatus: description: Delinquency status of an account. enum: - CURRENT - DELINQUENT type: string DelinquencyTransitionResponse: description: Contains details of the account's delinquency state transition. properties: account_token: description: Unique identifier of the credit account. format: string type: string bucket_count: description: Number of buckets for the account after the triggering event occurred. type: number created_time: description: Date and time when the delinquency state transition was created on Marqeta's credit platform, in UTC. format: date-time type: string current_due: description: |- Current amount that is due after the triggering event occurred. Equivalent to `current_due` for the account's most recent delinquency bucket. To retrieve delinquency buckets for an account, send a `GET` request to `/credit/accounts/{account_token}/delinquencystate`. type: number impact_time: description: Date and time when the triggering event impacted the account, in UTC. format: date-time type: string is_rolled_back: description: |- A value of `true` indicates that the system invalidated and rolled back the delinquency transition. This is a temporary field that allows Marqeta to handle occasional cases of out-of-order processing. This can occur when two delinquency state transition webhooks are sent near-simultaneously. For example, if a credit and a payment that bring an account current are made around the same time, two delinquency state transitions are sent very close together. In these cases, one of the transitions is rolled back and invalidated. For the transition that is rolled back, `is_rolled_back` is `true` and the transition should be ignored. This field is temporary and to be deprecated when out-of-order processing is addressed in a future release. type: boolean oldest_payment_due_date: description: |- Payment due date of the account's oldest delinquency bucket, in UTC. Useful when used with the delinquency state transition's `created_time` to determine the total number of days a payment is past due. format: date-time type: string original_status: $ref: '#/components/schemas/DelinquencyStatus' status: $ref: '#/components/schemas/DelinquencyStatus' token: description: Unique identifier of the delinquency state transition. format: string type: string total_due: description: |- Total amount that is due after the triggering event occurred; the sum of `total_past_due` and `current_due`. Equivalent to `total_due` for the account's most recent delinquency bucket. To retrieve delinquency buckets for an account, send a `GET` request to `/credit/accounts/{account_token}/delinquencystate`. type: number total_past_due: description: |- Total amount that is past due after the triggering event occurred. Equivalent to `past_due_carried_forward` for the account's most recent delinquency bucket. To retrieve delinquency buckets for an account, send a `GET` request to `/credit/accounts/{account_token}/delinquencystate`. type: number transition_trigger_reason: $ref: '#/components/schemas/DelinquencyTransitionTriggerReason' transition_trigger_time: description: |- Date and time when the triggering event caused the account's delinquency state to transition, in UTC. For <>, equivalent to `request_time`. For <>, equivalent to `impact_time`, format: date-time type: string updated_time: description: Date and time when the delinquency state transition was last updated on Marqeta's credit platform, in UTC. format: date-time type: string required: - account_token - created_time - impact_time - is_rolled_back - original_status - status - token - transition_trigger_reason - transition_trigger_time type: object DelinquencyTransitionTriggerReason: description: Event that triggered an update to the account's delinquency state. enum: - PAYMENT - PAYMENT_VOID - CREDIT - MINIMUM_PAYMENT_OVERRIDE - STATEMENT_GENERATION - STATEMENT_AMENDMENT - REAGE - PAST_MIN_PAYMENT_DUE type: string DelinquencyTransitionsResponsePage: description: Returns paginated information for multiple delinquency state transitions. properties: count: description: Number of resources returned. type: integer data: description: List of delinquency state transitions. items: $ref: '#/components/schemas/DelinquencyTransitionResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object DepositAccountResponse: properties: account_number: type: string allow_immediate_credit: default: false type: boolean business_token: type: string routing_number: type: string token: type: string user_token: type: string required: - account_number - routing_number - token type: object DepositAccountUpdateRequest: properties: allow_immediate_credit: default: false type: boolean type: object DepositDepositResponse: description: Contains information about a direct deposit. properties: amount: description: Amount being debited or credited. type: number business_token: description: The unique identifier of the business account holder. type: string company_discretionary_data: description: Company-specific data provided by the direct deposit originator. type: string company_entry_description: description: Company-specific data provided by the direct deposit originator. type: string company_identification: description: Alphanumeric code that identifies the direct deposit originator. type: string company_name: description: Name of the direct deposit originator. type: string created_time: description: Date and time when the direct deposit account was created. format: date-time type: string direct_deposit_account_token: description: The unique identifier of the direct deposit account. type: string individual_identification_number: description: Accounting number by which the recipient is known to the direct deposit originator. type: string individual_name: description: Name of the direct deposit recipient. type: string last_modified_time: description: Date and time when the direct deposit account was last modified. format: date-time type: string settlement_date: description: Date and time when the credit or debit is applied. format: date-time type: string standard_entry_class_code: description: Three-letter code identifying the type of entry. type: string state: description: Current status of the direct deposit record. enum: - PENDING - APPLIED - REVERSED - REJECTED type: string state_reason: description: Explanation for why the direct deposit record is in the current state. type: string state_reason_code: description: Standard code describing the reason for the current state. type: string token: description: The unique identifier of the direct deposit record. type: string type: description: Determines whether funds are being debited from or credited to the account. enum: - CREDIT - DEBIT type: string user_token: description: The unique identifier of the user account holder. type: string type: object DigitalWalletTokenListResponse: properties: count: description: |- Number of resources returned. This field is returned if there are resources in your returned array. format: int32 type: integer data: description: |- Array of digital wallet token resources. Resources are returned as appropriate to your query. items: $ref: '#/components/schemas/digital_wallet_token' type: array end_index: description: |- Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer is_more: default: false description: |- A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. type: boolean start_index: description: |- Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer type: object DigitalWalletTokenTransitionListResponse: properties: count: description: |- Number of resources returned. This field is returned if there are resources in your returned array. format: int32 type: integer data: description: |- Array of digital wallet token transition resources. Resources are returned as appropriate to your query. items: $ref: '#/components/schemas/digital_wallet_token_transition_response' type: array end_index: description: |- Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer is_more: default: false description: |- A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. type: boolean start_index: description: |- Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer type: object DigitalWalletTokenization: properties: card_art_id: type: string provisioning_controls: $ref: '#/components/schemas/provisioning_controls' type: object DirectDepositAccountListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/direct_deposit_account_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object DirectDepositAccountRequest: properties: allow_immediate_credit: default: false type: boolean business_token: description: Required if 'user_token' is null maxLength: 36 minLength: 1 type: string customer_due_diligence: description: Required if account type = Checking items: $ref: '#/components/schemas/CustomerDueDiligenceRequest' type: array token: type: string type: enum: - DEPOSIT_ACCOUNT - CHECKING - SAVINGS - INTEREST_BEARING type: string user_token: description: Required if 'business_token' is null maxLength: 36 minLength: 1 type: string type: object DirectDepositAccountTransitionRequest: properties: account_token: maxLength: 36 minLength: 1 type: string channel: enum: - API - IVR - FRAUD - ADMIN - SYSTEM - NETWORK - PROD_SUPPORT - UNSUPPORTED type: string reason: maxLength: 255 minLength: 1 type: string state: enum: - ACTIVE - SUSPENDED - TERMINATED - UNSUPPORTED - UNACTIVATED - LIMITED type: string token: type: string required: - account_token - channel type: object DirectDepositListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/DepositDepositResponse' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object DirectDepositRequest: properties: account_number: type: string amount: type: number company_discretionary_data: maxLength: 20 minLength: 0 type: string company_entry_description: maxLength: 10 minLength: 0 type: string company_identification: maxLength: 10 minLength: 0 type: string company_name: maxLength: 16 minLength: 0 type: string earlyPayEligible: default: false type: boolean individual_identification_number: maxLength: 22 minLength: 0 type: string individual_name: maxLength: 35 minLength: 0 type: string settlement_date: format: date-time type: string standard_entry_class_code: maxLength: 3 minLength: 0 type: string token: maxLength: 36 minLength: 0 type: string type: enum: - CREDIT - DEBIT type: string required: - account_number - amount - settlement_date - type type: object DirectDepositTransitionListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/DirectDepositTransitionResponse' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object DirectDepositTransitionRequest: properties: channel: enum: - API - SYSTEM - PROD_SUPPORT type: string direct_deposit_token: type: string idempotentHash: type: string reason: maxLength: 255 minLength: 0 type: string reason_code: enum: - R01 - R02 - R03 - R04 - R06 - R08 - R09 - R10 - R11 - R14 - R15 - R16 - R17 - R18 - R20 - R23 - R24 - R29 type: string state: enum: - PENDING - APPLIED - REVERSED - REJECTED type: string token: type: string required: - channel - direct_deposit_token - reason - state type: object DirectDepositTransitionResponse: properties: channel: enum: - API - IVR - FRAUD - ADMIN - SYSTEM - NETWORK - PROD_SUPPORT - UNSUPPORTED type: string created_time: format: date-time type: string direct_deposit_account_token: type: string direct_deposit_token: type: string reason: type: string reason_code: type: string state: enum: - PENDING - APPLIED - REVERSED - REJECTED type: string token: type: string transaction_token: type: string type: type: string type: object DisputeCategory: description: Category to which the dispute belongs. enum: - FRAUD - AUTH - PROCESSING_ERROR - CONSUMER_DISPUTE type: string DisputeCreateReq: description: Information about a transaction dispute creation request. properties: amount: description: |- Amount of the dispute. Max value is equal to the value of the original transaction. minimum: 0.01 type: number category: $ref: '#/components/schemas/DisputeCategory' ledger_entry_token: description: Unique identifier of the journal entry (`authorization.clearing` type only) in dispute. format: string maxLength: 36 type: string notes: description: Additional information on the dispute (for example, a reason for the dispute). format: string maxLength: 750 type: string token: description: Unique identifier of the dispute. format: string maxLength: 36 pattern: (?!^ +$)^.+$ type: string required: - amount - category - ledger_entry_token type: object DisputeModel: description: Contains information about a disputed transaction. properties: case_management_identifier: description: The unique identifier of the dispute case. type: string reason: description: The reason for the dispute. type: string type: object DisputeResponse: description: Information about a transaction dispute response. properties: account_token: description: Unique identifier of the credit account on which the dispute was created. format: string maxLength: 36 type: string amount: description: Amount of the dispute. type: number category: $ref: '#/components/schemas/DisputeCategory' created_time: description: Date and time when the dispute was created on Marqeta's credit platform, in UTC. format: date-time type: string ledger_entry_token: description: Unique identifier of the journal entry (`authorization.clearing` type only) in dispute. format: string type: string notes: description: Additional information on the dispute (for example, a reason for the dispute). format: string type: string resolved_at: description: Date and time when the dispute was resolved and no longer in `ACTIVE` status. format: date-time type: string status: $ref: '#/components/schemas/DisputeStatus' token: description: Unique identifier of the dispute. format: string type: string updated_time: description: Date and time when the dispute was last updated on Marqeta's credit platform, in UTC. format: date-time type: string required: - account_token - amount - category - created_time - ledger_entry_token - status - token - updated_time type: object DisputeResponsePage: description: Return paginated disputes. properties: count: description: Number of resources returned. type: integer data: description: Contains one or more disputes on a credit account. items: $ref: '#/components/schemas/DisputeResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object DisputeStatus: description: |- Status of the dispute. * `ACTIVE` - The dispute is active and awaiting resolution. * `REVERSED` - The dispute has been reversed and is no longer active. * `AH_WON` - The account holder won the dispute. * `AH_LOST` - The account holder lost the dispute. enum: - ACTIVE - REVERSED - AH_WON - AH_LOST - REFUNDED type: string DisputeTransitionReq: description: Information about a transaction dispute update request. properties: amount: description: Updated amount of the dispute, based on the resolution. type: number interest_adjustments: description: |- List of interest adjustments and their effective times, if applicable. Note that this typically only applies for a cross-cycle activity, such as a dispute or payment. items: $ref: '#/components/schemas/MigrateDisputeInterestAdjustment' type: array notes: description: Additional information on the dispute update (for example, a reason for the dispute update). format: string maxLength: 750 type: string source_created_time: description: Date and time when the dispute occurred. format: date-time type: string status: $ref: '#/components/schemas/DisputeStatus' token: description: Unique identifier of the dispute update. maxLength: 36 type: string required: - amount - status type: object DisputeTransitionResponse: description: Information about a transaction dispute update request. properties: account_token: description: Unique identifier of the credit account on which the dispute was updated. type: string amount: description: Amount of the updated dispute, based on the resolution. type: number created_time: description: Date and time when the dispute update was created on Marqeta's credit platform, in UTC. format: date-time type: string notes: description: Additional information on the dispute update (for example, a reason for the dispute update). format: string maxLength: 750 type: string status: $ref: '#/components/schemas/DisputeStatus' token: description: Unique identifier of the dispute update. type: string required: - account_token - amount - created_time - status - token type: object Error: properties: code: type: integer message: type: string type: object ExpirationOffset: properties: min_offset: $ref: '#/components/schemas/MinOffset' unit: description: specify if a value is provided; default is YEARS enum: - YEARS - MONTHS - DAYS - HOURS - MINUTES - SECONDS type: string value: description: specify if unit is provided; default is 4 format: int32 type: integer type: object FeeListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/fee_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object FeeMethod: description: Method used to calculate the fee value. enum: - FLAT - PERCENTAGE type: string FeeStatusEnum: description: Status of the fee. enum: - PENDING - POSTED - REVERSED type: string FeeType: description: |- Type of fee. *NOTE:* Only `RETURNED_PAYMENT_FEE`, `LATE_PAYMENT_FEE`, `ANNUAL_FEE`, and `MONTHLY_FEE` are currently supported. Do not pass other fees types. enum: - FOREIGN_TRANSACTION_FEE - OVER_LIMIT_FEE - LATE_PAYMENT_FEE - RETURNED_PAYMENT_FEE - CARD_REPLACEMENT_FEE - MINIMUM_INTEREST_FEE - MINIMUM_INTEREST_FEE_REVERSAL - ANNUAL_FEE - MONTHLY_FEE - ACCOUNT_FEE type: string FinalizeMigrationStatusResponse: description: Finalize status of a migrated account. properties: account_token: description: Unique identifier of the credit account with associated finalize response. maxLength: 36 type: string available_credit_adjustment: description: the amount of the available credit adjustment created. type: number created_time: description: Date and time when the finalize status was created, in UTC. format: date-time type: string current_balance_adjustment: description: the amount of the curent balance adjustment created. type: number expected_available_credit: description: the latest balance of the account from the migrated program type: number expected_current_balance: description: the latest balance of the account from the migrated program type: number final_available_credit: description: the latest balance of the account from the migrated program type: number final_current_balance: description: the latest balance of the account from the migrated program type: number status: description: Finalize status of the account. enum: - PROCESSING - COMPLETED - FAILED type: string token: description: Unique identifier of the finalize entry. maxLength: 36 type: string updated_time: description: Date and time when the finalize status was updated, in UTC. format: date-time type: string user_token: description: Unique user token tied to the credit account. maxLength: 36 type: string type: object ForbiddenError: properties: error_code: enum: - '403' type: string error_message: type: string required: - error_code - error_message type: object FraudFeedbackRequest: description: of the fraud object properties: actor: description: This is the party making a call. enum: - UNKNOWN - THIRD_PARTY_FRAUD - CARD_USER_FRAUD type: string amount: type: string is_fraud: type: boolean status: description: This is the value of the status of the fraud. enum: - CONFIRMED - DISPUTED type: string transaction_token: maxLength: 64 minLength: 3 type: string required: - actor - amount - is_fraud - status - transaction_token type: object FraudFeedbackResponse: description: of the fraudfeedback response object properties: message: maxLength: 256 type: string required: - message type: object FulfillmentAddressResponse: description: Specifies a fulfillment shipping or return address. properties: address1: description: |- Number and street of the address. This field is returned if it exists in the resource. maxLength: 255 minLength: 0 type: string address2: description: |- Additional address information. This field is returned if it exists in the resource. maxLength: 255 minLength: 0 type: string city: description: |- City of the address. This field is returned if it exists in the resource. maxLength: 40 minLength: 0 type: string country: description: |- Country of the address. This field is returned if it exists in the resource. maxLength: 40 minLength: 0 type: string first_name: description: |- First name of the addressee. This field is returned if it exists in the resource. maxLength: 40 minLength: 0 type: string last_name: description: |- Last name of the addressee. This field is returned if it exists in the resource. maxLength: 40 minLength: 0 type: string middle_name: description: |- Middle name of the addressee. This field is returned if it exists in the resource. maxLength: 40 minLength: 0 type: string phone: description: |- Telephone number of the addressee. This field is returned if it exists in the resource. maxLength: 20 minLength: 0 type: string postal_code: description: |- Postal code of the address. This field is returned if it exists in the resource. maxLength: 10 minLength: 0 type: string state: description: |- State or province of the address. This field is returned if it exists in the resource. maxLength: 32 minLength: 0 type: string zip: description: |- United States ZIP code of the address. This field is returned if it exists in the resource. maxLength: 10 minLength: 0 type: string type: object FulfillmentRequest: properties: card_personalization: $ref: '#/components/schemas/card_personalization' shipping: $ref: '#/components/schemas/shipping' required: - card_personalization type: object FulfillmentResponse: properties: card_personalization: $ref: '#/components/schemas/card_personalization' shipping: $ref: '#/components/schemas/ShippingInformationResponse' required: - card_personalization type: object FundingAccountListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/funding_account_response_model' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object GPAUnloadListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/gpa_returns' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object IdentificationRequestModel: description: Contains identifications associated with the cardholder. properties: expiration_date: description: Expiration date of the identification, if applicable. type: string issuing_country: readOnly: true type: string type: description: |- Type of identification. *NOTE:* Full Social Security Number (SSN) is required for US-based user cardholder KYC verification, using the `SSN` type. Full Employer Identification Number (EIN) is required for business cardholder KYC verification, using the `BUSINESS_TAX_ID` or `BUSINESS_NUMBER` type. For business directors, use one of SSN, TIN, SIN, or NIN. Nine digits only, no delimiters. `123456789`, for example. enum: - SSN - TIN - SIN - NIN - PASSPORT_NUMBER - DRIVERS_LICENSE - BUSINESS_NUMBER - BUSINESS_TAX_ID - TAXPAYER_REFERENCE readOnly: true type: string value: description: Number associated with the identification. readOnly: true type: string required: - type type: object IdentificationResponseModel: description: Contains identifications associated with the cardholder. properties: expiration_date: description: Expiration date of the identification, if applicable. readOnly: true type: string issuing_country: readOnly: true type: string type: description: Type of identification. enum: - SSN - TIN - SIN - NIN - PASSPORT_NUMBER - DRIVERS_LICENSE - BUSINESS_NUMBER - BUSINESS_TAX_ID - TAXPAYER_REFERENCE readOnly: true type: string value: description: Number associated with the identification. readOnly: true type: string type: object ImagesCarrier: description: Specifies personalized images that appear on the card carrier. properties: message_1: description: Specifies a custom message that appears on the card carrier. type: string name: description: Specifies a PNG image to display on the card carrier. type: string type: object InterestCalculation: description: Contains the configurations for interest calculation. properties: day_count: description: Day-count convention. enum: - ACTUAL type: string exclude_tran_types: default: - ANNUAL_FEE - MONTHLY_FEE - LATE_PAYMENT_FEE - CASH_BACK_STATEMENT_CREDIT - FOREIGN_TRANSACTION_FEE description: One or more transactions that are excluded from current billing period's interest charge, but included in next. items: enum: - LATE_PAYMENT_FEE - ANNUAL_FEE - MONTHLY_FEE - CASH_BACK_STATEMENT_CREDIT - RETURNED_PAYMENT_FEE - FOREIGN_TRANSACTION_FEE type: string type: array grace_days_application: description: Determines the last day of grace period based on which interest charges are calculated. enum: - NEXT_CYCLE_DATE type: string interest_application: default: - PRINCIPAL - FEES description: One or more balance types on which interest is applied. items: enum: - PRINCIPAL - FEES - INTEREST type: string minItems: 1 type: array interest_on_grace_reactivation: $ref: '#/components/schemas/InterestOnGraceReactivationEnum' method: description: Method of interest calculation. enum: - AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS type: string minimum_interest: description: When interest is applied, this value determines the minimum amount of interest that can be charged. maximum: 9.9999999999999E11 minimum: 0 type: number required: - day_count - grace_days_application - interest_application - interest_on_grace_reactivation - method - minimum_interest type: object InterestOnGraceReactivationEnum: description: Determines whether to charge or waive interest for the billing period when the balance is paid off. enum: - ACCRUE_FULL_CYCLE - ACCRUE_PAYMENT_DATE - WAIVE type: string InternalServerError: properties: error_code: enum: - '500' type: string error_message: type: string required: - error_code - error_message type: object JournalEntriesPage: description: Return filtered transactions. properties: count: description: Number of resources returned. maximum: 100 minimum: 0 type: integer data: description: Contains one or more journal entries on a credit account. items: $ref: '#/components/schemas/JournalEntry' maxItems: 100 minItems: 0 type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object JournalEntry: description: Contains information about a journal entry. properties: account_token: description: Unique identifier of the credit account associated with the credit card used to make the journal entry. format: string type: string amount: description: Amount of the journal entry. type: number card_token: description: Unique identifier of the credit card used to make the journal entry. format: string maxLength: 36 minLength: 8 type: string created_time: description: Date and time when the journal entry was created on Marqeta's credit platform, in UTC. format: date-time type: string currency_code: $ref: '#/components/schemas/CurrencyCode' detail_object: type: object detail_token: description: Unique identifier of the journal entry's full details. type: string group: description: Group to which the journal entry belongs. enum: - PURCHASE - REFUND - DISPUTE - ORIGINAL_CREDIT - FEE - REWARD - INTEREST - PAYMENT - ADJUSTMENT - BALANCE_TRANSFER - CASH_ADVANCE - BALANCE_REFUND type: string id: description: Eight-digit numeric identifier of the journal entry, an alternate identifier to the UUID that is useful for remembering and referencing. maxLength: 8 minLength: 8 type: string impact_time: description: |- Date and time when the journal entry impacts the account balance. For purchases, this is the time of the authorization. For purchase authorization clearings, this is the time when the transaction is settled. format: date-time type: string memo: description: Merchant name or description for the journal entry. example: Whole Foods Market type: string original_currency: $ref: '#/components/schemas/OriginalCurrency' program_migration_time: description: Date and time when the journal entry was migrated to Marqeta's credit platform, in UTC. Null if not migrated. format: date-time type: string related_token: description: |- Unique identifier of the original journal entry. If the current journal entry is the original, this field is returned empty. type: string request_time: description: |- For purchases, the date and time of the authorization, which is when the user initiates the journal entry. For other journal entry groups, equivalent to `impact_time`. format: date-time type: string root_token: description: |- Unique identifier of the root journal entry. If the current journal entry is the root, this field is returned empty. type: string status: description: |- Status of the journal entry when it was initially recorded and had an impact on the balance, either `PENDING` or `POSTED`. This field is immutable and may not represent the current status. To view the current status of purchases, refunds, OCTs, and payments, see the `detail_object.state` field. These journal entries start in `PENDING` and can transition to `CLEARED`, `DECLINED`, or `ERROR`. This transition of status is only sent through webhook event notifications. Journal entries that are final transactions, such as clearings, start and remain in a `POSTED` state. *NOTE*: `CLEARED`, `DECLINED`, and `ERROR` are special statuses that do not have an impact on the account balance, and are not recorded in the journal. For these special statuses, `impact_time`, `request_time`, `created_time`, `token`, and `id` are returned blank. enum: - PENDING - POSTED - DECLINED - ERROR - CLEARED type: string token: description: Unique identifier of the journal entry. type: string type: description: Journal entry event type. example: '`authorization.clearing`' type: string user_token: description: Unique identifier of the credit user. type: string required: - account_token - amount - created_time - currency_code - detail_token - group - id - impact_time - request_time - status - token - type - user_token type: object KYCListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/kyc_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object LedgerEntriesPage: description: Return filtered transactions. properties: count: description: Number of resources returned. type: integer data: description: Contains one or more ledger entries on a credit account. items: $ref: '#/components/schemas/LedgerEntry' minItems: 1 type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object LedgerEntry: description: Contains information about a ledger entry. properties: account_token: description: Unique identifier of the credit account associated with the credit card used to make the ledger entry. format: string type: string amount: description: Amount of the ledger entry. type: number card_token: description: Unique identifier of the credit card used to make the ledger entry. format: string maxLength: 36 minLength: 8 type: string created_time: description: Date and time when the ledger entry was created on Marqeta's credit platform, in UTC. format: date-time type: string currency_code: $ref: '#/components/schemas/CurrencyCode' detail_object: description: |- Contains the ledger entry's full details. The fields returned in this object vary based on the ledger entry group. The following lists each ledger entry group and the specific fields returned for each group. * Purchases and refunds: see the <> response fields. * Disputes: see the <> * Original credit transaction (OCT): see the <> fields. * Rewards: see the <> response fields. * Payments: see the <> response fields. * Balance refunds: see the <> response fields. * Adjustments: see the <> response fields. * Interest and fees: see fields below. type: object detail_token: description: Unique identifier of the ledger entry's full details. type: string group: description: Group to which the ledger entry belongs. enum: - PURCHASE - INTERNAL - FEE - REWARD - INTEREST - PAYMENT - ADJUSTMENT - BALANCE_TRANSFER - CASH_ADVANCE - BALANCE_REFUND - ORIGINAL_CREDIT type: string id: description: Eight-digit numeric identifier of the ledger entry, an alternate identifier to the UUID that is useful for remembering and referencing. maxLength: 8 minLength: 8 type: string impact_time: description: |- Date and time when the ledger entry impacts the account balance. For purchases, this is the time of the authorization. For purchase authorization clearings, this is the time when the transaction is settled. format: date-time type: string memo: description: Merchant name or description for the ledger entry. example: Whole Foods Market type: string original_currency: $ref: '#/components/schemas/OriginalCurrency' related_token: description: |- Unique identifier of the original ledger entry. If the current ledger entry is the original, this field is returned empty. type: string request_time: description: |- For purchases, the date and time of the authorization, which is when the user initiates the ledger entry. For other ledger entry groups, equivalent to `impact_time`. format: date-time type: string root_token: description: |- Unique identifier of the root ledger entry. If the current ledger entry is the root, this field is returned empty. type: string status: description: |- Status of the ledger entry when it was initially recorded and had an impact on the balance, either `PENDING` or `POSTED`. This field is immutable and may not represent the current status. To view the current status of purchases, refunds, OCTs, and payments, see the `detail_object.state` field. These journal entries start in `PENDING` and can transition to `CLEARED`, `DECLINED`, or `ERROR`. This transition of status is only sent through webhook event notifications. Ledger entries that are final transactions, such as clearings, start and remain in a `POSTED` state. *NOTE*: `CLEARED`, `DECLINED`, and `ERROR` are special statuses that do not have an impact on the account balance, and are not recorded in the ledger. For these special statuses, `impact_time`, `request_time`, `created_time`, `token`, and `id` are returned blank. enum: - PENDING - POSTED - DECLINED - ERROR - CLEARED type: string token: description: Unique identifier of the ledger entry. type: string type: description: Ledger entry event type. example: '`authorization.clearing`' type: string required: - account_token - amount - card_token - created_time - currency_code - detail_token - group - id - impact_time - memo - request_time - status - token - type type: object LinkedAccountBalanceResponse: properties: account_balance: type: number available_balance: type: number balance_iso_currency_code: type: string created_time: format: date-time type: string last_modified_time: format: date-time type: string processor_token: type: string type: object MCCConfig: properties: authorization_controls: $ref: '#/components/schemas/AuthControls' type: object MCCGroupListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/mcc_group_model' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object MaxAPRSchedulesResponse: properties: end_date: description: Date and time when the override APR ends, in UTC. format: date-time type: string reason: description: Reason for the override APR. enum: - SCRA - MLA - HARDSHIP type: string start_date: description: Date and time when the override APR goes into effect, in UTC. format: date-time type: string value: description: |- The APR percentage value. This is the value of the fixed rate during the override period. The APR value must adhere to the constraints of the main schedule, such as maximum allowable values. maximum: 100 minimum: 0 type: number required: - reason - start_date - value type: object MerchantGroupListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/merchant_group_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object MerchantScope: description: |- Defines the group of merchants to which the velocity control applies. If no fields are populated, the velocity control applies to all merchants. properties: attribute: description: |- Attribute value corresponding to the chosen scope. If 'mcc' is chosen, provide the Merchant Category Code (MCC). If 'mcc_group' is chosen, provide the token identifying a group of MCCs. type: string decline_other_merchants: default: false description: |- Indicates whether to decline transactions at merchants not included in the scope. If `true`, transactions at merchants not included in the scope will be declined. If `false`, transactions at merchants not included in the scope will not be declined. *Default value:* `false` type: boolean scope: description: |- Scope of the merchant category. Can be either 'mcc' or 'mcc_group'. enum: - mcc - mcc_group type: string type: object Method: description: |- Method, either a flat amount or a percentage. *NOTE:* Only `FLAT` is currently supported. enum: - PERCENTAGE - FLAT type: string MigrateDisputeInterestAdjustment: description: Represents an interest charge associated with (as of this writing) either a payment or dispute properties: amount: description: The fee amount. type: number currency_code: default: USD description: Valid three-digit link:https://www.iso.org/iso-4217-currency-codes.html[ISO 4217 currency code, window="_blank"]. enum: - USD type: string effective_date: description: Date and time when the dispute interest charge originally happened, in UTC. format: date-time type: string required: - amount - currency_code - effective_date type: object MigrationResponse: properties: success: type: boolean type: object MinOffset: properties: unit: description: specify if a value is provided; default is expiration_offset.unit enum: - YEARS - MONTHS - DAYS - HOURS - MINUTES - SECONDS type: string value: description: specify if unit is provided; default is expiration_offset.value format: int32 type: integer type: object OrderScope: description: Defines the scope of the AutoReload, either GPA or MSA properties: gpa: $ref: '#/components/schemas/gpa' msa: $ref: '#/components/schemas/msa' type: object OriginalCurrency: description: Original Currency properties: amount: description: original amount example: 2 type: number code: description: Currency code, such as EUR or USD. type: string type: object PTCAddress: properties: city: maxLength: 40 minLength: 1 type: string country: maxLength: 3 minLength: 3 type: string county: maxLength: 3 minLength: 3 type: string line1: maxLength: 255 minLength: 1 type: string line2: maxLength: 255 minLength: 0 type: string postal_code: type: string state: type: string required: - city - county - line1 - postal_code - state type: object PTCPhone: properties: country_code: type: string number: maxLength: 14 minLength: 4 type: string required: - number type: object PTCSoftDescriptor: properties: address: $ref: '#/components/schemas/PTCAddress' email: type: string name: maxLength: 50 minLength: 0 type: string phone: $ref: '#/components/schemas/PTCPhone' required: - address - name type: object PaymentAllocationOrderEnum: description: Ordered list of balance types to which payments are allocated, from first to last. enum: - INTEREST - FEES - PRINCIPAL type: string PaymentAllocationResponse: description: Object containing payment allocation information. properties: amount: description: Total amount of the payment allocation. minimum: 0 type: number bucket: description: Category to which a portion of the payment is allocated. enum: - PRINCIPAL - INTEREST - FEES type: string required: - amount - bucket type: object PaymentCreateReq: description: |- Object that is created when a user pays a portion or all of their statement balance. Applies to immediate payments only. Once the value is set to `ACTIVE`, it cannot be edited or deleted. properties: amount: description: Amount of the payment. minimum: 0 type: number currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the payment. maxLength: 255 type: string hold_days: description: Overrides the configured default number of days for which to hold ACH and check payments. maximum: 30 minimum: 0 type: integer impact_time: description: Date and time when the payment impacts the account balance and fee calculations. format: date-time type: string metadata: description: Customer-defined additional information about the payment (for example, a check number). maxLength: 255 type: string method: description: Method of payment. enum: - ACH - CHECK - DEBIT - CASH - SECURED_CARD type: string payment_source_token: description: Unique identifier of the payment source. Required for ACH payments. maxLength: 36 type: string token: description: Unique identifier of the payment. maxLength: 36 pattern: (?!^ +$)^.+$ type: string required: - amount - currency_code - description - method type: object PaymentDetailResponse: description: Response containing payment details with transition history. properties: account_token: description: Unique identifier of the credit account on which the payment is made. maxLength: 36 type: string allocations: description: List of objects that contain information about how a payment is allocated. items: $ref: '#/components/schemas/PaymentAllocationResponse' type: array amount: description: Total amount of the payment. minimum: 0 type: number created_time: description: Date and time when the payment was created on Marqeta's credit platform, in UTC. format: date-time type: string currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the payment. type: string hold_days: default: 0 description: After a payment completes, the number of days to hold the available credit on the account before increasing it. type: integer hold_end_time: description: Date and time when the available credit hold is released. format: date-time type: string is_manually_released: default: false description: Whether the available credit hold was manually released for this payment. type: boolean metadata: description: Customer-defined additional information about the payment (for example, a check number). type: string method: description: Method of payment. enum: - ACH - CHECK - DEBIT - CASH - SECURED_CARD type: string on_hold: default: false description: Whether the available credit is on hold for this payment. type: boolean payment_schedule_token: description: Unique identifier of the payment schedule. type: string payment_source_token: description: |- Unique identifier of the payment source. Required for ACH payments. type: string program_migration_time: description: |- Date and time when the statement summary was migrated to Marqeta's credit platform, in UTC. The value of this field is `null` if it has not been migrated. format: date-time type: string refund_details: $ref: '#/components/schemas/RefundDetailsResponse' returned_details: $ref: '#/components/schemas/ReturnedDetails' status: $ref: '#/components/schemas/PaymentStatus' token: description: |- Unique identifier of the payment. If in the `detail_object`, unique identifier of the detail object. type: string transitions: description: Contains one or more `transitions` objects, which contain information about a payment status transition. items: $ref: '#/components/schemas/PaymentTransitionResponse' type: array updated_time: description: Date and time when the payment was last updated on Marqeta's credit platform, in UTC. format: date-time type: string waive_returned_payment_fee: description: |- A value of `true` indicates that a returned payment fee should not be applied. The default value of this field is `false`. This field is only considered when transitioning the status of the fee to `REFUNDED`. type: boolean required: - account_token - amount - created_time - currency_code - description - hold_days - method - status - token - transitions - updated_time type: object PaymentReminderPage: description: Return payment reminders. properties: count: description: Number of resources returned. type: integer data: description: Contains payment reminders on a credit account statement. Can be zero if none exist for the given statement. items: $ref: '#/components/schemas/PaymentReminderResponse' minItems: 1 type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object PaymentReminderResponse: description: Details of a payment reminder. properties: account_token: description: Token of the associated account. type: string created_time: description: Date and time when the Billing Cycle was created on Marqeta's credit platform format: date-time type: string days_until_due: description: Days until payment cutoff date type: integer payment_cutoff_date: description: Last day a payment can be made before interest and fees are charged to the account. format: date-time type: string payment_due_date: description: Payment due date, based on the credit account settings. format: date-time type: string remaining_minimum_payment_due: description: Amount remaining on the latest statement's minimum payment, after it's adjusted for payments, returned payments, and applicable credits that occurred after the latest statement's closing date. type: number statement_summary_token: description: Token of the associated statement summary format: uuid type: string token: description: Token of the payment reminder type: string type: object PaymentScheduleAmountCategory: description: A category used to determine the actual payment amount. enum: - FIXED - MINIMUM_PAYMENT - REMAINING_STATEMENT_BALANCE - CURRENT_BALANCE type: string PaymentScheduleCreateReq: description: Information to create a payment schedule. properties: amount: description: |- Amount of the payment. Required if `amount_category` is `FIXED`. type: number amount_category: $ref: '#/components/schemas/PaymentScheduleAmountCategory' currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the payment schedule. maxLength: 255 type: string frequency: $ref: '#/components/schemas/PaymentScheduleFrequency' next_payment_impact_date: description: |- Date to make a one-time payment. Required if frequency is `ONCE`. format: date type: string payment_day: description: |- Day on which monthly payments are made. Required if `frequency` is `MONTHLY`. enum: - PAYMENT_DUE_DAY type: string payment_source_token: description: Unique identifier of the payment source. maxLength: 36 type: string token: description: Unique identifier of the payment schedule. maxLength: 36 pattern: (?!^ +$)^.+$ type: string required: - amount_category - currency_code - frequency - payment_source_token type: object PaymentScheduleFrequency: description: Defines how often to make a scheduled payment. enum: - ONCE - MONTHLY type: string PaymentSchedulePage: description: Returns paginated information for multiple payment schedules. properties: count: description: Number of resources returned. type: integer data: description: List of payment schedules. items: $ref: '#/components/schemas/PaymentScheduleResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object PaymentScheduleResponse: description: A future one-time or recurring payment schedule. properties: account_token: description: Unique identifier of the credit account on which the payment schedule is made. type: string amount: description: |- Amount of the payment. Returned if the `amount_category` is `FIXED`. nullable: true type: number amount_category: $ref: '#/components/schemas/PaymentScheduleAmountCategory' created_time: description: Date and time when the payment schedule was created on Marqeta's credit platform, in UTC. format: date-time type: string currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the payment schedule. type: string frequency: $ref: '#/components/schemas/PaymentScheduleFrequency' next_payment_impact_date: description: |- Date to make a one-time payment. Returned if `frequency` is `ONCE`. format: date type: string payment_day: description: |- Day on which monthly payments are made. Returned if the `frequency` is `MONTHLY`. enum: - PAYMENT_DUE_DAY type: string payment_source_token: description: Unique identifier of a payment source. type: string status: $ref: '#/components/schemas/PaymentScheduleStatus' token: description: Unique identifier of the payment schedule. type: string updated_time: description: Date and time when the payment schedule was last updated on Marqeta's credit platform, in UTC. format: date-time type: string required: - account_token - amount_category - currency_code - frequency - payment_source_token - status - token type: object PaymentScheduleStatus: description: Status of the payment schedule. enum: - ACTIVE - COMPLETED - TERMINATED type: string PaymentScheduleTransitionCreateReq: description: Details to create a payment schedule transition properties: status: $ref: '#/components/schemas/PaymentScheduleStatus' token: description: Unique identifier of the payment schedule transition. maxLength: 36 type: string required: - status type: object PaymentScheduleTransitionPage: description: Returns paginated information for multiple payment schedule transitions. properties: count: description: Number of resources returned. type: integer data: description: List of payment schedule transitions. items: $ref: '#/components/schemas/PaymentScheduleTransitionResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object PaymentScheduleTransitionResponse: description: A payment schedule transition on a credit account. properties: account_token: description: |- Unique identifier of the credit account on which to transition a payment schedule. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. type: string created_time: description: Date and time when the payment schedule transition was created on Marqeta's credit platform, in UTC. format: date-time type: string payment_schedule_token: description: |- Unique identifier of the payment schedule whose status is to transition. Send a `GET` request to `/credit/accounts/{account_token}/paymentschedules` to retrieve existing payment schedule tokens. type: string status: $ref: '#/components/schemas/PaymentScheduleStatus' token: description: Unique identifier of the payment schedule transition. type: string updated_time: description: Date and time when the payment schedule transition was last updated on Marqeta's credit platform, in UTC. format: date-time type: string type: object PaymentSourceCreateReq: description: Contains information about a payment source. properties: account_number: description: Account number of the payment source. For Secured Card, this is the secured card account number. maxLength: 255 type: string account_token: description: Unique identifier of the credit account receiving the payment. maxLength: 36 type: string bank_name: description: Name of the bank associated with the routing number. maxLength: 255 nullable: true type: string business_token: description: Unique identifier of the business making the payment. maxLength: 36 type: string metadata: additionalProperties: type: string description: Optional key-value pairs for storing additional information about the payment source. type: object name: description: Name of the individual or business who owns the payment source. maxLength: 255 type: string owner: description: Type of payment source owner. enum: - INDIVIDUAL - BUSINESS type: string routing_number: description: |- Routing number of the payment source. This field is only optional when the value for `source_type` is `SECURED_ACCOUNT_FUND`. maxLength: 255 type: string source_type: description: Type of payment source. enum: - CHECKING - SAVINGS - SECURED_ACCOUNT_FUND - OTHER - EXTERNAL type: string token: description: Unique identifier of the payment source. pattern: (?!^ +$)^.+$ type: string user_token: description: Unique identifier of the user making the payment. maxLength: 36 type: string verification_notes: description: Additional information on the verification. maxLength: 255 type: string verification_override: description: Whether to override the verification process. type: boolean required: - account_number - account_token - name - source_type - verification_override type: object PaymentSourcePage: description: Returns paginated information for multiple payment sources. properties: count: description: Number of resources returned. type: integer data: description: List of payment sources. items: $ref: '#/components/schemas/PaymentSourceResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object PaymentSourceResponse: description: Contains information about a payment source. properties: account_suffix: description: Last four digits of the payment source account number. maxLength: 4 type: string account_token: description: Unique identifier of the credit account receiving the payment. maxLength: 36 type: string bank_name: description: Name of the bank associated with the routing number. nullable: true type: string business_token: description: Unique identifier of the business making the payment. type: string created_time: description: Date and time when the payment source was created on Marqeta's credit platform, in UTC. format: date-time type: string last_modified_time: description: Date and time when the payment source was last updated on Marqeta's credit platform, in UTC. format: date-time type: string metadata: additionalProperties: type: string description: Optional key-value pairs for storing additional information about the payment source. type: object name: description: Name of the individual or business who owns the payment source. type: string owner: description: Type of payment source owner. enum: - INDIVIDUAL - BUSINESS type: string routing_number: description: Routing number of the payment source. type: string source_type: description: Type of payment source. enum: - CHECKING - SAVINGS - SECURED_ACCOUNT_FUND - OTHER - EXTERNAL type: string status: $ref: '#/components/schemas/PaymentSourceStatusEnum' token: description: Unique identifier of the payment source. type: string user_token: description: Unique identifier of the user making the payment. type: string verification_notes: description: Additional information on the verification (for example, an external verification identifier that's outside Marqeta's credit platform). type: string verification_status: description: Status of the verification for the payment source. enum: - ACH_VERIFIED - PENDING type: string type: object PaymentSourceStatusEnum: description: Current status of the payment source. enum: - ACTIVE - PENDING - INACTIVE type: string PaymentSourceUpdateReq: description: Request used to update the status of a payment source. properties: status: $ref: '#/components/schemas/PaymentSourceStatusEnum' required: - status type: object PaymentStatus: description: Current status of the payment or refund. enum: - INITIATED - PENDING - PROCESSING - SUBMITTED - CANCELLED - COMPLETED - RETURNED - REFUNDED - SYS_ERROR - ACH_ERROR type: string PaymentTransitionReq: description: Request used to transition the status of a payment. properties: refund_details: $ref: '#/components/schemas/RefundDetails' status: $ref: '#/components/schemas/PaymentStatus' token: description: Unique identifier of the payment status transition. maxLength: 36 type: string waive_returned_payment_fee: description: A value of `true` indicates that a returned payment fee should not be applied if one is applicable. This is false by default. This field is only considered during a transition to either `REFUNDED` or `RETURNED` type: boolean required: - status type: object PaymentTransitionResponse: description: Response containing payment transition information. properties: account_token: description: Unique identifier of the credit account on which you want to transition a payment status. type: string created_time: description: Date and time when the payment transition was created on Marqeta's credit platform, in UTC. format: date-time type: string payment_token: description: Unique identifier of the payment whose status you want to transition. type: string status: $ref: '#/components/schemas/PaymentStatus' token: description: Unique identifier of the payment status transition. type: string required: - account_token - payment_token - status - token type: object PaymentsPage: description: Returns paginated payments properties: count: description: Number of resources returned. type: integer data: description: Contains one or more payments on a credit account. items: $ref: '#/components/schemas/PaymentDetailResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object PeriodicFeeSchedule: description: periodic fee schedules on account properties: amount: description: fee amount type: number effective_date: description: date the fee becomes effective format: date type: string next_fee_impact_date: description: date of the next time fee will be charged format: date type: string type: description: type of fee to be charged enum: - ANNUAL_FEE - MONTHLY_FEE type: string type: object PeriodicFeeSchedulePage: description: Return paginated periodic fee schedules on a credit account. properties: count: description: Number of resources returned. type: integer data: description: List of account periodic fee schedules. items: $ref: '#/components/schemas/PeriodicFeeSchedule' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object PoliciesDocumentPage: description: List response details for paginated document policies. properties: count: description: Number of resources returned. type: integer data: description: One or more document policies. items: $ref: '#/components/schemas/PolicyDocumentResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object PoliciesProductPage: description: List response details for product policies. properties: count: description: Number of resources returned. type: integer data: description: One or more credit product policies. items: $ref: '#/components/schemas/PolicyProductResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object PolicyAprCreateReq: description: Request details for an APR policy. properties: description: description: Description of the APR policy. type: string name: description: Name of the APR policy. type: string purchases: $ref: '#/components/schemas/PolicyAprPurchaseReq' token: description: Unique identifier of the APR policy. pattern: (?!^ +$)^.+$ type: string required: - name - purchases type: object PolicyAprPurchaseReq: description: Contains information on the pricing strategy for purchases. properties: external_token: description: Unique identifier of the external pricing strategy for the credit program. pattern: (?!^ +$)^.+$ type: string name: description: Name of the pricing strategy. type: string tiers: description: One or more risk tiers for a pricing strategy. items: $ref: '#/components/schemas/PolicyAprTierReq' type: array required: - tiers type: object PolicyAprPurchaseResponse: description: Contains information on the pricing strategy for purchases. properties: external_token: description: Unique identifier of the pricing strategy on a credit program. pattern: (?!^ +$)^.+$ type: string name: description: Name of the pricing strategy. type: string tiers: description: One or more risk tiers for a pricing strategy. items: $ref: '#/components/schemas/PolicyAprTierResponse' type: array type: object PolicyAprResponse: description: Contains information on an APR policy. properties: created_time: description: Date and time when the APR policy was created on Marqeta's credit platform, in UTC. format: date-time type: string description: description: Description of the APR policy. type: string effective_date: description: Date the APR goes into effect, in UTC. format: date type: string name: description: Name of the APR policy. type: string purchases: $ref: '#/components/schemas/PolicyAprPurchaseResponse' token: description: Unique identifier of the APR policy. pattern: (?!^ +$)^.+$ type: string updated_time: description: Date and time when the APR policy was last updated on Marqeta's credit platform, in UTC. format: date-time type: string type: object PolicyAprTierReq: description: Request details for the APR for a risk tier. properties: margin_rate: description: Number of percentage points added to the prime rate, used to calculate a variable APR value. type: number required: - margin_rate type: object PolicyAprTierResponse: description: Response details for the APR for a risk tier. properties: apr: default: 0 description: Value of the APR. type: number margin_rate: description: Margin rate for the risk tier for a pricing strategy. type: number type: object PolicyAprUpdateReq: description: Request details for an APR policy. properties: description: description: Description of the APR policy. type: string name: description: Name of the APR policy. type: string purchases: $ref: '#/components/schemas/PolicyAprPurchaseReq' token: description: Unique identifier of the APR policy. pattern: (?!^ +$)^.+$ type: string required: - name type: object PolicyAprsPage: description: List response details for paginated APR policies. properties: count: description: Number of resources returned. type: integer data: description: One or more APR policies. items: $ref: '#/components/schemas/PolicyAprResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object PolicyDocumentAssetAndTemplateReq: description: Request details for a specific asset and the template on which it was based. properties: asset_token: description: |- Unique identifier of the asset, which is the version of a document that is based on the template and contains finalized values. The values are finalized when the bundle containing the document is created. pattern: (?!^ +$)^.+$ type: string template_token: description: |- Unique identifier of the template, which is the version of a document that serves as an initial disclosure but does not contain finalized values. The values are finalized in the asset version of the document. pattern: (?!^ +$)^.+$ type: string required: - asset_token - template_token type: object PolicyDocumentAssetAndTemplateResponse: description: Return details for a specific asset and the template on which it was based. properties: asset_created_time: description: Date and time when the asset was created. format: date-time type: string asset_token: description: |- Unique identifier of the asset, which is the version of a document that is based on the template and contains finalized values. The values are finalized when the bundle containing the document is created. type: string asset_urls: $ref: '#/components/schemas/PolicyDocumentAssetURLs' template_created_time: description: Date and time when the template was created. format: date-time type: string template_token: description: |- Unique identifier of the template, which is the version of a document that serves as an initial disclosure but does not contain finalized values. Values are finalized in the asset version of the document. type: string template_urls: $ref: '#/components/schemas/PolicyDocumentTemplateURLs' type: object PolicyDocumentAssetReq: description: Request details for a specific asset. properties: asset_token: description: |- Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created. pattern: (?!^ +$)^.+$ type: string required: - asset_token type: object PolicyDocumentAssetResponse: description: Return details for a specific asset. properties: asset_created_time: description: Date and time when the asset was created. format: date-time type: string asset_token: description: |- Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created. pattern: (?!^ +$)^.+$ type: string asset_urls: $ref: '#/components/schemas/PolicyDocumentAssetURLs' type: object PolicyDocumentAssetURLs: description: Contains one or more URLs for an asset. properties: html: description: URL to the HTML version of the asset. type: string pdf: description: URL to the PDF version of the asset. type: string png: description: URL to the PNG version of the asset. type: string required: - html - pdf - png type: object PolicyDocumentCreateReq: description: Contains information on a document policy. properties: account_statement: $ref: '#/components/schemas/PolicyDocumentTemplateReq' benefits_disclosure_premium: $ref: '#/components/schemas/PolicyDocumentAssetReq' benefits_disclosure_traditional: $ref: '#/components/schemas/PolicyDocumentAssetReq' card_member_agreement: $ref: '#/components/schemas/PolicyDocumentAssetReq' e_disclosure: $ref: '#/components/schemas/PolicyDocumentAssetReq' name: description: Name of the document policy. pattern: (?!^ +$)^.+$ type: string noaa_multiple_reason_with_dodd_frank: $ref: '#/components/schemas/PolicyDocumentTemplateReq' noaa_single_reason: $ref: '#/components/schemas/PolicyDocumentTemplateReq' noaa_single_reason_with_dodd_frank: $ref: '#/components/schemas/PolicyDocumentTemplateReq' pre_qualification_disclosure: $ref: '#/components/schemas/PolicyDocumentAssetAndTemplateReq' privacy_policy: $ref: '#/components/schemas/PolicyDocumentAssetReq' rewards_disclosure: $ref: '#/components/schemas/PolicyDocumentAssetAndTemplateReq' summary_of_credit_terms: $ref: '#/components/schemas/PolicyDocumentAssetAndTemplateReq' terms_schedule: $ref: '#/components/schemas/PolicyDocumentTemplateReq' token: description: Unique identifier of the document policy. pattern: (?!^ +$)^.+$ type: string required: - account_statement - benefits_disclosure_premium - benefits_disclosure_traditional - card_member_agreement - e_disclosure - name - noaa_multiple_reason_with_dodd_frank - noaa_single_reason - noaa_single_reason_with_dodd_frank - privacy_policy - summary_of_credit_terms - terms_schedule type: object PolicyDocumentResponse: description: Contains information on a document policy. properties: account_statement: $ref: '#/components/schemas/PolicyDocumentTemplateResponse' benefits_disclosure_premium: $ref: '#/components/schemas/PolicyDocumentAssetResponse' benefits_disclosure_traditional: $ref: '#/components/schemas/PolicyDocumentAssetResponse' card_member_agreement: $ref: '#/components/schemas/PolicyDocumentAssetResponse' created_time: description: Date and time when the document policy was created on Marqeta's credit platform, in UTC. format: date-time type: string e_disclosure: $ref: '#/components/schemas/PolicyDocumentAssetResponse' name: description: Name of the document policy. pattern: (?!^ +$)^.+$ type: string noaa_multiple_reason_with_dodd_frank: $ref: '#/components/schemas/PolicyDocumentTemplateResponse' noaa_single_reason: $ref: '#/components/schemas/PolicyDocumentTemplateResponse' noaa_single_reason_with_dodd_frank: $ref: '#/components/schemas/PolicyDocumentTemplateResponse' pre_qualification_disclosure: $ref: '#/components/schemas/PolicyDocumentAssetAndTemplateResponse' privacy_policy: $ref: '#/components/schemas/PolicyDocumentAssetResponse' rewards_disclosure: $ref: '#/components/schemas/PolicyDocumentAssetAndTemplateResponse' summary_of_credit_terms: $ref: '#/components/schemas/PolicyDocumentAssetAndTemplateResponse' terms_schedule: $ref: '#/components/schemas/PolicyDocumentTemplateResponse' token: description: Unique identifier of the document policy. pattern: (?!^ +$)^.+$ type: string updated_time: description: Date and time when the document policy was last updated on Marqeta's credit platform, in UTC. format: date-time type: string type: object PolicyDocumentTemplateReq: description: Request details for a template. properties: template_token: description: Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values. pattern: (?!^ +$)^.+$ type: string required: - template_token type: object PolicyDocumentTemplateResponse: description: Response details for a template. properties: template_created_time: description: Date and time when the template was created. format: date-time type: string template_token: description: Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values. type: string template_urls: $ref: '#/components/schemas/PolicyDocumentTemplateURLs' type: object PolicyDocumentTemplateURLs: description: Contains one or more URLs for a template. properties: html: description: URL to the HTML version of the document template. type: string required: - html type: object PolicyDocumentUpdateReq: description: Request details to update a document policy. properties: account_statement: $ref: '#/components/schemas/PolicyDocumentTemplateReq' benefits_disclosure_premium: $ref: '#/components/schemas/PolicyDocumentAssetReq' benefits_disclosure_traditional: $ref: '#/components/schemas/PolicyDocumentAssetReq' card_member_agreement: $ref: '#/components/schemas/PolicyDocumentAssetReq' e_disclosure: $ref: '#/components/schemas/PolicyDocumentAssetReq' name: description: Name of the document policy. pattern: (?!^ +$)^.+$ type: string noaa_multiple_reason_with_dodd_frank: $ref: '#/components/schemas/PolicyDocumentTemplateReq' noaa_single_reason: $ref: '#/components/schemas/PolicyDocumentTemplateReq' noaa_single_reason_with_dodd_frank: $ref: '#/components/schemas/PolicyDocumentTemplateReq' pre_qualification_disclosure: $ref: '#/components/schemas/PolicyDocumentAssetAndTemplateReq' privacy_policy: $ref: '#/components/schemas/PolicyDocumentAssetReq' rewards_disclosure: $ref: '#/components/schemas/PolicyDocumentAssetAndTemplateReq' summary_of_credit_terms: $ref: '#/components/schemas/PolicyDocumentAssetAndTemplateReq' terms_schedule: $ref: '#/components/schemas/PolicyDocumentTemplateReq' required: - account_statement - benefits_disclosure_premium - benefits_disclosure_traditional - card_member_agreement - e_disclosure - name - noaa_multiple_reason_with_dodd_frank - noaa_single_reason - noaa_single_reason_with_dodd_frank - privacy_policy - summary_of_credit_terms - terms_schedule type: object PolicyFeeAccount: description: Contains information on the fees in an account's fee policy. properties: annual_fee: $ref: '#/components/schemas/PolicyFeePeriodic' foreign_transaction_fee: $ref: '#/components/schemas/PolicyFeeForeignTransaction' late_payment: $ref: '#/components/schemas/PolicyFeePayment' monthly_fee: $ref: '#/components/schemas/PolicyFeePeriodic' returned_payment: $ref: '#/components/schemas/PolicyFeePayment' type: object PolicyFeeCreateReq: description: Request details for a fee policy. properties: account: $ref: '#/components/schemas/PolicyFeeAccount' description: description: Description of the fee policy. type: string name: description: Name of the fee policy. type: string token: description: Unique identifier of the fee policy. pattern: (?!^ +$)^.+$ type: string required: - account - name type: object PolicyFeeForeignTransaction: description: Contains information on a specific fee in a fee policy. properties: default_method: description: Method used to calculate the fee value. enum: - PERCENTAGE type: string default_value: description: Percentage value for the foreign transaction fee. minimum: 0 type: number type: object PolicyFeePayment: description: Contains information on a specific fee in a fee policy. properties: default_method: description: Method used to calculate the fee value. enum: - FLAT type: string default_value: description: Amount of the fee. type: number type: object PolicyFeePeriodic: description: Contains information on a specific periodic fee in a fee policy. properties: exclude_from_interest_calc: description: Whether the periodic fee is excluded from interest calculation. type: boolean fee_amount: description: Amount of the fee. maximum: 5000 minimum: 1 type: number number_of_days_post_activation: description: |- Number of days after an account is activated that the initial fee is charged. For example, if the value in this field is `30`, then the initial fee is charged 30 days after an account is activated. maximum: 1000 minimum: 1 type: number type: object PolicyFeeResponse: description: Contains information on a fee policy. properties: account: $ref: '#/components/schemas/PolicyFeeAccount' created_time: description: Date and time when the fee policy was created on Marqeta's credit platform, in UTC. format: date-time type: string description: description: Description of the fee policy. type: string name: description: Name of the fee policy. type: string token: description: Unique identifier of the fee policy. pattern: (?!^ +$)^.+$ type: string updated_time: description: Date and time when the fee policy was last updated on Marqeta's credit platform, in UTC. format: date-time type: string type: object PolicyFeeUpdateReq: description: Response details to update a fee policy. properties: account: $ref: '#/components/schemas/PolicyFeeAccount' description: description: Description of the fee policy. type: string name: description: Name of the fee policy. type: string periodic: $ref: '#/components/schemas/PolicyFeePeriodic' required: - name type: object PolicyFeesPage: description: List response details for fee policies. properties: count: description: Number of resources returned. type: integer data: description: One or more fee policies. items: $ref: '#/components/schemas/PolicyFeeResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object PolicyOfferResponse: description: Contains information on an offer policy. properties: created_time: description: Date and time when the offer policy was created on Marqeta's credit platform, in UTC. format: date-time type: string description: description: Description of the offer policy. type: string name: description: Name of the offer policy. type: string token: description: Unique identifier of the offer policy. pattern: (?!^ +$)^.+$ type: string updated_time: description: Date and time when the offer policy was last updated on Marqeta's credit platform, in UTC. format: date-time type: string type: object PolicyProductCardProductLevel: description: Level of the card product. enum: - PREMIUM - TRADITIONAL type: string PolicyProductCardProductReq: description: Contains information on the card products associated with the credit product policy. properties: level: $ref: '#/components/schemas/PolicyProductCardProductLevel' token: description: Unique identifier of the card product. pattern: (?!^ +$)^.+$ type: string required: - level - token type: object PolicyProductCardProductResponse: description: Contains information on the card products associated with the credit product policy. properties: level: $ref: '#/components/schemas/PolicyProductCardProductLevel' network: description: Name of the card network. enum: - VISA - MASTERCARD - SANDBOX type: string token: description: Unique identifier of the card product. pattern: (?!^ +$)^.+$ type: string type: object PolicyProductCreateReq: description: Request details for a credit product policy. properties: card_products: description: One or more card products associated with the credit product policy. items: $ref: '#/components/schemas/PolicyProductCardProductReq' minItems: 1 type: array classification: $ref: '#/components/schemas/ProductClassification' credit_line: $ref: '#/components/schemas/ProductCreditLine' currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the credit product policy. type: string interest_calculation: $ref: '#/components/schemas/InterestCalculation' name: description: Name of the credit product policy. minLength: 1 type: string payments: $ref: '#/components/schemas/PolicyProductPaymentConfiguration' product_sub_type: $ref: '#/components/schemas/ProductSubType' product_type: $ref: '#/components/schemas/ProductType' token: description: Unique identifier of the credit product policy. pattern: (?!^ +$)^.+$ type: string usage: description: One or more usage types for the credit product policy. items: $ref: '#/components/schemas/BalanceType' minItems: 1 type: array required: - card_products - classification - credit_line - currency_code - interest_calculation - name - payments - product_sub_type - product_type - usage type: object PolicyProductMinPaymentCalculation: description: Contains information used to calculate the minimum payment amount on a credit product policy. properties: include_overlimit_amount: description: Whether to include the overlimit amount when calculating the minimum payment. type: boolean include_past_due_amount: description: Whether to include the past due amount when calculating the minimum payment. type: boolean min_payment_flat_amount: description: Minimum payment, expressed as a flat amount, due on the payment due day. type: number min_payment_percentage: $ref: '#/components/schemas/PolicyProductMinPaymentPercentage' required: - include_overlimit_amount - include_past_due_amount type: object PolicyProductMinPaymentPercentage: description: Contains information used to calculate the minimum payment amount when expressed as a percentage. properties: include_all_fees_charged: description: Whether to include all fees charged when calculating the minimum payment. type: boolean include_interest_charged: description: Whether to include the amount of interest charged when calculating the minimum payment. type: boolean percentage_of_balance: description: Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day. maximum: 100 minimum: 1.0E-4 type: number required: - include_interest_charged - percentage_of_balance type: object PolicyProductPaymentConfiguration: description: Contains the configurations for billing cycle day, payment due day, and fees. properties: allocation_order: default: - INTEREST - FEES - PRINCIPAL description: Ordered list of balance types to which payments are allocated, from first to last. items: $ref: '#/components/schemas/PaymentAllocationOrderEnum' minItems: 1 type: array billing_cycle_day: description: Day of the month when the billing cycle starts. maximum: 28 minimum: 1 type: integer billing_cycle_day_strategy: default: MANUAL description: Determines if the billing cycle day is manually set or determined dynamically during account creation based on cycling logic. enum: - MANUAL type: string billing_cycle_frequency: default: MONTHLY description: Frequency at which the account is billed. enum: - MONTHLY type: string due_day: deprecated: true description: |- Day of month the payment for the previous billing cycle is due. This field is being deprecated and replaced by `payment_due_interval` of a product policy. To retrieve `payment_due_interval`, see <>. maximum: 31 minimum: 31 type: integer min_payment_calculation: $ref: '#/components/schemas/PolicyProductMinPaymentCalculation' payment_due_interval: default: -1 description: |- Specifies the payment due interval that is used to determine the payment due date for a billing cycle. A value of -1 indicates one day prior to the next billing cycle date. For consumer programs, a minimum gap of 21 days is required between when a statement is delivered and the payment due date. minimum: -1 type: integer required: - allocation_order - billing_cycle_day - min_payment_calculation type: object PolicyProductResponse: description: Contains information on the credit product policy. properties: card_products: description: One or more card products associated with the credit product policy. items: $ref: '#/components/schemas/PolicyProductCardProductResponse' minItems: 1 type: array classification: $ref: '#/components/schemas/ProductClassification' created_time: description: Date and time when the credit product policy was created on Marqeta's credit platform, in UTC. format: date-time type: string credit_line: $ref: '#/components/schemas/ProductCreditLine' currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the credit product policy. type: string interest_calculation: $ref: '#/components/schemas/InterestCalculation' name: description: Name of the credit product policy. minLength: 1 type: string payments: $ref: '#/components/schemas/PolicyProductPaymentConfiguration' product_sub_type: $ref: '#/components/schemas/ProductSubType' product_type: $ref: '#/components/schemas/ProductType' token: description: Unique identifier of the credit product policy. pattern: (?!^ +$)^.+$ type: string updated_time: description: Date and time when the credit product policy was last updated on Marqeta's credit platform, in UTC. format: date-time type: string usage: description: One or more usage types for the credit product policy. items: $ref: '#/components/schemas/BalanceType' minItems: 1 type: array type: object PolicyProductUpdateReq: description: Request details to update a credit product policy. properties: card_products: description: One or more card products associated with the credit product policy. items: $ref: '#/components/schemas/PolicyProductCardProductReq' minItems: 1 type: array classification: $ref: '#/components/schemas/ProductClassification' credit_line: $ref: '#/components/schemas/ProductCreditLine' currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the credit product policy. type: string interest_calculation: $ref: '#/components/schemas/InterestCalculation' name: description: Name of the credit product policy. minLength: 1 pattern: (?!^ +$)^.+$ type: string payments: $ref: '#/components/schemas/PolicyProductPaymentConfiguration' product_sub_type: $ref: '#/components/schemas/ProductSubType' product_type: $ref: '#/components/schemas/ProductType' usage: description: One or more usage types for the credit product policy. items: $ref: '#/components/schemas/BalanceType' minItems: 1 type: array required: - card_products - classification - credit_line - currency_code - interest_calculation - name - payments - product_sub_type - product_type - usage type: object PolicyRewardAccrualType: default: DEFAULT description: |- Reward accrual strategy for a credit program. If no value for `accrual_strategy` is set, the default value of this field is `DEFAULT`. enum: - DEFAULT - PAYMENT type: string PolicyRewardConversion: description: Defines the conversion properties intended for a reward policy. properties: conversion_increment: description: The static amount to reward if the rule conditions are met. type: integer conversion_rate: description: The rate that points are worth with converting the REDEMPTION_TYPE indicated. format: decimal minimum: 0.001 type: number currency: description: Type of currency used with the conversion rate. type: string type: $ref: '#/components/schemas/PolicyRewardConversionType' required: - conversion_increment - conversion_rate - type type: object PolicyRewardConversionType: description: Type of conversion. enum: - STATEMENT_CREDIT type: string PolicyRewardExclusions: description: |- Defines what merchant category codes (MCCs) are excluded from earning rewards. MCCs must be a four-digit number, or a range of two four-digit numbers separated by a hyphen. properties: custom_exclusions: description: |- List of merchant category codes (MCCs). MCCs must be a four-digit number, or a range of two four-digit numbers separated by a hyphen. items: type: string type: array use_default_exclusions: description: |- Indicates whether to use the default exclusion list. * If `true`, the default exclusion list is used. * If `false`, the custom exclusion list is used, if custom exclusions are included. type: boolean type: object PolicyRewardPage: description: List of response details for reward policies. properties: count: description: Number of resources returned. type: integer data: description: List of one or more reward policies. items: $ref: '#/components/schemas/PolicyRewardResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object PolicyRewardPlatformRule: description: Defines the rules intended for a reward policy. properties: amount: description: The static amount to reward if the rule conditions are met. nullable: true type: number attributes: $ref: '#/components/schemas/PolicyRewardRuleAttributes' calculation_type: description: Type of calculation to use to evaluate if a rule has been satisfied. enum: - PER_TRANSACTION - SPEND_BALANCE type: string description: description: The description of the rule. type: string multiplier: description: The reward multiplier to apply the transaction, where '1' means 1x transaction amount. format: float nullable: true type: number type: description: Type of rule. enum: - MULTIPLIER_PER_TRANSACTION - SIGNUP_BONUS type: string required: - description - type type: object PolicyRewardRedemptionStrategy: default: MANUAL description: |- Redemption strategy for reward redemption behavior. If no value for `redemption_strategy` is set, then the default value of this field is `MANUAL`. Available options: * `AUTO`: Automatically redeem rewards when conditions are met. * `MANUAL`: Require manual intervention for reward redemption (default). enum: - AUTO - MANUAL type: string PolicyRewardReq: description: Request details for a reward policy. properties: accrual_strategy: $ref: '#/components/schemas/PolicyRewardAccrualType' conversions: description: List of one or more reward conversions. items: $ref: '#/components/schemas/PolicyRewardConversion' minItems: 1 type: array description: description: Description of the reward policy. type: string exclusions: $ref: '#/components/schemas/PolicyRewardExclusions' name: description: Name of the reward policy. pattern: (?!^ +$)^.+$ type: string redemption_strategy: $ref: '#/components/schemas/PolicyRewardRedemptionStrategy' rounding_strategy: $ref: '#/components/schemas/PolicyRewardRoundingStrategy' rules: description: List of one or more reward rules. items: $ref: '#/components/schemas/PolicyRewardPlatformRule' minItems: 1 type: array settlement_strategy: $ref: '#/components/schemas/PolicyRewardSettlementType' token: description: Unique identifier of the reward policy. pattern: (?!^ +$)^.+$ type: string required: - conversions - exclusions - name - rules - settlement_strategy type: object PolicyRewardResponse: description: Contains information on a reward policy. properties: accrual_strategy: $ref: '#/components/schemas/PolicyRewardAccrualType' conversions: description: List of one or more reward conversions. items: $ref: '#/components/schemas/PolicyRewardConversion' minItems: 1 type: array created_time: description: Date and time when the reward policy was created on Marqeta's credit platform, in UTC. format: date-time type: string description: description: Description of the reward policy. type: string exclusions: $ref: '#/components/schemas/PolicyRewardExclusions' name: description: Name of the reward policy. type: string redemption_strategy: $ref: '#/components/schemas/PolicyRewardRedemptionStrategy' rounding_strategy: $ref: '#/components/schemas/PolicyRewardRoundingStrategy' rules: description: A list of one or more reward rules. items: $ref: '#/components/schemas/PolicyRewardPlatformRule' minItems: 1 type: array settlement_strategy: $ref: '#/components/schemas/PolicyRewardSettlementType' token: description: Unique identifier of the reward policy. pattern: (?!^ +$)^.+$ type: string updated_time: description: Date and time when the reward policy was last updated on Marqeta's credit platform, in UTC. format: date-time type: string type: object PolicyRewardRoundingStrategy: default: ROUND_HALF_EVEN description: |- Rounding strategy for reward accrual calculations. If no value for `rounding_strategy` is set, then the default value of this field is `ROUND_HALF_EVEN`. Available options: * `ROUND_UP`: Always rounds away from zero to whole numbers. * `ROUND_DOWN`: Always rounds towards zero to whole numbers. * `ROUND_HALF_EVEN`: Rounds to two decimal places using half-even logic (default). * `ROUND_HALF_EVEN_WHOLE`: Rounds to whole numbers using half-even logic. enum: - ROUND_UP - ROUND_DOWN - ROUND_HALF_EVEN - ROUND_HALF_EVEN_WHOLE type: string PolicyRewardRuleAttributes: description: Additional properties for which the rule can be used to determine reward accrual eligibility for a transaction. properties: max_spend: description: Maximum spend amount. type: number mcc: description: |- List of merchant category codes (MCCs). MCCs must be a four-digit number, or a range of two four-digit numbers separated by a hyphen. items: type: string type: array mid: description: Comma-separated list of merchant IDs for the rule. items: type: string type: array min_spend: description: Minimum spend amount. type: number spend_days: description: |- Maximum number of days since account creation within which the minimum spend requirements must be met to qualify for the reward (used for signup bonus rules). Positive integer values are allowed, with a minimum value of `1`. minimum: 1 type: integer spend_total: description: Total spend amount. type: number type: object PolicyRewardSettlementType: description: Reward settlement strategy for a credit program. enum: - STATEMENT - LIVE type: string PolicyType: description: Type of policy. enum: - APR - DOCUMENT - FEE - OFFER - PRODUCT - REWARD - ALL type: string PostTokenizationAuthenticationDecisionRequest: additionalProperties: false properties: authRequestCorrelationId: description: Correlates multiple authentication requests. example: 550e8400-e29b-41d4-a716-446655440000 maxLength: 64 minLength: 1 type: string authenticationMethod: description: Authentication method used to verify the cardholder. enum: - Issuer Application - Web Portal example: Issuer Application type: string commentText: description: Optional comment related to the decision. example: Cardholder authentication performed post tokenization maxLength: 500 type: string decision: description: Issuer decision after cardholder authentication. enum: - SUCCESS - FAILED example: SUCCESS type: string tokenUniqueReference: description: Unique identifier of the token allocated to the card. example: DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c maxLength: 64 minLength: 1 type: string required: - authenticationMethod - decision - tokenUniqueReference type: object PostTokenizationAuthenticationDecisionResponse: additionalProperties: false properties: message: description: Human-readable description of the outcome. example: Authentication decision recorded and forwarded to Mastercard maxLength: 255 type: string status: description: Indicates if the operation was successful. enum: - SUCCESS - FAILED example: SUCCESS type: string required: - message - status type: object PrimaryContactInfoModel: properties: department: maxLength: 255 minLength: 0 type: string email: maxLength: 255 minLength: 0 type: string extension: maxLength: 255 minLength: 0 type: string fax: maxLength: 255 minLength: 0 type: string full_name: maxLength: 255 minLength: 0 type: string mobile: maxLength: 255 minLength: 0 type: string phone: maxLength: 255 minLength: 0 type: string title: maxLength: 255 minLength: 0 type: string type: object ProductClassification: default: CONSUMER description: |- Specifies for whom the credit product is intended. * `CONSUMER` - The credit product is intended for individual consumers. * `SMALL_AND_MEDIUM_BUSINESS` - The credit product is intended for small and medium business. enum: - CONSUMER - SMALL_AND_MEDIUM_BUSINESS type: string ProductConfig: description: Contains information on configurations for billing cycle day, payment due day, and fees. properties: billing_cycle_day: description: Day of the month when the billing cycle starts. maximum: 28 minimum: 1 type: integer billing_cycle_day_strategy: default: MANUAL description: Determines if the billing cycle day is manually set or determined dynamically during account creation based on cycling logic. enum: - MANUAL type: string billing_cycle_frequency: default: MONTHLY description: Frequency at which the account is billed. enum: - MONTHLY type: string fees: description: One or more fee types. items: $ref: '#/components/schemas/ProductFeeType' type: array payment_due_day: deprecated: true description: |- Day of month the payment for the previous billing cycle is due. This field is deprecated. Use the `product.payment_due_interval` field instead. To retrieve `payment_due_interval`, see <>. maximum: 31 minimum: 31 type: integer payment_due_interval: default: -1 description: |- Specifies the payment due interval that is used to determine the payment due date for a billing cycle. A value of -1 indicates one day prior to the next billing cycle date. For consumer programs, a minimum gap of 21 days is required between when a statement is delivered and the payment due date. minimum: -1 type: integer periodic_fees: description: Contains one or more periodic fees. items: description: Contains information on a periodic fee. properties: frequency: description: How frequently the fee is charged. enum: - ANNUAL - MONTHLY type: string number_of_days_post_activation: description: |- Number of days after an account is activated that the initial fee is charged. For example, if the value in this field is `30`, then the initial fee is charged 30 days after an account is activated. maximum: 1000 minimum: 1 type: integer required: - frequency - number_of_days_post_activation type: object type: array required: - billing_cycle_day type: object ProductCreateReq: description: |- Specifies shared details for a credit program. Once set to `ACTIVE`, cannot be edited or deleted. properties: card_product_tokens: description: One or more associated card product tokens. items: type: string minItems: 1 type: array classification: $ref: '#/components/schemas/ProductClassification' config: $ref: '#/components/schemas/ProductConfig' credit_line: $ref: '#/components/schemas/ProductCreditLine' currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the credit product. maxLength: 255 type: string interest_calculation: $ref: '#/components/schemas/InterestCalculation' min_payment_calculation: $ref: '#/components/schemas/ProductMinPaymentCalculation' min_payment_flat_amount: description: Minimum payment, expressed as a flat amount, due on the payment due day. minimum: 0.01 type: number min_payment_percentage: description: Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day. maximum: 100 minimum: 1.0E-4 type: number name: description: Name of the credit product. maxLength: 255 type: string payment_allocation_order: default: - INTEREST - FEES - PRINCIPAL description: Ordered list of balance types to which payments are allocated, from first to last. items: $ref: '#/components/schemas/PaymentAllocationOrderEnum' minItems: 1 type: array product_sub_type: $ref: '#/components/schemas/ProductSubType' product_type: $ref: '#/components/schemas/ProductType' status: $ref: '#/components/schemas/ResourceStatus' token: description: Unique identifier of the credit product. maxLength: 36 pattern: (?!^ +$)^.+$ type: string usage: description: One or more usage types for the credit product. items: $ref: '#/components/schemas/BalanceType' minItems: 1 type: array required: - card_product_tokens - classification - config - credit_line - currency_code - interest_calculation - min_payment_flat_amount - min_payment_percentage - name - payment_allocation_order - product_sub_type - product_type - usage type: object ProductCreditLine: description: Contains information on the credit line range. properties: max: description: Maximum credit limit. exclusiveMinimum: false maximum: 9.9999999999999E11 minimum: 0 type: number min: description: Minimum credit limit. exclusiveMinimum: false maximum: 9.9999999999999E11 minimum: 0 type: number required: - max - min type: object ProductFeeType: description: Type of fee. enum: - LATE_PAYMENT_FEE - RETURNED_PAYMENT_FEE - FOREIGN_TRANSACTION_FEE type: string ProductMinPaymentCalcFeeType: $ref: '#/components/schemas/ProductFeeType' ProductMinPaymentCalculation: description: Contains information used to calculate the minimum payment amount. properties: include_past_due_amount: description: Whether to include the past due amount when calculating the minimum payment. type: boolean min_payment_flat_amount: description: Minimum payment, expressed as a flat amount, due on the payment due day. minimum: 0.01 type: number min_payment_percentage: $ref: '#/components/schemas/ProductMinPaymentPercentage' required: - include_overlimit_amount - include_past_due_amount - min_payment_flat_amount - min_payment_percentage type: object ProductMinPaymentPercentage: description: Contains information used to calculate the minimum payment percentage. properties: include_all_fees_charged: description: Whether to include all fees charged when calculating the minimum payments. type: boolean include_fees_charged: description: One or more fee types to include when calculating the minimum payment. items: $ref: '#/components/schemas/ProductFeeType' type: array percentage_of_balance: description: Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day. maximum: 100 minimum: 1.0E-4 type: number required: - include_fees_charged - include_interest_charged - percentage_of_balance type: object ProductResponse: description: |- Specifies shared details for a credit program. Once set to `ACTIVE`, cannot be edited or deleted. properties: card_product_tokens: description: One or more associated card product tokens. items: type: string minItems: 1 type: array classification: $ref: '#/components/schemas/ProductClassification' config: $ref: '#/components/schemas/ProductConfig' created_time: description: Date and time when the credit product was created on Marqeta's credit platform, in UTC. format: date-time type: string credit_line: $ref: '#/components/schemas/ProductCreditLine' currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the credit product. type: string interest_calculation: $ref: '#/components/schemas/InterestCalculation' min_payment_calculation: $ref: '#/components/schemas/ProductMinPaymentCalculation' min_payment_flat_amount: description: Minimum payment, expressed as a flat amount, due on the payment due day. minimum: 0.01 type: number min_payment_percentage: description: Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day. maximum: 100 minimum: 1.0E-4 type: number name: description: Name of the credit product. type: string parent_product_token: description: Unique identifier of the parent credit product. type: string payment_allocation_order: default: - INTEREST - FEES - PRINCIPAL description: Ordered list of balance types to which payments are allocated, from first to last. items: $ref: '#/components/schemas/PaymentAllocationOrderEnum' minItems: 1 type: array product_sub_type: $ref: '#/components/schemas/ProductSubType' product_type: $ref: '#/components/schemas/ProductType' status: $ref: '#/components/schemas/ResourceStatus' token: description: Unique identifier of the credit product. type: string updated_time: description: Date and time when the credit product was last updated on Marqeta's credit platform, in UTC. format: date-time type: string usage: description: One or more usage types for the credit product. items: $ref: '#/components/schemas/BalanceType' minItems: 1 type: array type: object ProductSubType: default: CREDIT_CARD description: |- Subtype of the credit product type. * `CREDIT_CARD` - Card that enables the cardholder to make purchases on credit. * `SECURED_CARD` - Card backed by a user-funded deposit that enables the cardholder to make purchases on credit. enum: - CREDIT_CARD - SECURED_CARD type: string ProductType: default: REVOLVING description: |- Type of credit product. `REVOLVING` - Allows users to continuously borrow and pay debts up to the credit limit. enum: - REVOLVING type: string ProductsPage: description: Returns paginated products. properties: count: description: Number of resources returned. type: integer data: description: Contains one or more credit product objects. items: $ref: '#/components/schemas/ProductResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object ProgramFundingPage: description: Returns paginated program fundings. properties: count: description: Number of resources returned. type: integer data: description: Contains one or more program fundings. items: $ref: '#/components/schemas/ProgramFundingResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object ProgramFundingResponse: description: Returns details of a program funding entry. properties: amount: description: Amount of the funding. minimum: 0 type: number created_time: description: Timestamp when the funding entry was created. format: date-time type: string currency_code: $ref: '#/components/schemas/CurrencyCode' memo: description: Additional notes for the funding entry. maxLength: 255 type: string post_time: description: Timestamp when the funding entry was posted. format: date-time type: string short_code: description: Unique identifier of the program. type: string token: description: Unique identifier of the funding entry. maxLength: 36 type: string updated_time: description: Timestamp when the funding entry was last updated. format: date-time type: string required: - amount - created_time - currency_code - memo - post_time - short_code - token - updated_time type: object ProgramGatewayCreateReq: description: Contains information relevant to creating a Credit Program Gateway. properties: active: default: true description: Indicates whether the Program Gateway is active. type: boolean basic_auth_password: description: Basic Authentication password for authenticating your environment. maxLength: 50 minLength: 20 pattern: (?!^ +$)^.+$ type: string basic_auth_username: description: Basic Authentication username for authenticating your environment. maxLength: 50 pattern: (?!^ +$)^.+$ type: string custom_header: $ref: '#/components/schemas/ProgramGatewayCustomHeaderCreateReq' mtls: default: false description: Indicates whether the Program Gateway uses mutual Transport Layer Security (mTLS). type: boolean name: description: Name of the Program Gateway. maxLength: 255 type: string timeout_millis: default: 2000 description: Total timeout for Program Gateway calls, in milliseconds. maximum: 2000 minimum: 1 type: integer token: description: |- Unique identifier of the Program Gateway. If you do not include a token, the system generates one automatically. As this token is necessary for use in other calls, it is recommended that you define a simple and easy to remember string rather than letting the system generate a token for you. This value cannot be updated. maxLength: 36 type: string url: description: |- URL of the Program Gateway endpoint hosted in your environment and configured to receive authorization requests made by the Marqeta platform. Must be HTTPS. maxLength: 250 pattern: (?!^ +$)^.+$ type: string required: - basic_auth_password - basic_auth_username - name - url type: object ProgramGatewayCustomHeaderCreateReq: additionalProperties: type: string description: |- Additional custom information included in the HTTP header. For example, this might contain security information, along with Basic Authentication, when making a Program Gateway request. Custom headers also appear in the associated webhook's notifications. type: object ProgramGatewayCustomHeaderResponse: description: Additional custom information included in the HTTP header. type: object ProgramGatewayPage: description: Returns paginated Program Gateways. properties: count: description: Number of resources returned. type: integer data: description: Contains one or more Program Gateway objects. items: $ref: '#/components/schemas/ProgramGatewayResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object ProgramGatewayResponse: description: Contains information relevant to a Credit Program Gateway. properties: active: default: true description: Indicates whether the Program Gateway is active. type: boolean basic_auth_password: description: Basic Authentication password for authenticating your environment. type: string basic_auth_username: description: Basic Authentication username for authenticating your environment. type: string created_time: description: Date and time when the Program Gateway was created on Marqeta's credit platform, in UTC. format: date-time type: string custom_header: $ref: '#/components/schemas/ProgramGatewayCustomHeaderResponse' mtls: description: Indicates whether the Program Gateway uses mutual Transport Layer Security (mTLS). type: boolean name: description: Name of the Program Gateway. type: string timeout_millis: description: Total timeout for Program Gateway calls, in milliseconds. maximum: 2000 type: integer token: description: Unique identifier of the Program Gateway. type: string updated_time: description: Date and time when the Program Gateway was last updated on Marqeta's credit platform, in UTC. format: date-time type: string url: description: URL of the Program Gateway endpoint hosted in your environment and configured to receive authorization requests made by the Marqeta platform. type: string type: object ProgramGatewayUpdateReq: description: Contains information relevant to updating a Program Gateway. properties: active: default: true description: Indicates whether the Program Gateway is active. type: boolean basic_auth_password: description: Basic Authentication password for authenticating your environment. maxLength: 50 minLength: 20 pattern: (?!^ +$)^.+$ type: string basic_auth_username: description: Basic Authentication username for authenticating your environment. maxLength: 50 pattern: (?!^ +$)^.+$ type: string custom_header: $ref: '#/components/schemas/ProgramGatewayCustomHeaderCreateReq' mtls: default: false description: Indicates whether the Program Gateway uses mutual Transport Layer Security (mTLS). type: boolean name: description: Name of the Program Gateway. maxLength: 255 type: string timeout_millis: description: Total timeout for Program Gateway calls, in milliseconds. maximum: 2000 type: integer token: description: Unique identifier of the Program Gateway. maxLength: 36 type: string url: description: |- URL of the Program Gateway endpoint hosted in your environment and configured to receive authorization requests made by the Marqeta platform. Must be HTTPS. maxLength: 250 pattern: (?!^ +$)^.+$ type: string type: object ProgramReserveTransactionListResponse: properties: count: description: |- Number of resources to retrieve. This field is returned if there are resources in your returned array. format: int32 type: integer data: description: |- List of program reserve transactions. Objects are returned as appropriate to your query. items: $ref: '#/components/schemas/program_reserve_transaction_response' type: array end_index: description: |- Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer is_more: default: false description: |- A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. type: boolean start_index: description: |- Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer type: object ProgramTransferListResponse: properties: count: description: |- Number of program transfer resources to retrieve. This field is returned if there are resources in your returned array. format: int32 type: integer data: description: |- Array of program transfer objects. Objects are returned as appropriate to your query. items: $ref: '#/components/schemas/program_transfer_response' type: array end_index: description: |- Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer is_more: default: false description: |- A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. type: boolean start_index: description: |- Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer type: object ProgramTransferTypeListResponse: properties: count: description: |- Number of program transfer resources to retrieve. This field is returned if there are resources in your returned array. format: int32 type: integer data: description: |- Array of program transfer types. Objects are returned as appropriate to your query. items: $ref: '#/components/schemas/program_transfer_type_response' type: array end_index: description: |- Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer is_more: default: false description: |- A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. type: boolean start_index: description: |- Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer type: object PromptData: properties: driver_number: type: string odometer: type: string vehicle_number: type: string type: object PushToCardDisburseListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/push_to_card_disbursement_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object PushToCardListResponse: properties: count: format: int32 type: integer data: items: $ref: '#/components/schemas/push_to_card_response' type: array end_index: format: int32 type: integer is_more: default: false type: boolean start_index: format: int32 type: integer type: object RealTimeFeeGroupListResponse: properties: count: description: |- Number of resources to retrieve. This field is returned if there are resources in your returned array. format: int32 type: integer data: description: |- Array of real time fee group objects. Objects are returned as appropriate to your query. items: $ref: '#/components/schemas/real_time_fee_group' type: array end_index: description: |- Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer is_more: default: false description: |- A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. type: boolean start_index: description: |- Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer type: object RefundCreateRequest: description: Specifies the details of a refund creation request. properties: amount: description: |- Amount of the refund. The maximum refund amount is the amount that brings the account balance to $0. For example, $4000 is the maximum refund amount for a -$4000 account balance. minimum: 0.01 type: number currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the refund. type: string method: $ref: '#/components/schemas/RefundMethod' payment_source_token: description: Unique identifier of the payment source that receives the refunded amount. maxLength: 36 type: string token: description: Unique identifier of the refund. type: string type: $ref: '#/components/schemas/RefundType' required: - method - type type: object RefundDetails: description: Contains details for a refund. properties: description: description: Description of the refund. type: string method: $ref: '#/components/schemas/RefundMethod' required: - description - method type: object RefundDetailsResponse: description: Contains details for a refund. nullable: true properties: description: description: Description of the refund. type: string method: $ref: '#/components/schemas/RefundMethod' status: $ref: '#/components/schemas/RefundStatus' required: - description - method - status type: object RefundMethod: description: Payment instrument used to issue the refund. enum: - ACH - CHECK type: string RefundResponse: description: Detailed refund response object. properties: account_token: description: Unique identifier of the account for which the refund is issued. maxLength: 36 type: string amount: description: |- Amount of the refund. The maximum refund amount is the amount that brings the account balance to $0. For example, $4000 is the maximum refund amount for a -$4000 account balance. type: number created_time: description: Date and time when the refund was created. format: date-time type: string currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the refund. type: string method: $ref: '#/components/schemas/RefundMethod' payment_source_token: description: Unique identifier of the payment source that receives the refunded amount. maxLength: 36 type: string status: $ref: '#/components/schemas/RefundStatus' token: description: Unique identifier of the refund. type: string type: $ref: '#/components/schemas/RefundType' updated_time: description: Date and time when the refund was last updated. format: date-time type: string required: - account_token - amount - created_time - currency_code - method - status - token - type - updated_time type: object RefundStatus: description: Current status of the refund. enum: - INITIATED - PENDING - PROCESSING - SUBMITTED - CANCELLED - COMPLETED - RETURNED type: string RefundTransitionRequest: description: Request used to transition the status of a refund. properties: status: $ref: '#/components/schemas/RefundStatus' token: description: Unique identifier of the refund status transition. maxLength: 36 type: string required: - status type: object RefundTransitionResponse: description: Response containing refund transition information. properties: account_token: description: Unique identifier of the credit account on which you want to transition a refund status. type: string created_time: description: Date and time when the refund transition was created on Marqeta's credit platform, in UTC. format: date-time type: string refund_token: description: Unique identifier of the refund whose status you want to transition. type: string status: $ref: '#/components/schemas/RefundStatus' token: description: Unique identifier of the refund status transition. type: string required: - account_token - created_time - refund_token - status - token type: object RefundTransitionsPage: description: Return paginated refund transition response. properties: count: description: Number of resources returned. type: integer data: description: Contains one or more `transitions` objects, which contain information on a refund status transition. items: $ref: '#/components/schemas/RefundTransitionResponse' type: array end_index: description: Sort order index of the first resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object RefundType: description: Type of refund. enum: - PAYMENT_REFUND - CREDIT_BALANCE_REFUND type: string RefundsPage: description: Returns paginated list of refund resources. properties: count: description: Number of resources returned. type: integer data: description: Contains one or more refunds on a credit account. items: $ref: '#/components/schemas/RefundResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object ResourceStatus: description: |- Status of the credit product. * `DRAFT` - The credit product is in the process of being created. * `PENDING_APPROVAL` - The credit product has been created and is awaiting approval. * `SENT_FOR_REVISION` - The credit product has been returned for revision. * `ACTIVE` - The credit product is active. * `REJECTED` - The credit product has been rejected; this status cannot be changed. * `ARCHIVED` - The previously active credit product has been archived. enum: - DRAFT - PENDING_APPROVAL - SENT_FOR_REVISION - ACTIVE - REJECTED - ARCHIVED type: string RetryAchPaymentReq: description: Request body that can be used to create a new ACHO transfer for a given payment. properties: new_acho_ach_transfer_token: type: string payment_token: type: string required: - new_acho_ach_transfer_token - payment_token type: object ReturnedDetails: description: Contains information on a returned payment. nullable: true properties: return_code: description: |- Return code for the returned payment. For more, see <>. type: string return_reason: description: |- Reason the payment was returned. For more, see <>. type: string required: - return_code - return_reason type: object ReversalModel: properties: amount: type: number find_original_window_days: format: int32 type: integer is_advice: default: false type: boolean network_fees: items: $ref: '#/components/schemas/network_fee_model' type: array original_transaction_token: maxLength: 36 minLength: 1 type: string webhook: $ref: '#/components/schemas/webhook' required: - amount - original_transaction_token type: object RewardCreateReq: properties: amount: description: Amount of the reward. exclusiveMinimum: true minimum: 0 type: number currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the reward. maxLength: 255 type: string forced: description: |- Allows you to force the creation of a reward on an account. By default, reward creation is not permitted for accounts with a status of `SUSPENDED` or `TERMINATED` if more than 90 days have passed since the status transition. type: boolean note: description: Additional information about the reward. maxLength: 255 type: string token: description: Unique identifier of the reward. maxLength: 36 pattern: (?!^ +$)^.+$ type: string required: - amount - currency_code - description - type type: object RewardResponse: properties: account_token: description: Unique identifier of the account on which the reward exists. maxLength: 36 type: string amount: description: Amount of the reward. minimum: 0 type: number applied_to_amount: description: |- Total amount to which a percentage reward method is applied (for example, if a 3% reward is applied to 100, then `100` is the `applied_to_amount` value). This field is not applicable for a flat fee method. Returned for auto-cash back reward types only. type: number created_time: description: Date and time when the reward was created on Marqeta's credit platform, in UTC. format: date-time type: string currency_code: $ref: '#/components/schemas/CurrencyCode' description: description: Description of the reward. type: string method: $ref: '#/components/schemas/Method' note: description: Additional information about the reward. type: string token: description: |- Unique identifier of the reward. If in the `detail_object`, unique identifier of the detail object. type: string type: $ref: '#/components/schemas/RewardType' updated_time: description: Date and time when the reward was last updated on Marqeta's credit platform, in UTC. format: date-time type: string value: description: |- Value of the percentage or flat amount. Returned for auto-cash back reward types only. type: number required: - amount - created_time - currency_code - description - token - type - updated_time type: object RewardType: description: Type of reward. enum: - AUTO_CASH_BACK - CASH_BACK - STATEMENT_CREDIT type: string ShippingInformationResponse: description: |- Specifies shipping details for the order. This object is returned if it exists in the resource. properties: care_of_line: description: |- Specifies the value of the care of (C/O) line on the mailing carrier. This field is returned if it exists in the resource. type: string method: description: |- Specifies the shipping service. This field is returned if it exists in the resource. enum: - LOCAL_MAIL - LOCAL_MAIL_PACKAGE - GROUND - TWO_DAY - OVERNIGHT - INTERNATIONAL - INTERNATIONAL_PRIORITY - LOCAL_PRIORITY - FEDEX_EXPEDITED - FEDEX_REGULAR - UPS_EXPEDITED - UPS_REGULAR - USPS_EXPEDITED - USPS_REGULAR type: string recipient_address: $ref: '#/components/schemas/FulfillmentAddressResponse' return_address: $ref: '#/components/schemas/FulfillmentAddressResponse' type: object SimulateRefundTransitionRequest: description: Specifies the details of simulate refund transition request . properties: status: $ref: '#/components/schemas/RefundStatus' token: description: Unique identifier for the refund. type: string required: - status - token type: object Special: properties: merchant_on_boarding: default: false type: boolean type: object StatementFile: description: Collection of statement files. properties: account_token: description: Unique identifier of the credit account on which the statement PDF file is generated. maxLength: 36 type: string closing_date: description: Date and time when the statement period ended. format: date-time type: string opening_date: description: Date and time when the statement period began. format: date-time type: string signed_url: description: Signed URL to retrieve the statement PDF file. type: string statement_summary_token: description: Unique identifier of the statement summary. format: uuid type: string token: description: Unique identifier of the statement file. type: string type: description: Type of file. enum: - STATEMENT_PDF type: string type: object StatementFilePage: description: Returns paginated statement files. properties: count: description: Number of resources returned. type: integer data: description: List of statement files. items: $ref: '#/components/schemas/StatementFile' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object StatementInterestCharge: description: Contains information on statement interest charges. properties: amount: description: Amount of interest calculated for the billing period. type: number apr_type: description: Type of APR. enum: - GO_TO type: string apr_value: description: Annual percentage rate. maximum: 100 minimum: 0 type: number balance_subject_to_interest_rate: description: Average daily balance used to calculate interest. type: number balance_type: description: |- Type of balance. * `PURCHASE` - The balance on purchases. enum: - PURCHASE type: string type: object StatementInterestChargesPage: description: Return paginated statement interest charges. properties: account_token: description: Unique identifier of the credit account on which the statement interest charge is generated. maxLength: 36 type: string data: description: Contains one or more interest charges on a statement. items: $ref: '#/components/schemas/StatementInterestCharge' type: array statement_summary_token: description: Unique identifier of the statement summary. type: string required: - account_token - data - statement_summary_token type: object StatementPaymentInfo: description: Contains information on a statement payment. properties: created_time: description: Date and time when the statement payment information was created on Marqeta's credit platform, in UTC. format: date-time type: string minimum_payment_due: description: Minimum payment amount for the current statement period, based on the associated credit product settings. type: number new_statement_balance: description: Balance on the credit account when the statement period ended. type: number payment_cutoff_date: description: Last day a payment can be made before interest and fees are charged to the account. format: date-time type: string payment_due_date: description: Payment due date, based on the credit account settings. format: date-time type: string statement_summary_token: description: Unique identifier of the statement summary. format: uuid type: string three_year_savings: description: Savings amount if the balance is paid off in three years versus only making minimum payments. type: number token: description: Unique identifier of the statement payment. format: uuid type: string warnings: description: One or more payoff warnings. items: $ref: '#/components/schemas/StatementPaymentWarning' type: array type: object StatementPaymentWarning: description: Contains information on statement payment warnings. properties: disclosure: description: |- Statement disclosure in the case of negative or no amortization, or no lifetime repayment for the minimum payment warning type. * `NEGATIVE_OR_NO_AMORTIZATION` - Occurs when the interest amount is higher than the minimum payment; results in the outstanding balance remaining in perpetuity. * `NO_LIFETIME_REPAYMENT` - Occurs when the interest amount is just below the minimum payment; results in the outstanding balance taking longer than a lifetime to pay off. enum: - NEGATIVE_OR_NO_AMORTIZATION - NO_LIFETIME_REPAYMENT type: string interest_paid: description: |- For the minimum payment warning type, this value represents the total amount of interest to pay off the statement balance if only making the minimum payment each month. For the 3 Year warning type, this value represents the total amount of interest if paying off the statement balance in three years. type: number monthly_payment: description: |- For the minimum payment warning type, this value is 0. For the 3 Year warning type, this value represents the fixed monthly payment amount required to pay off the statement balance in three years. type: number pay_off_period: description: |- For the minimum payment warning type, this value represents the number of periods required to pay off the statement balance. For the 3 Year warning type, this value is 36 (months). minimum: 0 type: integer period_type: description: Time unit of the pay off period. enum: - MONTH - YEAR type: string total_paid: description: |- For the minimum payment warning type, this value represents the total amount of principal and interest to pay off the statement balance if only making the minimum payment each month. For the 3 Year warning type, this value represents the total amount of principal and interest if paying off the statement balance in three years. type: number type: description: |- Type of statement warning. * `MIN_PAYMENT` - Displays the total estimated payment amount and how long it would take to pay off the statement balance if only making minimum payments. * `3_YEAR` - Displays the monthly payment amount and total estimated payment amount if paying off the statement balance in three years. enum: - MIN_PAYMENT - 3_YEAR type: string type: object StatementReward: description: Contains information on statement rewards. properties: created_time: description: Date and time when the statement reward was created on Marqeta's credit platform, in UTC. format: date-time type: string current_billing_cycle_reward: description: Amount of rewards received in the current billing cycle. type: number previous_billing_cycle_reward: description: Amount of rewards received in the previous billing cycle. type: number token: description: Unique identifier of the rewards for a specific statement. type: string type: object StatementSummary: description: Contains the summary data for an account's monthly statement. properties: account_token: description: Unique identifier of the credit account on which the statement summary is generated. maxLength: 36 type: string available_credit: description: Amount available to spend on the credit account, as of the statement closing date. type: number closing_balance: description: Balance of the credit account when the statement period ended. type: number closing_date: description: Date and time when the statement period ended. format: date-time type: string created_time: description: Date and time when the statement summary was created on Marqeta's credit platform, in UTC. format: date-time type: string credit_limit: description: Maximum balance the credit account can carry, as of the statement closing date. type: number credits: description: Total amount of credits received during the statement period. type: number cycle_type: $ref: '#/components/schemas/CycleType' days_in_billing_cycle: description: Number of days in the billing cycle, also known as the statement period. type: integer fees: description: |- Total amount of fees charged during the statement period. Does not include periodic fees. type: number interest: description: Total amount of interest charged during the statement period. type: number min_payment_due: description: Minimum payment that is due. minimum: 0 type: number opening_balance: description: Balance of the credit account when the statement period began. type: number opening_date: description: Date and time when the statement period began. format: date-time type: string past_due_amount: description: Total amount of the payment required to make the account current. type: number payment_due_date: description: Date when the payment was due for this statement period. format: date-time type: string payments: description: Total amount of payments made during the statement period. type: number program_migration_time: description: |- Date and time when the statement summary was migrated to Marqeta's credit platform, in UTC. The value of this field is `null` if it has not been migrated. format: date-time type: string purchases: description: Total amount of purchases made during the statement period. type: number remaining_min_payment_due: description: Amount of the minimum payment that remains unpaid for the previous statement period. type: number remaining_statement_balance: description: Amount of the statement balance that remains unpaid for the previous statement period. type: number token: description: Unique identifier of the statement summary. format: uuid type: string required: - account_token - available_credit - closing_balance - closing_date - created_time - credits - cycle_type - days_in_billing_cycle - fees - interest - opening_balance - opening_date - past_due_amount - payments - purchases - token type: object StatementSummaryPage: description: Return filtered transactions. properties: count: description: Number of resources returned. type: integer data: description: One or more statement summaries. items: $ref: '#/components/schemas/StatementSummary' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object StrongCustomerAuthenticationModel: description: Strong Customer Authentication information for contactless transactions properties: acquirer_exemption: description: Acquirer exemption type for the transaction enum: - MERCHANT_INITIATED_TRANSACTION - TRANSACTION_RISK_ANALYSIS - RECURRING_PAYMENT - LOW_VALUE_PAYMENT - SCA_PERFORMED - SECURE_CORPORATE_PAYMENT - AUTHENTICATION_OUTAGE_EXCEPTION type: string issuer_exemption: description: Issuer exemption type for the transaction enum: - LOW_VALUE_PAYMENT type: string type: object SubstatusCreateReq: description: Contains information relevant to creating a substatus. properties: attributes: description: |- Additional dynamic attributes related to the substatus. If the substatus is `BANKRUPTCY`, `SCRA` or `POWER_OF_ATTORNEY`, then attributes are required. items: properties: key: description: |- The name of the attribute. Marqeta provides several preconfigured attributes, as described in the following list. * *chapter:* If the substatus is `BANKRUPTCY`, then the chapter attribute is required. `CHAPTER_9` is not applicable to a `USER` resource type. `CHAPTER_13` is not applicable to a `BUSINESS` resource type. * *military_start_date:* If the substatus is `SCRA`, then the military start date attribute is required. The 6% APR override will be applied from the time and date of account opening until the last statement period of the military start date. * *end_date:* If the substatus is `POWER_OF_ATTORNEY`, then the end date attribute is applicable. This specifies the date when the power of attorney document is no longer valid. * *poa_details:* If the substatus is `POWER_OF_ATTORNEY`, then the Power of Attorney details attribute is applicable. This attribute specifies the range of actions that the agent with Power of Attorney is able to perform on the account. By default the range is `UNRESTRICTED`. * *agent_name:* If the substatus is `POWER_OF_ATTORNEY`, then the agent name is required. This attribute specifies the name of the agent with Power of Attorney for the user. * *agent_address:* If the substatus is `POWER_OF_ATTORNEY`, then the agent address attribute is required. This attribute specifies the address of the agent with Power of Attorney for the user. * *agent_id_type:* If the substatus is `POWER_OF_ATTORNEY`, then the agent identification type attribute is required. This specifies the type of the identification method used to identify the agent with Power of Attorney for the user. * *agent_id_value:* If the substatus is `POWER_OF_ATTORNEY`, then the agent identification value attribute is required. This attribute specifies the value of the identification method used to identify the agent with Power of Attorney for the user. * *agent_id_expiration_date:* If the substatus is `POWER_OF_ATTORNEY`, then the attribute for the Power of Attorney identification expiration date attribute is required. This attribute specifies the expiration date of the identification method used to identify the agent with Power of Attorney for the user. type: string x-allowableValues: |- - `chapter` - `military_start_date` - `end_date` - `poa_details` - `agent_name` - `agent_address` - `agent_id_type` - `agent_id_value` - `agent_id_expiration_date` value: description: The value of the attribute. type: string x-allowableValues: |- * *chapter:* `CHAPTER_7`, `CHAPTER_9`, `CHAPTER_11`, `CHAPTER_12`, `CHAPTER_13` * *military_start_date:* yyyy-MM-ddThh:mm:ssZ format * *end_date:* yyyy-MM-ddThh:mm:ssZ format * *poa_details:* string (255 char max) * *agent_name:* string (255 char max) * *agent_address:* string (255 char max) * *agent_id_type:* `SSN`, `TIN`, `SIN`, `NIN`, `PASSPORT_NUMBER`, `DRIVERS_LICENSE`, `BUSINESS_LICENSE`, `BUSINESS_NUMBER`, `BUSINESS_TAX_ID`, `TAXPAYER_REFERENCE` * *agent_id_value:* string (255 char max) * *agent_id_expiration_date:* yyyy-MM-ddThh:mm:ssZ format type: object type: array events: description: List of events related to the substatus. items: $ref: '#/components/schemas/SubstatusEvent' type: array resource_token: description: |- Unique identifier of the user or account or business for which you want to create a substatus. * Send a `GET` request to `/credit/accounts` to retrieve existing account tokens. * Send a `GET` request to `/users` to retrieve existing user tokens. * Send a `GET` request to `/business` to retrieve existing business tokens. maxLength: 36 minLength: 1 type: string resource_type: description: Type of resource to which the substatus can be applied. enum: - USER - ACCOUNT - BUSINESS type: string substatus: description: |- Type of substatus. * `HARDSHIP`, `FRAUD`, `CEASE_AND_DESIST`, `BLOCKED`, and `OPT_OUT` can only be applied to the `ACCOUNT` resource type. * `MLA`, `SCRA` and `DECEASED` can only be applied to the `USER` resource type. * `POWER_OF_ATTORNEY` and `BANKRUPTCY` can be applied to either the `USER` or the `BUSINESS` resource type. maxLength: 36 minLength: 1 type: string token: description: Unique identifier of the credit substatus. maxLength: 36 pattern: (?!^ +$)^.+$ type: string required: - events - resource_token - resource_type - substatus type: object SubstatusEvent: description: Details of an event related to a substatus. properties: channel: description: |- The mechanism by which the state of the substatus was applied. * `ADMIN` - Indicates that the state of the substatus was added through the Marqeta Dashboard. * `API` - Indicates that you initiated an update of the substatus through the Core API. Use this value when creating a substatus. * `FRAUD` - Indicates that either Marqeta or the card network has determined that the account is fraudulent. * `SYSTEM` - Indicates that Marqeta initiated the state of the substatus. For example, Marqeta determined during application decisioning that the applicant is `MLA`. enum: - ADMIN - API - FRAUD - SYSTEM type: string effective_date: description: |- Date and time when the state of the substatus went into effect, in UTC. The effective date must be in the past. If no value is set, then the effective date and time will be the current time. format: date-time type: string reason: description: Reason for applying a state designation to the substatus. maxLength: 255 type: string state: description: |- Initial state of the substatus. * `ACTIVE` - Required if the substatus is `HARDSHIP`, `MLA`, `SCRA`, `DECEASED`, `BLOCKED`, `CEASE_AND_DESIST`, `OPT_OUT`, or `POWER_OF_ATTORNEY`. * `BANKRUPTCY_FILED` - Required if the substatus is `BANKRUPTCY`. * `DECEASED_REPORTED` - Required if the substatus is `DECEASED`. * `FRAUD_REPORTED` - Required if the substatus is `FRAUD`. enum: - ACTIVE - BANKRUPTCY_FILED - DECEASED_REPORTED - FRAUD_REPORTED type: string required: - state type: object SubstatusEventResponseDetails: description: Details of an event related to a substatus. properties: channel: description: The channel through which the event occurred. enum: - ADMIN - API - FRAUD - SYSTEM type: string created_time: description: Creation time of the event. format: date-time type: string effective_date: description: Effective date of the event, in UTC. format: date-time type: string reason: description: Reason for the event. maxLength: 255 type: string state: description: The state of the event. enum: - ACTIVE - INACTIVE - DECEASED_REPORTED - DECEASED_CONFIRMED - FRAUD_REPORTED - FRAUD_CONFIRMED - BANKRUPTCY_FILED - BANKRUPTCY_WITHDRAWN - BANKRUPTCY_REAFFIRMED - BANKRUPTCY_REAFFIRM_RESCINDED - BANKRUPTCY_DISCHARGED - BANKRUPTCY_DISMISSED - BANKRUPTCY_FILED_INACTIVE - BANKRUPTCY_WITHDRAWN_INACTIVE - BANKRUPTCY_REAFFIRMED_INACTIVE - BANKRUPTCY_REAFFIRM_RESCINDED_INACTIVE - BANKRUPTCY_DISCHARGED_INACTIVE - BANKRUPTCY_DISMISSED_INACTIVE type: string required: - channel - created_time - effective_date - state type: object SubstatusPage: description: Return paginated account and user substatuses. properties: count: description: Number of resources returned. type: integer data: description: Contains one or more substatuses. items: $ref: '#/components/schemas/SubstatusResponse' type: array end_index: description: Sort order index of the last resource in the returned array. type: integer is_more: description: A value of `true` indicates that more unreturned resources exist. type: boolean start_index: description: Sort order index of the first resource in the returned array. type: integer required: - count - data - end_index - is_more - start_index type: object SubstatusResponse: description: Contains information about the substatus. properties: attributes: description: |- Additional dynamic attributes related to the substatus. If the substatus is `BANKRUPTCY`, `SCRA`, or `POWER_OF_ATTORNEY`, then attributes are present. items: properties: key: description: |- The name of the attribute. Marqeta provides several preconfigured attributes, as described in the following list. * *chapter:* If the substatus is `BANKRUPTCY`, then this value defines the chapter. * *military_start_date:* If the substatus is `SCRA`, then this value defines the military start date. * *end_date:* If the substatus is `POWER_OF_ATTORNEY`, then the end date attribute is present. This specifies the date when the power of attorney document is no longer valid. * *poa_details:* If the substatus is `POWER_OF_ATTORNEY`, then the Power of Attorney details attribute is applicable. This attribute specifies the range of actions that the agent with Power of Attorney is able to perform on the account. By default the range is `UNRESTRICTED`. * *agent_name:* If the substatus is `POWER_OF_ATTORNEY`, then the agent name is present. This attribute specifies the name of the agent with Power of Attorney for the user. * *agent_address:* If the substatus is `POWER_OF_ATTORNEY`, then the agent address attribute is present. This attribute specifies the address of the agent with Power of Attorney for the user. * *agent_id_type:* If the substatus is `POWER_OF_ATTORNEY`, then the agent identification type attribute is present. This specifies the type of the identification method used to identify the agent with Power of Attorney for the user. * *agent_id_value:* If the substatus is `POWER_OF_ATTORNEY`, then the agent identification value attribute is present. This attribute specifies the value of the identification method used to identify the agent with Power of Attorney for the user. * *agent_id_expiration_date:* If the substatus is `POWER_OF_ATTORNEY`, then the attribute for the Power of Attorney identification expiration date attribute is present. This attribute specifies the expiration date of the identification method used to identify the agent with Power of Attorney for the user. type: string x-allowableValues: |- * `chapter` * `military_start_date` * `end_date` * `poa_details` * `agent_name` * `agent_address` * `agent_id_type` * `agent_id_value` * `agent_id_expiration_date` value: description: The value of the attribute. type: string x-allowableValues: |- * *chapter:* `CHAPTER_7`, `CHAPTER_11`, `CHAPTER_12`, `CHAPTER_13` * *military_start_date:* yyyy-MM-ddThh:mm:ssZ format * *end_date:* yyyy-MM-ddThh:mm:ssZ format * *poa_details:* string (255 char max) * *agent_name:* string (255 char max) * *agent_address:* string (255 char max) * *agent_id_type:* `SSN`, `TIN`, `SIN`, `NIN`, `PASSPORT_NUMBER`, `DRIVERS_LICENSE`, `BUSINESS_LICENSE`, `BUSINESS_NUMBER`, `BUSINESS_TAX_ID`, `TAXPAYER_REFERENCE` * *agent_id_value:* string (255 char max) * *agent_id_expiration_date:* yyyy-MM-ddThh:mm:ssZ format type: object type: array created_time: description: Date and time when the substatus was created on Marqeta's credit platform, in UTC. format: date-time type: string events: description: List of events related to the substatus. items: $ref: '#/components/schemas/SubstatusEventResponseDetails' type: array is_active: description: Denotes whether a substatus is active. type: boolean resource_token: description: Unique identifier of the resource. maxLength: 36 type: string resource_type: description: Type of resource to which the substatus is applied. enum: - ACCOUNT - USER - BUSINESS type: string state: description: Current state of the substatus. enum: - ACTIVE - INACTIVE - DECEASED_REPORTED - DECEASED_CONFIRMED - FRAUD_REPORTED - FRAUD_CONFIRMED - BANKRUPTCY_FILED - BANKRUPTCY_WITHDRAWN - BANKRUPTCY_REAFFIRMED - BANKRUPTCY_REAFFIRM_RESCINDED - BANKRUPTCY_DISCHARGED - BANKRUPTCY_DISMISSED - BANKRUPTCY_FILED_INACTIVE - BANKRUPTCY_WITHDRAWN_INACTIVE - BANKRUPTCY_REAFFIRMED_INACTIVE - BANKRUPTCY_REAFFIRM_RESCINDED_INACTIVE - BANKRUPTCY_DISCHARGED_INACTIVE - BANKRUPTCY_DISMISSED_INACTIVE type: string substatus: description: Type of substatus. maxLength: 36 type: string token: description: Unique identifier of the credit substatus. maxLength: 36 type: string updated_time: description: Date and time when the substatus was last updated on Marqeta's credit platform, in UTC. format: date-time type: string required: - is_active - resource_token - resource_type - state - substatus - token type: object SubstatusUpdateReq: description: Contains information relevant to deactivating a substatus. properties: channel: description: |- The mechanism by which a state designation was applied to a substatus. If no value is set, then it defaults to `API`. * `ADMIN` - Indicates that the state of the substatus was added through the Marqeta Dashboard. * `API` - Indicates that you initiated the update of the substatus through the Core API. Use this value when creating a card transition with an API `POST` request. * `FRAUD` - Indicates that either Marqeta or the card network has determined that the account is fraudulent. * `SYSTEM` - Indicates that the substatus update was initiated by Marqeta. For example, Marqeta determined during application decisioning that the applicant is `MLA`. enum: - ADMIN - API - FRAUD - SYSTEM type: string effective_date: description: Date and time when the state of the substatus is effective, in UTC. format: date-time type: string reason: description: Reason for applying the state to the substatus. maxLength: 255 minLength: 1 type: string state: description: |- New state of the substatus. * `INACTIVE` is a valid state for substatuses `HARDSHIP`, `FRAUD`, `MLA`, `SCRA`, `DECEASED`, `BLOCKED`, `CEASE_AND_DESIST`, `OPT_OUT`, and `POWER_OF_ATTORNEY`. * `DECEASED_CONFIRMED` is a valid state for substatus `DECEASED`. * `FRAUD_CONFIRMED` is a valid state for substatus `FRAUD`. * `BANKRUPTCY_WITHDRAWN`, `BANKRUPTCY_REAFFIRMED`, `BANKRUPTCY_REAFFIRM_RESCINDED`, `BANKRUPTCY_DISCHARGED`, `BANKRUPTCY_DISMISSED`, `BANKRUPTCY_FILED_INACTIVE`, `BANKRUPTCY_WITHDRAWN_INACTIVE`, `BANKRUPTCY_REAFFIRMED_INACTIVE`, `BANKRUPTCY_REAFFIRM_RESCINDED_INACTIVE`, `BANKRUPTCY_DISCHARGED_INACTIVE`, and `BANKRUPTCY_DISMISSED_INACTIVE` states are applicable to `BANKRUPTCY`. enum: - INACTIVE - BANKRUPTCY_WITHDRAWN - BANKRUPTCY_REAFFIRMED - BANKRUPTCY_REAFFIRM_RESCINDED - BANKRUPTCY_DISCHARGED - BANKRUPTCY_DISMISSED - BANKRUPTCY_FILED_INACTIVE - BANKRUPTCY_WITHDRAWN_INACTIVE - BANKRUPTCY_REAFFIRMED_INACTIVE - BANKRUPTCY_REAFFIRM_RESCINDED_INACTIVE - BANKRUPTCY_DISCHARGED_INACTIVE - BANKRUPTCY_DISMISSED_INACTIVE - DECEASED_CONFIRMED - FRAUD_CONFIRMED type: string required: - state type: object Success: description: Successful response for operation properties: success: description: Denotes whether the operation is successful or not type: boolean type: object SyncStatementAssetReq: properties: asset_token: description: Unique identifier of the statement asset in Credit File Template. format: uuid type: string short_code: description: Unique identifier of the program. type: string required: - asset_token - short_code type: object TransactionModelListResponse: properties: count: description: |- The number of resources to retrieve. This field is returned if there are resources in your returned array. format: int32 type: integer data: description: |- An array of transaction objects. See the <> description at the top of this page. Objects are returned as appropriate to your query. items: $ref: '#/components/schemas/transaction_model' type: array end_index: description: |- The sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer is_more: default: false description: |- A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. type: boolean start_index: description: |- The sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer type: object UnauthorizedError: properties: error_code: enum: - '401' type: string error_message: type: string required: - error_code - error_message type: object UserCardHolderListResponse: properties: count: description: |- Number of resources to retrieve. This field is returned if there are resources in your returned array. format: int32 type: integer data: description: |- Array of user objects. Objects are returned as appropriate to your query. items: $ref: '#/components/schemas/card_holder_model' type: array end_index: description: |- Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer is_more: default: false description: |- A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. type: boolean start_index: description: |- Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer type: object UserCardHolderUpdateModel: properties: account_holder_group_token: description: |- Associates the specified account holder group with the cardholder. Send a `GET` request to `/accountholdergroups` to retrieve account holder group tokens. maxLength: 36 minLength: 0 type: string address1: description: |- Cardholder address. *NOTE:* Required for KYC verification (US-based cardholders only). Cannot perform KYC if set to a PO Box. maxLength: 255 minLength: 0 type: string address2: description: |- Additional address information for the cardholder. *NOTE:* Cannot perform KYC if set to a PO Box. maxLength: 255 minLength: 0 type: string birth_date: description: |- Cardholder date of birth. *NOTE:* Required for KYC verification (US-based cardholders only). type: string birth_place: description: Country where the cardholder was born. maxLength: 255 minLength: 0 type: string city: description: |- The city that corresponds to the address. *NOTE:* Required for KYC verification (US-based cardholders only). maxLength: 40 minLength: 0 type: string company: description: Company name. maxLength: 255 minLength: 0 type: string corporate_card_holder: default: false description: Specifies if the cardholder holds a corporate card. type: boolean country: description: |- Country in which the cardholder resides. *NOTE:* Required for KYC verification (US-based cardholders only). maxLength: 40 minLength: 0 type: string email: description: |- Valid email address for the cardholder. This value must be unique among cardholders. maxLength: 255 minLength: 1 type: string first_name: description: |- Cardholder first name. *NOTE:* Required for KYC verification (US-based cardholders only). maxLength: 40 minLength: 0 type: string gender: description: Gender of the cardholder. enum: - F - M maxLength: 1 minLength: 0 type: string honorific: description: 'Cardholder title or prefix: Ms., Mr., Miss, Mrs.' maxLength: 10 minLength: 0 type: string id_card_expiration_date: description: Expiration date of the cardholder's identification card. type: string id_card_number: description: Cardholder's identification card number. maxLength: 255 minLength: 0 type: string identifications: description: One or more objects containing identifications associated with the cardholder. items: $ref: '#/components/schemas/IdentificationRequestModel' type: array ip_address: description: Cardholder IP address. maxLength: 39 minLength: 0 type: string last_name: description: |- Cardholder last name. *NOTE:* Required for KYC verification (US-based cardholders only). maxLength: 40 minLength: 0 type: string metadata: additionalProperties: type: string description: Associates any additional metadata you provide with the cardholder. type: object middle_name: description: Cardholder middle name. maxLength: 40 minLength: 0 type: string nationality: description: Cardholder nationality. maxLength: 255 minLength: 0 type: string notes: description: Any additional information pertaining to the cardholder. maxLength: 255 minLength: 0 type: string parent_token: description: |- Unique identifier of an existing user or business resource. Required if `uses_parent_account = true`. This account holder is configured as the parent of the current cardholder. To unlink a child account from a parent account, update this field to a null value. maxLength: 36 minLength: 1 type: string passport_expiration_date: description: Expiration date of the cardholder's passport. type: string passport_number: description: Cardholder passport number. maxLength: 40 minLength: 0 type: string password: description: Cardholder's user account password on the Marqeta platform. maxLength: 255 minLength: 0 type: string phone: description: |- Cardholder telephone number (including area code), prepended by the `+` symbol and the 1- to 3-digit country calling code. Do not include hyphens, spaces, or parentheses. maxLength: 16 minLength: 0 type: string postal_code: description: |- Postal code of the cardholder's address. *NOTE:* Required for KYC verification (US-based cardholders only). maxLength: 10 minLength: 0 type: string ssn: description: Cardholder's Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN). type: string state: description: |- State where the cardholder resides (`CA` for California, for example). *NOTE:* <> required for KYC verification (US-based cardholders only). maxLength: 32 minLength: 0 type: string title: description: Professional title of the cardholder, such as Chief Comptroller. maxLength: 255 minLength: 0 type: string token: description: Unique identifier of the cardholder. maxLength: 36 minLength: 1 type: string uses_parent_account: default: false description: |- Indicates whether the child shares balances with the parent (`true`), or the child's balances are independent of the parent (`false`). If set to `true`, you must also include a `parent_token` in the request. This value cannot be updated. type: boolean type: object UserTransitionListResponse: properties: count: description: |- Number of resources retrieved. This field is returned if there are resources in your returned array. format: int32 type: integer data: description: |- Array of user transition resources. Resources are returned as appropriate to your query. items: $ref: '#/components/schemas/UserTransitionResponse' type: array end_index: description: |- Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer is_more: default: false description: |- A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. type: boolean start_index: description: |- Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer type: object UserTransitionRequest: properties: channel: description: Mechanism by which the transaction was initiated. enum: - API - IVR - FRAUD - ADMIN - SYSTEM type: string idempotentHash: description: Unique hashed value that identifies subsequent submissions of the user transition request. type: string reason: description: Additional information about the status change. maxLength: 255 minLength: 0 type: string reason_code: description: |- Identifies the standardized reason for the transition: *00:* Object activated for the first time. *01:* Requested by you. *02:* Inactivity over time. *03:* This address cannot accept mail or the addressee is unknown. *04:* Negative account balance. *05:* Account under review. *06:* Suspicious activity was identified. *07:* Activity outside the program parameters was identified. *08:* Confirmed fraud was identified. *09:* Matched with an Office of Foreign Assets Control list. *10:* Card was reported lost. *11:* Card information was cloned. *12:* Account or card information was compromised. *13:* Temporary status change while on hold/leave. *14:* Initiated by Marqeta. *15:* Initiated by issuer. *16:* Card expired. *17:* Failed KYC. *18:* Changed to `ACTIVE` because information was properly validated. *19:* Changed to `ACTIVE` because account activity was properly validated. *20:* Change occurred prior to the normalization of reason codes. *21:* Initiated by a third party, often a digital wallet provider. *22:* PIN retry limit reached. *23:* Card was reported stolen. *24:* Address issue. *25:* Name issue. *26:* SSN issue. *27:* DOB issue. *28:* Email issue. *29:* Phone issue. *30:* Account/fulfillment mismatch. *31:* Other reason. *86:* Notification of death. enum: - '00' - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' - '09' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '86' type: string status: description: Specifies the new status of the user. enum: - UNVERIFIED - LIMITED - ACTIVE - SUSPENDED - CLOSED - TERMINATED type: string token: description: |- Unique identifier of the user transition. If you do not include a token, the system generates one automatically. This token is referenced in other API calls, so we recommend that you define a simple string that is easy to remember. This value cannot be updated. type: string user_token: description: Unique identifier of the user whose status you want to transition. type: string required: - channel - reason_code - status - user_token type: object UserTransitionResponse: properties: channel: description: Mechanism by which the transaction was initiated. enum: - API - IVR - FRAUD - ADMIN - SYSTEM type: string created_time: description: Date and time when the resource was created, in UTC. format: date-time type: string created_timestamp: description: |- Date and time when the resource was created. Expressed in UTC, with millisecond precision. format: date-time type: string last_modified_time: description: Date and time when the resource was last modified, in UTC. format: date-time type: string metadata: additionalProperties: type: string description: |- Associates customer-injected metadata with the user. Returned if part of the call to `POST /users`. type: object reason: description: Additional information about the status change. type: string reason_code: description: |- Identifies the standardized reason for the transition: *00:* Object activated for the first time. *01:* Requested by you. *02:* Inactivity over time. *03:* This address cannot accept mail or the addressee is unknown. *04:* Negative account balance. *05:* Account under review. *06:* Suspicious activity was identified. *07:* Activity outside the program parameters was identified. *08:* Confirmed fraud was identified. *09:* Matched with an Office of Foreign Assets Control list. *10:* Card was reported lost. *11:* Card information was cloned. *12:* Account or card information was compromised. *13:* Temporary status change while on hold/leave. *14:* Initiated by Marqeta. *15:* Initiated by issuer. *16:* Card expired. *17:* Failed KYC. *18:* Changed to `ACTIVE` because information was properly validated. *19:* Changed to `ACTIVE` because account activity was properly validated. *20:* Change occurred prior to the normalization of reason codes. *21:* Initiated by a third party, often a digital wallet provider. *22:* PIN retry limit reached. *23:* Card was reported stolen. *24:* Address issue. *25:* Name issue. *26:* SSN issue. *27:* DOB issue. *28:* Email issue. *29:* Phone issue. *30:* Account/fulfillment mismatch. *31:* Other reason. *86:* Notification of death. enum: - '00' - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' - '09' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '86' type: string status: description: Specifies the new status of the user. enum: - UNVERIFIED - LIMITED - ACTIVE - SUSPENDED - CLOSED - TERMINATED type: string token: description: Unique identifier of the user transition. type: string user_token: description: Unique identifier of the user whose status was transitioned. type: string required: - channel - reason_code - status - token type: object UserValidationRequest: properties: birth_date: description: yyyy-MM-dd format: date-time type: string phone: description: 'Phone #' maxLength: 255 minLength: 0 type: string random_name_line1_postfix: description: Six-char random name postfix maxLength: 6 minLength: 6 type: string ssn: description: Last four digits of SSN maxLength: 255 minLength: 0 type: string type: object UserValidationResponse: properties: birth_date: default: false description: yyyy-MM-dd type: boolean phone: default: false description: 10 char max, phone number type: boolean random_name_line1_postfix: default: false description: Six-char random name postfix type: boolean ssn: default: false description: Last four digits of SSN type: boolean required: - birth_date - phone - random_name_line1_postfix - ssn type: object ValidationsRequest: properties: user: $ref: '#/components/schemas/UserValidationRequest' type: object ValidationsResponse: properties: user: $ref: '#/components/schemas/UserValidationResponse' required: - user type: object VelocityControlBalance: allOf: - $ref: '#/components/schemas/VelocityControlResponse' - properties: available: properties: amount: description: |- Amount of money remaining for the user. This value is returned only if the user has a limit on the amount of money. type: number days_remaining: description: |- Number of days remaining for the user. This value is returned only if the user has a limit on the number of days. type: integer uses: description: |- Number of uses remaining for the user. This value is returned only if the user has a limit on the number of uses. type: integer type: object type: object VelocityControlBalanceListResponse: properties: count: description: |- Number of velocity control resources retrieved. This field is returned if there are resources in your returned array. format: int32 type: integer data: description: |- Array of velocity control objects that include available balances. Objects are returned as appropriate to your query. items: $ref: '#/components/schemas/velocity_control_balance_response' type: array end_index: description: |- Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer is_more: default: false description: |- A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. type: boolean start_index: description: |- Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer type: object VelocityControlBalancePage: properties: count: description: |- Number of resources retrieved. This field is returned if there are resources in your returned array. format: int32 type: integer data: description: |- Array of Card Group objects. Objects are returned as appropriate to your query. items: $ref: '#/components/schemas/VelocityControlBalance' type: array end_index: description: |- Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer is_more: default: false description: |- A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. type: boolean start_index: description: |- Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer type: object VelocityControlListResponse: properties: count: description: |- Number of resources retrieved. This field is returned if there are resources in your returned array. format: int32 type: integer data: description: |- Array of velocity control objects. Objects are returned as appropriate to your query. items: $ref: '#/components/schemas/velocity_control_response' type: array end_index: description: |- Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer is_more: default: false description: |- A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. type: boolean start_index: description: |- The sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer type: object VelocityControlResponse: properties: active: default: false description: Indicates whether the velocity control is active. type: boolean amount_limit: description: Maximum monetary sum that can be cleared within the time period defined by velocity period. minimum: 0 type: number association: $ref: '#/components/schemas/Association' currency_code: description: Three-character ISO 4217 currency code. type: string merchant_scope: $ref: '#/components/schemas/MerchantScope' name: description: |- Description of how the velocity control restricts spending. For example, "Max spend of $500 per day" or "Max spend of $5000 per month for non-exempt employees". maxLength: 255 minLength: 0 type: string token: description: Unique identifier of the velocity control. maxLength: 36 minLength: 1 type: string usage_limit: description: |- Maximum number of times a card can be used within the time period defined by the `velocity_window` field. Leave `null` to indicate that the card can be used an unlimited number of times. format: int32 minimum: 1 type: integer velocity_window: $ref: '#/components/schemas/VelocityWindow' velocity_window_start_day: description: |- Start day of the velocity window defined by the `velocity_window` field. Default value is `1` format: int32 minimum: 1 type: integer required: - amount_limit - currency_code type: object VelocityWindow: description: |- Defines the time period to which the `amount_limit` and `usage_limit` fields apply: * *MONTH* – one month; months begin on the first day of month at 00:00:00 ET. enum: - MONTH type: string WebhookEventResendContainerResponse: description: Contains information about a webhook event. properties: unused: description: Event notification that was resent to your webhook endpoint. type: string type: object WebhookResponseModelListResponse: properties: count: description: |- Number of resources to retrieve. This field is returned if there are resources in your returned array. format: int32 type: integer data: description: |- Array of webhooks resources. Resources are returned as appropriate to your query. items: $ref: '#/components/schemas/webhook_response_model' type: array end_index: description: |- Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer is_more: default: false description: |- A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. type: boolean start_index: description: |- Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. format: int32 type: integer type: object WebhookUpdateCustomHeaderRequest: properties: custom_header: additionalProperties: type: string description: |- Additional custom information included in the HTTP header. For example, this might contain security information, along with Basic Authentication, when making a JIT Funding request. type: object type: object YearToDate: description: Contains information about year-to-date totals for an account. properties: account_token: description: Unique identifier of the associated credit account. maxLength: 36 type: string created_time: description: Date and time when the year-to-date total was created on Marqeta's credit platform, in UTC. format: date-time type: string statement_token: description: Unique identifier of the statement summary from which to retrieve year-to-date totals. format: uuid type: string token: description: Unique identifier of the year-to-date total. format: uuid type: string total_fees: description: Total fees charged year-to-date. type: number total_interest: description: Total interest charged year-to-date. type: number required: - account_token - statement_token - total_fees - total_interest type: object accepted_countries_model: properties: country_codes: items: type: string type: array created_time: format: date-time type: string is_whitelist: default: false type: boolean last_modified_time: format: date-time type: string name: type: string token: maxLength: 36 minLength: 1 type: string required: - country_codes - is_whitelist - name type: object access_token_response: description: Contains a cardholder's login access information. properties: accesstoken_id: type: string application: $ref: '#/components/schemas/Application' expires: description: Date and time when the access token expires. format: date-time type: string master_roles: description: Array of master roles. items: type: string type: array one_time: description: Indicates whether the access token is a single-use token. type: boolean token: description: Unique identifier of the access token. type: string token_type: description: Specifies the type of access token. type: string user_token: description: Unique identifier of the user resource. type: string required: - expires type: object account: description: Contains information related to the cardholder and provided by the digital wallet provider. properties: email_address: description: Digital wallet provider's email address for the cardholder. type: string id: description: Digital wallet provider's identity number for the cardholder. type: string score: description: Score from the digital wallet provider. type: string type: object account_balance: properties: balances: additionalProperties: $ref: '#/components/schemas/CurrencyBalance' type: object default_currency_code: type: string description: type: string impacted_amount: type: number last_updated_time: format: date-time type: string token: type: string type: type: string type: object account_balance_response: properties: account_balance: $ref: '#/components/schemas/account_balance' type: object account_funding: description: |- Contains details about account funding transactions. Account funding transactions move money into a cardholder's general purpose account (GPA). properties: entry_device_type: enum: - OFF_THE_SHELF_MOBILE_CONSUMER type: string funding_source: description: Specifies the type of account from which the transaction was funded. enum: - CREDIT - DEBIT - PREPAID - DEPOSIT_ACCOUNT - CASH - MOBILE_MONEY_ACCOUNT - NON_VISA_CREDIT - CHECK - ACH type: string receiver_account_type: description: Specifies the type of account receiving the funding. enum: - OTHER - RTN_BANK_ACCOUNT - IBAN - CARD_ACCOUNT - EMAIL - PHONE_NUMBER - BANK_ACCOUNT_NUMBER_AND_BANK_IDENTIFICATION_CODE - WALLET_ID - SOCIAL_NETWORK_ID type: string receiver_name: description: Specifies the name of the account holder receiving the funding. type: string reference_id: type: string screening_score: description: |- Sanctions screening score to assist with meeting Anti-Money Laundering (AML) obligations. Higher scores indicate that the sender's data more closely resembles an entry on the regulatory watchlist. A value of 999 means no score was available. type: string sender_account_number: description: Account number of the sender funding the transaction. type: string sender_address: description: Street address of the sender funding the transaction. type: string sender_city: description: City of the sender funding the transaction. type: string sender_country: description: Country of the sender funding the transaction. type: string sender_date_of_birth: type: string sender_name: description: Name of the sender funding the transaction. type: string sender_postal_code: type: string sender_state: description: State or province of the sender funding the transaction. type: string transaction_purpose: description: Describes the purpose of the account funding transaction. type: string transaction_type: description: Specifies the account funding transaction type. enum: - ACCOUNT_TO_ACCOUNT - PERSON_TO_PERSON - WALLET_TRANSFER - MONEY_TRANSFER_BY_BANK - BUSINESS_TO_BUSINESS - DISBURSEMENT - GOVERNMENT_DISBURSEMENT - GAMBLING_PAYOUT - LOYALTY - MERCHANT_DISBURSEMENT - ONLINE_GAMBLING_PAYOUT - PENSION_DISBURSEMENT - PREPAID_LOADS - CARD_BILL_PAYMENT - BILL_PAYMENT - CASH_CLAIM - CASH_IN - CASH_OUT - MOBILE_AIR_TIME_PAYMENT - MONEY_TRANSFER_BY_MERCHANT - FACE_TO_FACE_MERCHANT_PAYMENT - GOVERNMENT_PAYMENT - PAYMENTS_GOODS_SERVICES - FUNDS_TRANSFER - VISA_ACCEPT - GENERAL_BUSINESS_TO_BUSINESS_TRANSFER - BUSINESS_TO_BUSINESS_TRANSFER - CASH_DEPOSIT - PURCHASE_REPAYMENT - AFT_OR_OCT_ELIGIBILITY - CONSUMER_BILL_PAYMENT - REQUEST_TO_PAY - LIQUID_ASSET - FAST_REFUND - GAMING_PAYMENT type: string type: object account_holder_group_config: properties: is_reloadable: default: false type: boolean kyc_required: enum: - ALWAYS - CONDITIONAL - NEVER type: string pre_kyc_controls: $ref: '#/components/schemas/pre_kyc_controls' real_time_fee_group_token: maxLength: 36 minLength: 0 type: string type: object account_holder_group_request: properties: config: $ref: '#/components/schemas/account_holder_group_config' name: maxLength: 40 minLength: 1 type: string token: maxLength: 36 minLength: 1 type: string type: object account_holder_group_response: properties: config: $ref: '#/components/schemas/account_holder_group_config' name: description: 40 char max type: string token: description: 36 char max type: string type: object account_holder_group_update_request: properties: config: $ref: '#/components/schemas/account_holder_group_config' name: maxLength: 40 minLength: 1 type: string type: object account_name_verification_model: description: '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.' properties: on_file: $ref: '#/components/schemas/ani_information' request: $ref: '#/components/schemas/ani_information' request_type: enum: - SENDER - RECEIVER type: string response: $ref: '#/components/schemas/response' type: object account_name_verification_source: description: Contains account name verification data used to make JIT Funding decisions. properties: first_name: description: First or given name of the cardholder. type: string last_name: description: Last or family name of the cardholder. type: string middle_name: description: Middle name of the cardholder. type: string on_file: $ref: '#/components/schemas/ani_information' response: $ref: '#/components/schemas/response' type: object account_owner_model: description: Information about the owner of an account participating in an account funding or original credit transaction. properties: country_of_birth: description: Account owner's country of birth. type: string dob: description: Account owner's date of birth. type: string email_address: description: Account owner's email address. type: string nationality: description: Account owner's nationality. type: string occupation: description: Account owner's occupation. type: string type: object ach_model: properties: account_number: type: string account_type: enum: - checking - savings - corporate - loan type: string bank_name: type: string business_token: description: Required if 'user_token' is null maxLength: 36 minLength: 1 type: string is_default_account: default: false type: boolean name_on_account: maxLength: 50 minLength: 1 type: string routing_number: readOnly: true type: string token: maxLength: 36 minLength: 1 type: string user_token: description: Required if 'business_token' is null maxLength: 36 minLength: 1 type: string verification_notes: type: string verification_override: default: false type: boolean required: - account_number - account_type - name_on_account - routing_number type: object ach_partner_request_model: properties: business_token: description: Required if 'user_token' is null maxLength: 36 minLength: 1 type: string idempotentHash: type: string is_default_account: default: false type: boolean partner: enum: - PLAID type: string partner_account_link_reference_token: type: string token: type: string user_token: description: Required if 'business_token' is null maxLength: 36 minLength: 1 type: string required: - partner - partner_account_link_reference_token type: object ach_response_model: properties: account_suffix: type: string account_type: type: string active: default: false type: boolean bank_name: type: string business_token: type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string date_sent_for_verification: format: date-time type: string date_verified: format: date-time type: string is_default_account: default: false type: boolean last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string name_on_account: type: string partner: type: string partner_account_link_reference_token: type: string token: type: string user_token: type: string verification_notes: type: string verification_override: default: false type: boolean verification_status: type: string required: - account_suffix - account_type - active - created_time - last_modified_time - name_on_account - token type: object ach_verification_model: properties: active: default: false type: boolean verify_amount1: type: number verify_amount2: type: number type: object acquirer: description: Contains information about the merchant's financial institution. properties: city: description: |- City of the merchant's financial institution. This field appears only in account funding and original credit transactions. type: string country_code: description: |- Country code of the merchant's financial institution. This field appears only in account funding and original credit transactions. type: string institution_country: description: Country code of the merchant's financial institution. type: string institution_id_code: description: Identifier code of the merchant's financial institution. type: string merchant_street_address: description: |- Street address of the merchant. This field appears only in account funding and original credit transactions. type: string name: description: |- Name of the merchant's financial institution. This field appears only in account funding and original credit transactions. type: string network_international_id: description: International network identifier. type: string postal_code: description: |- Postal code of the merchant's financial institution. This field appears only in account funding and original credit transactions. type: string retrieval_reference_number: description: Retrieval reference number of the merchant's financial institution. type: string state: description: |- State where the merchant's financial institution is located. This field appears only in account funding and original credit transactions. type: string street_address: type: string system_trace_audit_number: description: System trace audit number of the merchant's financial institution. type: string type: object activation_actions: description: |- Defines actions to execute when the card is activated. The fields in this object are mutually exclusive. properties: swap_digital_wallet_tokens_from_card_token: description: |- Moves all digital wallet tokens from the specified card to the new card. Not relevant when `reissue_pan_from_card_token` is set. Send a `GET` request to `/cards/user/{token}` to retrieve card tokens for a particular user. maxLength: 36 minLength: 1 type: string terminate_reissued_source_card: default: true description: |- If you are reissuing a card, the source card is terminated by default. To prevent the source card from being terminated, set this field to `false`. Only relevant when `reissue_pan_from_card_token` is set. type: boolean type: object address_verification: description: Contains address verification information. properties: name: description: Name of the cardholder. type: string postal_code: description: Postal code. type: string street_address: description: Street address provided by the cardholder. type: string zip: description: United States ZIP code. type: string type: object address_verification_model: description: Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match. properties: on_file: $ref: '#/components/schemas/avs_information' request: $ref: '#/components/schemas/avs_information' response: $ref: '#/components/schemas/response' type: object address_verification_source: description: Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match. properties: on_file: $ref: '#/components/schemas/avs_information' response: $ref: '#/components/schemas/response' type: object ads_alias_inquiry_details: description: Visa Alias information associated with existing records. properties: aliasType: description: |- Type of Visa Alias in the Alias Directory Service (ADS) profile. Visa supports phone and email as Visa Alias types that can be used in place of sensitive payment credentials details. This field is returned if it exists in the resource. enum: - EMAIL - PHONE - DIRECTORY_ALIASID - PAYNAME type: string aliasValue: description: |- Visa Alias value, which can be an email, a phone number, ID of an alias directory, or a payname. If a phone number is used for the Visa Alias, it must follow ITU-T E.164 (2010) number structure. *NOTE:* In the E.164 format, the "+" sign is not included. maxLength: 128 minLength: 1 type: string directories: description: List of directories associated with the Visa Alias. items: $ref: '#/components/schemas/ads_directory_object' maxItems: 10 minItems: 0 type: array directoriesNames: description: List of directory names associated with the Visa Alias. items: maxLength: 128 minLength: 1 type: string maxItems: 10 minItems: 0 type: array type: object ads_alias_inquiry_filter: description: Field and/or value filter to check the availability of the Visa Alias. properties: field: description: Fields used to filter the Visa Aliases. enum: - DIRECTORY_NAME - EXCLUDED_DIRECTORY_NAME - ENTITY_ID type: string value: description: |- Values used to filter the Visa Aliases. Visa Alias values are either an email address or phone number. items: maxLength: 128 minLength: 1 type: string maxItems: 3 minItems: 1 type: array type: object ads_alias_inquiry_request: description: |- Request object that checks for Visa Aliases that are available for alias resolution. One or more Visa Aliases may be available. properties: aliases: description: List of Visa Aliases to check for availability. items: maxLength: 128 minLength: 1 type: string maxItems: 1000 minItems: 1 type: array filters: description: List of filters to apply in the request to check Visa Alias availability. items: $ref: '#/components/schemas/ads_alias_inquiry_filter' maxItems: 3 minItems: 1 type: array transactionDetails: $ref: '#/components/schemas/ads_transaction_detail' userDetails: $ref: '#/components/schemas/ads_alias_inquiry_user_details' required: - aliases type: object ads_alias_inquiry_response: description: |- Response object containing Visa Aliases available for alias resolution. One or more Visa Aliases maybe available. properties: details: description: Information associated with available Visa Aliases. items: $ref: '#/components/schemas/ads_alias_inquiry_details' maxItems: 900 minItems: 0 type: array summary: $ref: '#/components/schemas/ads_alias_inquiry_summary' required: - summary type: object ads_alias_inquiry_summary: description: Summary of available Visa Aliases. properties: aliasesFound: description: Number of available Visa Aliases found. maximum: 900 minimum: 0 type: integer aliasesNotFound: description: Number of Visa Aliases not found. maximum: 900 minimum: 0 type: integer aliasesRepeated: description: Number of duplicate Visa Aliases. maximum: 900 minimum: 0 type: integer aliasesTotal: description: Total number of available Visa Aliases. maximum: 900 minimum: 0 type: integer required: - aliasesFound - aliasesNotFound - aliasesRepeated - aliasesTotal type: object ads_alias_inquiry_user_details: description: |- Details of the user requesting the Visa Alias information. The information must not contain personal identifiable information (PII). properties: userName: description: Unique identifier of the user. maxLength: 50 minLength: 1 type: string type: object ads_alias_resolve_request: description: Request object to resolve one or more Visa Aliases. properties: aliasType: description: |- Type of Visa Alias in the Alias Directory Service (ADS) profile. Visa supports phone and email as Visa Alias types that can be used in place of sensitive payment credentials details. enum: - EMAIL - PHONE - DIRECTORY_ALIASID - PAYNAME type: string aliasValue: description: |- Visa Alias value, which can be an email, a phone number, ID of an alias directory, or a payname. If a phone number is used for the Visa Alias, it must follow ITU-T E.164 (2010) number structure. *NOTE:* In the E.164 format, the "+" sign is not included. maxLength: 128 minLength: 1 type: string filters: description: List of filters to apply in the request for Visa Alias resolution. items: $ref: '#/components/schemas/ads_alias_inquiry_filter' maxItems: 3 minItems: 1 type: array transactionDetails: $ref: '#/components/schemas/ads_transaction_detail' userDetails: $ref: '#/components/schemas/ads_alias_inquiry_user_details' required: - aliasType - aliasValue type: object ads_alias_resolve_response: description: Response object to resolve one or more Visa Aliases. properties: directoryName: description: The directory name of the Visa Alias. maxLength: 128 minLength: 1 type: string identification: $ref: '#/components/schemas/ads_identification' paymentCredentials: description: List of payment credentials associated with the Visa Alias. items: $ref: '#/components/schemas/ads_card_response' maxItems: 10 minItems: 0 type: array profile: $ref: '#/components/schemas/ads_profile' required: - profile type: object ads_alias_response: description: Visa Alias response object for retrieving information. properties: aliasType: description: |- Type of Visa Alias in the Alias Directory Service (ADS) profile. Visa supports phone and email as Visa Alias types that can be used in place of sensitive payment credentials. This field is returned if it exists in the resource. enum: - EMAIL - PHONE - DIRECTORY_ALIASID - PAYNAME type: string aliasValue: description: |- Visa Alias value, which can be an email, a phone number, ID of an alias directory, or a payname. If a phone number is used for the Visa Alias, it must follow ITU-T E.164 (2010) number structure. *NOTE:* In the E.164 format, the "+" sign is not included. maxLength: 128 minLength: 1 type: string consent: $ref: '#/components/schemas/ads_consent' createdOn: description: Date and time when the Visa Alias was created. format: date-time maxLength: 24 minLength: 24 pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.000Z$ type: string identification: $ref: '#/components/schemas/ads_identification' lastModifiedOn: description: Date and time when the Visa Alias was last modified. format: date-time maxLength: 24 minLength: 24 pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.000Z$ type: string profile: $ref: '#/components/schemas/ads_profile' status: description: Status of the Visa Alias. enum: - ACTIVE - DISABLED - BLOCKED - EXPIRED type: string type: object ads_alias_response.yaml: description: Visa Alias response object for retrieving information. properties: aliasType: description: |- Type of Visa Alias in the Alias Directory Service (ADS) profile. Visa supports phone and email as Visa Alias types that can be used in place of sensitive payment credentials. This field is returned if it exists in the resource. enum: - EMAIL - PHONE - DIRECTORY_ALIASID - PAYNAME type: string aliasValue: description: |- Visa Alias value, which can be an email, a phone number, ID of an alias directory, or a payname. If a phone number is used for the Visa Alias, it must follow ITU-T E.164 (2010) number structure. *NOTE:* In the E.164 format, the "+" sign is not included. maxLength: 128 minLength: 1 type: string consent: $ref: '#/components/schemas/ads_consent' createdOn: description: Date and time when the Visa Alias was created. format: date-time maxLength: 24 minLength: 24 pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.000Z$ type: string identification: $ref: '#/components/schemas/ads_identification' lastModifiedOn: description: Date and time when the Visa Alias was last modified. format: date-time maxLength: 24 minLength: 24 pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.000Z$ type: string profile: $ref: '#/components/schemas/ads_profile' status: description: Status of the Visa Alias. enum: - ACTIVE - DISABLED - BLOCKED - EXPIRED type: string type: object ads_associated_ids: description: Associated payment credential IDs. properties: id: description: ID of the payment credential associated with the Visa Alias. maxLength: 64 minLength: 1 type: string type: description: Type of payment credential associated with the Visa Alias. enum: - ALIAS - PAYMENT_CREDENTIAL type: string type: object ads_billing_address: description: Billing address for the payment credential. properties: addressLine1: description: Address line 1 of the billing address associated with the payment credential. maxLength: 99 minLength: 0 type: string addressLine2: description: Address line 2 of the billing address associated with the payment credential. maxLength: 99 minLength: 0 type: string buildingNumber: description: Building number of the billing address associated with the payment credential. maxLength: 60 minLength: 1 type: string city: description: City of the billing address associated with the payment credential. maxLength: 35 minLength: 1 type: string country: description: |- Country of the billing address associated with the payment credential, expressed as an ISO 3166 code. For example, the numeric code for the United States is `840` and the alpha-3 code is `USA`. The ISO maintains the link:https://www.iso.org/iso-3166-country-codes.html[full list of ISO 3166 country codes, window="_blank"]. maxLength: 3 minLength: 3 type: string minorSubdivision: description: Minor subdivision of the billing address associated with the payment credential. maxLength: 50 minLength: 1 type: string postalCode: description: Postal code of the billing address associated with the payment credential. maxLength: 16 minLength: 1 type: string state: description: State of the billing address associated with the payment credential. maxLength: 16 minLength: 1 type: string streetName: description: Street name of the billing address associated with the payment credential. maxLength: 60 minLength: 1 type: string required: - country type: object ads_card_details_request: description: Request object for creating or updating a Visa ADS card. properties: billingAddress: $ref: '#/components/schemas/ads_billing_address' cardToken: description: Unique identifier of the card token. maxLength: 36 minLength: 1 type: string cardType: description: Type of card for the payment credential. maxLength: 70 minLength: 1 type: string currencyCode: description: Three-digit ISO 4217 currency code for the payment credential. maxLength: 3 minLength: 3 type: string issuerName: description: Card issuer's name for the payment credential. maxLength: 150 minLength: 1 type: string nameOnCard: description: Name on the card for the payment credential. maxLength: 120 minLength: 1 type: string preferredFor: description: Indicates if a payment credential is a preferred Receiving, Sending, or Paying account. items: enum: - RECEIVE - SEND - PAYING type: string maxItems: 3 minItems: 0 type: array required: - billingAddress - cardToken - cardType - issuerName - nameOnCard type: object ads_card_response: description: Response containing the payment credential associated with a Visa ADS alias. properties: accountNumber: description: Account number of the payment credential. maxLength: 19 minLength: 12 type: string accountNumberType: description: Type of account number associated with the payment credential. enum: - PAN - NIUBIZ - TOKEN type: string billingAddress: $ref: '#/components/schemas/ads_billing_address' cardType: description: Type of card associated with the payment credential. maxLength: 70 minLength: 1 type: string createdOn: description: Date and time when the payment credential was created. format: date-time maxLength: 24 minLength: 24 pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.000Z$ type: string currencyCode: description: Three-digit ISO 4217 currency code for the payment credential. maxLength: 3 minLength: 3 type: string expirationDate: description: Expiration date of the card. maxLength: 7 minLength: 7 pattern: ^\d{4}-\d{2}$ type: string externalId: description: External ID of the payment credential, which corresponds to Marqeta's card token. maxLength: 100 minLength: 1 type: string id: description: Unique identifier of the payment credential generated by Alias Directory. maxLength: 36 minLength: 1 type: string issuerName: description: Name of the issuer of the payment credential. maxLength: 150 minLength: 1 type: string lastFourDigits: description: Last four digits of the card number. maxLength: 4 minLength: 4 type: string lastUpdatedOn: description: Date and time when the payment credential was last updated. format: date-time maxLength: 24 minLength: 24 pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.000Z$ type: string nameOnCard: description: Name on the card associated with the payment credential. maxLength: 120 minLength: 1 type: string preferredFor: description: |- Indicates if a payment credential is a preferred Receiving, Sending, or Paying account. This array is returned if you passed the `preferredFor` field when creating a Visa Alias or when adding a new payment credential to an existing Visa Alias. items: $ref: '#/components/schemas/ads_preferred_for' maxItems: 3 minItems: 0 type: array status: description: Status of the payment credential associated with the Visa Alias. enum: - ACTIVE - BLOCKED - DISABLED - EXPIRED type: string type: description: Type of payment credential associated with the Visa Alias. enum: - CARD type: string required: - accountNumber - billingAddress - type type: object ads_card_response.yaml: description: Response containing the payment credential associated with a Visa ADS alias. properties: accountNumber: description: Account number of the payment credential. maxLength: 19 minLength: 12 type: string accountNumberType: description: Type of account number associated with the payment credential. enum: - PAN - NIUBIZ - TOKEN type: string billingAddress: $ref: '#/components/schemas/ads_billing_address' cardType: description: Type of card associated with the payment credential. maxLength: 70 minLength: 1 type: string createdOn: description: Date and time when the payment credential was created. format: date-time maxLength: 24 minLength: 24 pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.000Z$ type: string currencyCode: description: Three-digit ISO 4217 currency code for the payment credential. maxLength: 3 minLength: 3 type: string expirationDate: description: Expiration date of the card. maxLength: 7 minLength: 7 pattern: ^\d{4}-\d{2}$ type: string externalId: description: External ID of the payment credential, which corresponds to Marqeta's card token. maxLength: 100 minLength: 1 type: string id: description: Unique identifier of the payment credential generated by Alias Directory. maxLength: 36 minLength: 1 type: string issuerName: description: Name of the issuer of the payment credential. maxLength: 150 minLength: 1 type: string lastFourDigits: description: Last four digits of the card number. maxLength: 4 minLength: 4 type: string lastUpdatedOn: description: Date and time when the payment credential was last updated. format: date-time maxLength: 24 minLength: 24 pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.000Z$ type: string nameOnCard: description: Name on the card associated with the payment credential. maxLength: 120 minLength: 1 type: string preferredFor: description: |- Indicates if a payment credential is a preferred Receiving, Sending, or Paying account. This array is returned if you passed the `preferredFor` field when creating a Visa Alias or when adding a new payment credential to an existing Visa Alias. items: $ref: '#/components/schemas/ads_preferred_for' maxItems: 3 minItems: 0 type: array status: description: Status of the payment credential associated with the Visa Alias. enum: - ACTIVE - BLOCKED - DISABLED - EXPIRED type: string type: description: Type of payment credential associated with the Visa Alias. enum: - CARD type: string required: - accountNumber - billingAddress - type type: object ads_cards_response: description: Response containing the payment credentials associated with a Visa Alias Directory Service (ADS) alias. properties: GetPaymentCredentialsResponse: description: |- Response containing the payment credentials associated with a Visa Alias. This array is returned if the Visa Alias exists and one or more payment credentials are linked to it. items: $ref: '#/components/schemas/ads_card_response' maxItems: 2 minItems: 1 type: array type: object ads_cards_response.yaml: description: Response containing the payment credentials associated with a Visa Alias Directory Service (ADS) alias. properties: GetPaymentCredentialsResponse: description: |- Response containing the payment credentials associated with a Visa Alias. This array is returned if the Visa Alias exists and one or more payment credentials are linked to it. items: $ref: '#/components/schemas/ads_card_response' maxItems: 2 minItems: 1 type: array type: object ads_consent: description: Visa Alias Directory Service (ADS) consent information. properties: expiryDateTime: description: |- Date and time when the validity of the Visa ADS consent ends. This field is returned if it exists in the resource. format: date-time maxLength: 20 minLength: 20 pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$ type: string intermediaries: description: Intermediaries of the Visa ADS consent. items: maxLength: 120 minLength: 1 type: string maxItems: 5 minItems: 0 type: array presenter: description: Presenter of the Visa Alias Directory Service (ADS) consent. maxLength: 120 minLength: 1 type: string validFromDateTime: description: Date and time when the validity of the Visa ADS consent begins. format: date-time maxLength: 20 minLength: 20 pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$ type: string version: description: Version of the Visa ADS consent. maxLength: 9 minLength: 1 type: string required: - presenter - validFromDateTime - version type: object ads_contact_info: description: |- Contact information in the Alias Directory Service (ADS) profile. This array is returned if the Visa Alias' contact information details exist. properties: type: description: Type of contact information in the Alias Directory Service (ADS) profile. enum: - EMAIL - PHONE - DIRECTORY_ALIASID type: string value: description: Contact information value, which is the email address or phone number. maxLength: 320 minLength: 1 type: string required: - type - value type: object ads_create_additional_alias_response: description: Response containing the unique identifier of the additional alias generated by Alias Directory. properties: id: description: UUID generated by Alias Directory, which identifies the Visa Alias. maxLength: 36 minLength: 1 type: string required: - id type: object ads_create_additional_aliases_request: description: Request to create an additional alias. properties: type: description: Type of the additional Visa Alias. enum: - EMAIL - PHONE type: string value: description: Unique identifier that represents the customer in the payment ecosystem. maxLength: 128 minLength: 1 type: string required: - type - value type: object ads_create_alias_request: properties: aliasType: description: |- Type of Visa Alias in the Alias Directory Service (ADS) profile. Visa supports phone and email as Visa Alias types that can be used in place of sensitive payment credentials details. enum: - EMAIL - PHONE - DIRECTORY_ALIASID - PAYNAME type: string aliasValue: description: |- Visa Alias value, which can be an email, a phone number, ID of an alias directory, or a payname. If a phone number is used for the Visa Alias, it must follow ITU-T E.164 (2010) number structure. *NOTE:* In the E.164 format, the "+" sign is not included. maxLength: 128 minLength: 1 type: string consent: $ref: '#/components/schemas/ads_consent' identification: $ref: '#/components/schemas/ads_identification' paymentCredentials: description: |- List of payment credentials associated with the Visa Alias. This array is returned if the Visa Alias exists and one or more payment credentials are linked to it. items: $ref: '#/components/schemas/ads_card_details_request' maxItems: 10 minItems: 1 type: array profile: $ref: '#/components/schemas/ads_profile' userToken: description: Unique identifier of the user. maxLength: 128 minLength: 1 type: string required: - aliasType - aliasValue - consent - paymentCredentials - profile - userToken type: object ads_create_alias_response: description: Response containing the unique identifier of the alias generated by Alias Directory. properties: externalId: description: External ID of the Visa Alias. maxLength: 100 minLength: 1 type: string id: description: UUID generated by Alias Directory, which identifies the Visa Alias. maxLength: 36 type: string paymentCredentials: description: |- List of payment credentials associated with the Visa Alias. This array is returned if the Visa Alias exists and one or more payment credentials are linked to it. items: $ref: '#/components/schemas/ads_payment_credentials_response' maxItems: 10 minItems: 1 type: array required: - id type: object ads_create_card_details_response: description: Response containing the payment credential associated with a Visa ADS alias. properties: externalId: description: External ID of the payment credential, which corresponds to Marqeta's card token. maxLength: 100 minLength: 1 type: string id: description: UUID generated by Alias Directory, a utility used to identify the payment credential. maxLength: 36 type: string type: description: Indicates the type of payment credential. enum: - CARD - BANK type: string required: - id - type type: object ads_create_report_request: description: ADS create report request. properties: filters: $ref: '#/components/schemas/ads_report_filters' format: description: The format of the report maxLength: 36 minLength: 1 type: string reportType: description: Indicates the type of report. enum: - DIRECTORY_STATUS - PLATFORM_REQUESTS - RESOLUTION_RECONCILIATION - DIRECTORY_ACTIVITY - PAYMENT_CREDENTIAL_DETAILS type: string required: - filters - format - reportType type: object ads_directory_object: description: Directory object associated with the Visa Alias. properties: directoryName: description: The directory name for the Visa Alias. maxLength: 25 minLength: 0 type: string entities: description: List of entities associated with the directory. items: $ref: '#/components/schemas/ads_entity' maxItems: 10 minItems: 0 type: array type: object ads_entity: description: Information about the Visa ADS entities. properties: id: description: Unique identifier of the entity. maxLength: 36 minLength: 1 type: string preferredFor: description: List of preferred payment methods for the entity. items: $ref: '#/components/schemas/ads_preferred_for' maxItems: 10 minItems: 0 type: array type: object ads_get_by_external_id_request: description: Request to get a Visa Alias by external ID. properties: externalId: description: External ID of the Visa Alias. maxLength: 100 minLength: 1 type: string type: description: |- Type of Visa Alias in the Alias Directory Service (ADS) profile. Visa supports phone and email as Visa Alias types that can be used in place of sensitive payment credentials. enum: - ALIAS - PAYMENT_CREDENTIAL type: string required: - externalId - type type: object ads_get_by_external_id_response: description: Response for retrieve by external ID request. properties: associatedIds: description: List of associated Visa Alias IDs. items: $ref: '#/components/schemas/ads_associated_ids' minItems: 0 type: array id: description: UUID generated by Alias Directory, which identifies the Visa Alias. maxLength: 36 minLength: 1 type: string required: - associatedIds type: object ads_get_report_status_response: description: Response containing the status of the report. properties: creationDateTime: description: The timestamp when the report was created in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z format: date-time type: string dataClassification: description: Data classification of the report. maxLength: 36 minLength: 1 type: string expirationDateTime: description: The timestamp after which the report won't be available for download in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z format: date-time type: string fileIds: description: UUIDs of the files generated by the report. items: description: UUIDs of the files generated by the report. type: string maxLength: 36 minLength: 1 type: array format: description: Format of the report. maxLength: 36 minLength: 1 type: string id: description: UUID generated by Alias Directory, which identifies the report. maxLength: 36 minLength: 1 type: string reportType: description: Indicates the type of report. enum: - PLATFORM_REQUESTS - DIRECTORY_STATUS - PAYMENT_CREDENTIAL_DETAILS type: string status: description: Indicates the status of the report. enum: - CREATED - IN_PROGRESS - COMPLETED type: string type: object ads_identification: description: Identification of the user associated with the Visa Alias. properties: type: description: Type of identification provided by the user associated with the Visa Alias. enum: - DNI - CE - PASSPORT - PTP - FFPP - FFAA - CCD - COI - PN - CIE - CPF - DL - DPI - NIDN type: string value: description: |- Value of the identification provided by the user associated with the Visa Alias, which is used to validate the user. Passport number, for example. maxLength: 35 minLength: 1 type: string verificationDetails: $ref: '#/components/schemas/ads_verification_details' required: - type - value type: object ads_payment_credentials_response: description: Response containing the details of a payment credential. properties: externalId: description: External ID of the Visa Alias. maxLength: 100 minLength: 1 type: string id: description: Unique identifier of the additional Visa Alias generated by the Alias Directory. maxLength: 36 type: string type: description: The type of payment credential enum: - CARD - BANK type: string required: - id - type type: object ads_preferred_for: description: Details of the operation. properties: date: description: Date of the Receiving, Sending, or Paying operation. format: date maxLength: 10 minLength: 10 pattern: ^\d\d\d\d\-\d\d\-\d\d$ type: string type: description: Type of operation associated with the payment credential. enum: - RECEIVE - SEND - PAY type: string required: - type type: object ads_profile: description: Alias Directory Service (ADS) profile information. properties: contactInfo: description: |- Contact information in the Alias Directory Service (ADS) profile. This array is returned if the Visa Alias' contact information details exist. items: $ref: '#/components/schemas/ads_contact_info' maxItems: 2 minItems: 0 type: array dateOfBirth: description: |- Date of birth in the Alias Directory Service (ADS) profile. This field is returned if it exists in the resource. format: date maxLength: 10 minLength: 10 pattern: ^\d\d\d\d\-\d\d\-\d\d$ type: string firstName: description: First name in the Alias Directory Service (ADS) profile. maxLength: 35 minLength: 1 type: string firstNameLocal: description: |- First name in the Alias Directory Service (ADS) profile, expressed in the user's local language. This field is returned if it exists in the resource. maxLength: 35 minLength: 1 type: string lastName: description: Last name in the Alias Directory Service (ADS) profile. maxLength: 35 minLength: 1 type: string lastNameLocal: description: |- Last name in the Alias Directory Service (ADS) profile, expressed in the user's local language. This field is returned if it exists in the resource. maxLength: 35 minLength: 1 type: string middleName: description: |- Middle name in the Alias Directory Service (ADS) profile. This field is returned if it exists in the resource. maxLength: 35 minLength: 1 type: string middleNameLocal: description: |- Middle name in the Alias Directory Service (ADS) profile, expressed in the user's local language. This field is returned if it exists in the resource. maxLength: 35 minLength: 1 type: string preferredName: description: |- Preferred name in the Alias Directory Service (ADS) profile, as provided by the user. This field is returned if it exists in the resource. maxLength: 35 minLength: 1 type: string required: - firstName - lastName type: object ads_report_file_response: description: The response schema for the ADS report file. properties: operationType: description: The type of the operation type: string operationsCount: description: The number of operations in the report type: integer originatorActorId: description: The Originator Actor Id maxLength: 36 type: string programId: description: The program ID maxLength: 36 type: string statusCode: description: The status code of the operation type: integer type: object ads_report_filters: description: Filters for the report. properties: aliasStatuses: items: enum: - ACTIVE - DISABLED - BLOCKED - EXPIRED - DELETED type: string maxItems: 3 minItems: 1 type: array aliasType: description: |- Type of Visa Alias in the Alias Directory Service (ADS) profile. Visa supports phone and email as Visa Alias types that can be used in place of sensitive payment credentials details. enum: - EMAIL - PHONE - DIRECTORY_ALIASID - PAYNAME type: string billingEventTypes: items: description: 'The billing event types. Possible values are: aliasInquiry, createAlias, createBatch, createPaymentCredential, createReport, deleteAlias, deletePaymentCredential, getAlias, getAliasId, getAliasOnlineReport, getBatch, getBatchKeys, getBatchResult, getByExternalId, getPaymentCredential, getPaymentCredentials, getReport, getReportFile, resolveAlias, updateAlias, updateAliasStatus, updateBankPaymentCredential.' type: string type: array endDate: description: Date when the report ends in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z type: string startDate: description: Date when the report starts in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z type: string required: - aliasStatuses - aliasType - endDate - startDate type: object ads_transaction_detail: description: Details of the transaction associated with the Alias. properties: currencyCode: description: The currency code for the transaction in link:https://www.iso.org/iso-4217-currency-codes.html[ISO 4217 (Alpha-3), window=“_blank”] format. maxLength: 3 minLength: 3 type: string type: object ads_update_alias_request: description: Ads update alias request. properties: consent: $ref: '#/components/schemas/ads_consent' identification: $ref: '#/components/schemas/ads_identification' profile: $ref: '#/components/schemas/ads_profile' required: - consent - profile type: object ads_verification_details: description: |- Verification details associated with the Visa Alias. This field is returned if it exists in the resource. properties: authDateTime: description: Time when the user provided the credentials for verification in ISO UTC format. format: date-time type: string authMethodReference: description: Authentication method used when the user provided the credentials for verification. type: string creationDateTime: description: Time when the user was created or enrolled in ISO UTC format. format: date-time type: string verifiedEmail: description: |- Returns `true` if an email was verified during the verification process. This email does not need to match the Alias or contact info if an email was used. type: boolean verifiedPhone: description: |- Returns `true` if a phone number was verified during the verification process. This phone number does not need to match the Alias or contact info if a phone number was used. type: boolean type: object airline: description: Contains information about airline-related transactions. properties: depart_date: description: The date and time of departure. format: date-time type: string origination_city: description: The city where the flight originates. type: string passenger_name: description: The name of the passenger. type: string type: object android_push_tokenize_request_data: description: Contains details about a card tokenization push request. properties: display_name: description: |- Name of the card as displayed in the digital wallet, typically showing the card brand and last four digits of the primary account number (PAN). `Visa 5678`, for example. type: string last_digits: description: Last four digits of the primary account number of the physical or virtual card. type: string network: description: Specifies the card network of the physical or virtual card. type: string opaque_payment_card: description: Encrypted data field created by the issuer and passed to Google Wallet during the push provisioning process. type: string token_service_provider: description: Specifies the network that provides the digital wallet token service. type: string user_address: $ref: '#/components/schemas/AndroidPushTokenRequestAddress' type: object ani_information: description: Contains account name verification data used to make JIT Funding decisions. properties: card_name: type: string first_name: description: First or given name of the cardholder. type: string last_name: description: Last or family name of the cardholder. type: string middle_name: description: Middle name of the cardholder. type: string type: object atc_information: properties: atc_discrepancy_indicator: type: string atc_discrepancy_value: type: number atc_value: type: number type: object auth_control_exempt_mids_request: properties: association: $ref: '#/components/schemas/spend_control_association' end_time: format: date-time type: string merchant_group_token: description: 36 char max maxLength: 36 minLength: 1 type: string mid: maxLength: 36 minLength: 1 type: string name: maxLength: 255 minLength: 0 type: string start_time: format: date-time type: string token: type: string required: - name type: object auth_control_exempt_mids_response: properties: active: default: false type: boolean association: $ref: '#/components/schemas/spend_control_association' created: format: date-time type: string end_time: format: date-time type: string last_updated: format: date-time type: string merchant_group_token: description: 36 char max maxLength: 36 minLength: 1 type: string mid: maxLength: 36 minLength: 1 type: string name: maxLength: 255 minLength: 0 type: string start_time: format: date-time type: string token: type: string required: - name type: object auth_control_exempt_mids_update_request: properties: active: default: false type: boolean type: object auth_control_merchant_scope: properties: mcc: description: 4 char max maxLength: 4 minLength: 1 type: string mcc_group: description: 36 char max maxLength: 36 minLength: 1 type: string merchant_group_token: description: 36 char max maxLength: 36 minLength: 1 type: string mid: description: 36 char max maxLength: 36 minLength: 1 type: string type: object auth_control_request: properties: active: default: true type: boolean association: $ref: '#/components/schemas/spend_control_association' end_time: format: date-time type: string merchant_scope: $ref: '#/components/schemas/auth_control_merchant_scope' name: maxLength: 255 minLength: 0 type: string start_time: format: date-time type: string token: maxLength: 36 minLength: 1 type: string required: - name type: object auth_control_response: properties: active: default: true type: boolean association: $ref: '#/components/schemas/spend_control_association' end_time: format: date-time type: string merchant_scope: $ref: '#/components/schemas/auth_control_merchant_scope' name: maxLength: 255 minLength: 0 type: string start_time: format: date-time type: string token: maxLength: 36 minLength: 1 type: string required: - name type: object auth_control_update_request: properties: active: default: true type: boolean association: $ref: '#/components/schemas/spend_control_association' end_time: format: date-time type: string merchant_scope: $ref: '#/components/schemas/merchant_scope' name: maxLength: 255 minLength: 0 type: string start_time: format: date-time type: string token: maxLength: 36 minLength: 1 type: string required: - token type: object auth_request_model: properties: amount: type: number card_acceptor: $ref: '#/components/schemas/card_acceptor_model' card_options: $ref: '#/components/schemas/card_options' card_token: maxLength: 36 minLength: 1 type: string cash_back_amount: type: number is_pre_auth: default: false type: boolean mid: maxLength: 50 minLength: 1 type: string network_fees: items: $ref: '#/components/schemas/network_fee_model' type: array network_metadata: $ref: '#/components/schemas/network_metadata' pin: maxLength: 50 minLength: 1 type: string transaction_options: $ref: '#/components/schemas/transaction_options' webhook: $ref: '#/components/schemas/webhook' required: - amount - card_token - mid type: object authorization_advice_model: properties: amount: type: number network_fees: items: $ref: '#/components/schemas/network_fee_model' type: array original_transaction_token: maxLength: 36 minLength: 1 type: string transaction_options: $ref: '#/components/schemas/transaction_options' webhook: $ref: '#/components/schemas/webhook' required: - amount - original_transaction_token type: object auto_commando_mode_program_funding_source_response: properties: account: type: string active: type: boolean created_time: format: date-time type: string last_modified_time: format: date-time type: string name: maxLength: 50 minLength: 1 type: string token: maxLength: 36 minLength: 1 type: string required: - account - created_time - last_modified_time - name - token type: object auto_reload_association: description: |- Specifies the scope of the auto reload. Input no more than one field. If no value is supplied, the auto reload applies at the program level. properties: account_template_token: maxLength: 36 minLength: 1 type: string business_token: description: |- Unique identifier of the business for which the auto reload is configured. Send a `GET` request to `/businesses` to retrieve business tokens. maxLength: 36 minLength: 1 type: string card_product_token: description: |- Unique identifier of the card product for which the auto reload is configured. Send a `GET` request to `/cardproducts` to retrieve card product tokens. maxLength: 36 minLength: 1 type: string user_token: description: |- Unique identifier of the user for which the auto reload is configured. Send a `GET` request to `/users` to retrieve user tokens. maxLength: 36 minLength: 1 type: string type: object auto_reload_model: description: |- Contains information about an auto reload. See <> for more information. Returned if an auto reload was executed. properties: active: default: true description: |- Specifies whether the auto reload is active. Only one auto reload per level, per object, can be active. type: boolean association: $ref: '#/components/schemas/auto_reload_association' currency_code: description: Three-digit link:https://www.iso.org/iso-4217-currency-codes.html[ISO 4217 currency code, window="_blank"]. type: string funding_source_address_token: description: |- Unique identifier of the funding source address to use for this auto reload. If your funding source is an ACH account, then a `funding_source_address_token` is not required. If your funding source is a payment card, you must have at least one funding source address in order to create a GPA order. Send a `GET` request to `/fundingsources/addresses/user/{user_token}` to retrieve address tokens for a user. Send a `GET` request to `/fundingsources/addresses/business/{business_token}` to retrieve address tokens for a business. maxLength: 36 minLength: 1 type: string funding_source_token: description: |- Unique identifier of the funding source to use for this auto reload. Send a `GET` request to `/fundingsources/user/{user_token}` to retrieve funding source tokens for a user. Send a `GET` request to `/fundingsources/business/{business_token}` to retrieve funding source tokens for a business. maxLength: 36 minLength: 1 type: string order_scope: $ref: '#/components/schemas/order_scope' token: description: |- Unique identifier of the auto reload. If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. maxLength: 36 minLength: 1 type: string required: - currency_code - order_scope type: object auto_reload_response_model: properties: active: default: true type: boolean association: $ref: '#/components/schemas/auto_reload_association' created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string currency_code: type: string funding_source_address_token: maxLength: 36 minLength: 1 type: string funding_source_token: description: Required when order scope is GPA maxLength: 36 minLength: 1 type: string last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string order_scope: $ref: '#/components/schemas/OrderScope' token: maxLength: 36 minLength: 1 type: string required: - created_time - currency_code - last_modified_time - order_scope type: object auto_reload_update_model: properties: active: default: true type: boolean association: $ref: '#/components/schemas/auto_reload_association' currency_code: type: string funding_source_address_token: maxLength: 36 minLength: 1 type: string funding_source_token: maxLength: 36 minLength: 1 type: string order_scope: $ref: '#/components/schemas/OrderScope' token: maxLength: 36 minLength: 1 type: string type: object available: description: |- Specifies the available balances of the velocity controls associated with a user. This object is not returned if the velocity control window is `TRANSACTION`, because available balances do not apply to single-transaction velocity windows. properties: amount: description: Total amount of spend remaining in the velocity control. exclusiveMinimum: false minimum: 0 type: number days_remaining: description: Number of days remaining in the velocity control time window. format: int32 type: integer uses: default: 0 description: Number of uses remaining in the velocity control. format: int32 type: integer required: - amount - uses type: object avs_control_options: properties: decline_on_address_number_mismatch: default: false type: boolean decline_on_postal_code_mismatch: default: true type: boolean validate: default: true type: boolean type: object avs_controls: properties: auth_messages: $ref: '#/components/schemas/avs_control_options' av_messages: $ref: '#/components/schemas/avs_control_options' type: object avs_information: description: Contains address verification information. properties: postal_code: description: Postal code of the address. type: string street_address: description: Street name and number of the address. type: string zip: description: United States ZIP code of the address. type: string type: object balance_inquiry_request_model: properties: account_type: enum: - checking - savings - credit type: string card_acceptor: $ref: '#/components/schemas/card_acceptor_model' card_token: maxLength: 36 minLength: 1 type: string mid: maxLength: 50 minLength: 1 type: string network_fees: items: $ref: '#/components/schemas/network_fee_model' type: array pin: maxLength: 15 minLength: 1 type: string webhook: $ref: '#/components/schemas/webhook' required: - account_type - card_acceptor - card_token - mid type: object bank_account_funding_source_model: allOf: - $ref: '#/components/schemas/funding_source_model' - properties: account_suffix: type: string account_type: type: string business_token: description: Required if 'user_token' is null type: string name_on_account: type: string routing_number: type: string user_token: description: Required if 'business_token' is null type: string verification_status: type: string required: - account_suffix - account_type - name_on_account - routing_number - verification_status type: object bank_transfer_request_model: properties: amount: exclusiveMinimum: false minimum: 0.01 type: number channel: description: default = API enum: - API - SYSTEM - ADMIN type: string created_by: maxLength: 255 minLength: 0 type: string currency_code: description: default = USD type: string funding_source_token: maxLength: 36 minLength: 0 type: string memo: type: string standard_entry_class_code: enum: - WEB - PPD - CCD type: string statement_descriptor: maxLength: 10 minLength: 0 type: string token: maxLength: 36 minLength: 0 type: string transfer_speed: description: default = STANDARD enum: - STANDARD - SAME_DAY type: string type: enum: - PUSH - PULL type: string required: - amount - funding_source_token - type type: object bank_transfer_response_model: properties: amount: exclusiveMinimum: false minimum: 0.01 type: number batch_number: type: string channel: description: default = API enum: - API - SYSTEM - ADMIN type: string created_by: maxLength: 255 minLength: 0 type: string created_time: format: date-time type: string currency_code: description: default = USD type: string funding_source_token: maxLength: 36 minLength: 0 type: string is_early_funded: type: boolean last_modified_time: format: date-time type: string memo: type: string return_code: type: string return_reason: type: string standard_entry_class_code: enum: - WEB - PPD - CCD type: string statement_descriptor: maxLength: 10 minLength: 0 type: string status: enum: - INITIATED - PENDING - PROCESSING - SUBMITTED - RETURNED - COMPLETED - ERROR - CANCELLED - REVERSAL_PEND - REVERSAL_COMP - REVERSAL_DECL type: string token: maxLength: 36 minLength: 0 type: string transfer_speed: description: default = STANDARD enum: - STANDARD - SAME_DAY type: string transitions: items: $ref: '#/components/schemas/bank_transfer_transition_response_model' type: array type: enum: - PUSH - PULL type: string required: - amount - funding_source_token - type type: object bank_transfer_transition_request_model: properties: amount: exclusiveMinimum: false minimum: 0 type: number bank_transfer_token: maxLength: 36 minLength: 0 type: string batch_number: type: string channel: enum: - API - SYSTEM - ADMIN type: string effective_date: format: date-time type: string program_reserve_token: maxLength: 36 minLength: 0 type: string reason: type: string return_code: type: string reversal_after_45_days: type: boolean status: enum: - PENDING - PROCESSING - SUBMITTED - RETURNED - COMPLETED - CANCELLED - REVERSAL_PEND - REVERSAL_COMP type: string token: maxLength: 36 minLength: 0 type: string required: - bank_transfer_token - channel - status type: object bank_transfer_transition_response_model: properties: amount: exclusiveMinimum: false minimum: 0 type: number bank_transfer_token: maxLength: 36 minLength: 0 type: string batch_number: type: string channel: enum: - API - SYSTEM - ADMIN type: string created_time: format: date-time type: string effective_date: format: date-time type: string last_modified_time: format: date-time type: string program_reserve_token: maxLength: 36 minLength: 0 type: string reason: type: string return_code: type: string return_reason: type: string reversal_after_45_days: type: boolean status: enum: - PENDING - PROCESSING - SUBMITTED - RETURNED - COMPLETED - CANCELLED - REVERSAL_PEND - REVERSAL_COMP type: string token: maxLength: 36 minLength: 0 type: string transaction_jit_token: type: string transaction_token: type: string required: - bank_transfer_token - channel - status type: object base_ach_request_model: properties: account_number: type: string account_type: enum: - checking - savings - corporate - loan type: string bank_name: type: string is_default_account: default: false type: boolean name_on_account: maxLength: 50 minLength: 1 type: string routing_number: readOnly: true type: string token: maxLength: 36 minLength: 1 type: string verification_notes: type: string verification_override: default: false type: boolean required: - account_number - account_type - name_on_account - routing_number type: object base_ach_response_model: properties: account_suffix: type: string account_type: type: string active: default: false type: boolean bank_name: type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string date_sent_for_verification: format: date-time type: string date_verified: format: date-time type: string is_default_account: default: false type: boolean last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string name_on_account: type: string partner: type: string partner_account_link_reference_token: type: string token: type: string verification_notes: type: string verification_override: default: false type: boolean verification_status: type: string required: - account_suffix - account_type - active - created_time - last_modified_time - name_on_account - token type: object beneficial_owner_request: properties: birth_place: maxLength: 255 minLength: 0 type: string dob: format: date-time type: string email: maxLength: 255 minLength: 0 type: string first_name: type: string home: $ref: '#/components/schemas/AddressRequestModel' identifications: items: $ref: '#/components/schemas/IdentificationRequestModel' type: array last_name: type: string middle_name: type: string nationality: maxLength: 255 minLength: 0 type: string ownership_percentage: maxLength: 40 minLength: 0 type: string phone: type: string ssn: type: string title: type: string type: object beneficial_owner_response: properties: birth_place: type: string email: type: string first_name: type: string getdob: format: date-time type: string home: $ref: '#/components/schemas/AddressResponseModel' identifications: items: $ref: '#/components/schemas/IdentificationResponseModel' type: array last_name: type: string middle_name: type: string nationality: type: string ownership_percentage: type: string phone: type: string ssn: type: string title: type: string type: object bulk_issuance_request: properties: card_allocation: format: int32 maximum: 50000 type: integer card_product_token: maxLength: 36 minLength: 1 type: string expedite: default: false type: boolean expiration_offset: $ref: '#/components/schemas/expiration_offset' fulfillment: $ref: '#/components/schemas/FulfillmentRequest' name_line_1_numeric_postfix: default: false type: boolean name_line_1_random_postfix: default: false type: boolean token: maxLength: 36 minLength: 1 type: string user_association: $ref: '#/components/schemas/user_association' required: - card_allocation - card_product_token - fulfillment - token type: object bulk_issuance_response: properties: card_allocation: format: int32 maximum: 50000 type: integer card_fulfillment_time: format: date-time type: string card_product_token: maxLength: 36 minLength: 1 type: string cards_processed: format: int32 type: integer created_time: format: date-time type: string expedite: default: false type: boolean expiration_offset: $ref: '#/components/schemas/expiration_offset' fulfillment: $ref: '#/components/schemas/FulfillmentResponse' name_line1_end_index: format: int32 type: integer name_line1_start_index: format: int32 type: integer name_line_1_numeric_postfix: default: false type: boolean name_line_1_random_postfix: default: false type: boolean provider_ship_date: format: date-time type: string provider_shipping_method: type: string provider_tracking_number: type: string token: maxLength: 36 minLength: 1 type: string user_association: $ref: '#/components/schemas/user_association' required: - card_allocation - card_product_token - fulfillment - token type: object business_card_holder_response: properties: account_holder_group_token: maxLength: 36 minLength: 0 type: string active: default: false description: default = true type: boolean attestation_consent: default: false type: boolean attestation_date: format: date-time type: string attester_name: maxLength: 64 minLength: 0 type: string attester_title: maxLength: 64 minLength: 0 type: string authentication: $ref: '#/components/schemas/Authentication' beneficial_owner1: $ref: '#/components/schemas/beneficial_owner_response' beneficial_owner2: $ref: '#/components/schemas/beneficial_owner_response' beneficial_owner3: $ref: '#/components/schemas/beneficial_owner_response' beneficial_owner4: $ref: '#/components/schemas/beneficial_owner_response' business_name_dba: maxLength: 255 minLength: 0 type: string business_name_legal: maxLength: 255 minLength: 0 type: string business_type: maxLength: 255 minLength: 0 type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string date_established: format: date-time type: string duns_number: maxLength: 255 minLength: 0 type: string general_business_description: maxLength: 255 minLength: 0 type: string history: maxLength: 255 minLength: 0 type: string identifications: items: $ref: '#/components/schemas/IdentificationResponseModel' type: array in_current_location_since: format: date-time type: string incorporation: $ref: '#/components/schemas/business_incorporation_response' international_office_locations: maxLength: 255 minLength: 0 type: string ip_address: maxLength: 39 minLength: 0 type: string last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string metadata: additionalProperties: type: string type: object notes: maxLength: 255 minLength: 0 type: string office_location: $ref: '#/components/schemas/AddressResponseModel' password: description: Strong password required maxLength: 255 minLength: 1 type: string phone: maxLength: 255 minLength: 0 type: string primary_contact: $ref: '#/components/schemas/PrimaryContactInfoModel' proprietor_is_beneficial_owner: default: false type: boolean proprietor_or_officer: $ref: '#/components/schemas/business_proprietor_response' status: enum: - UNVERIFIED - LIMITED - ACTIVE - SUSPENDED - CLOSED - TERMINATED type: string taxpayer_id: maxLength: 255 minLength: 0 type: string token: maxLength: 36 minLength: 1 type: string website: maxLength: 255 minLength: 0 type: string required: - created_time - last_modified_time type: object business_card_holder_update: properties: account_holder_group_token: maxLength: 36 minLength: 0 type: string active: default: true type: boolean attestation_consent: default: false type: boolean attestation_date: format: date-time type: string attester_name: maxLength: 64 minLength: 0 type: string attester_title: maxLength: 64 minLength: 0 type: string beneficial_owner1: $ref: '#/components/schemas/beneficial_owner_request' beneficial_owner2: $ref: '#/components/schemas/beneficial_owner_request' beneficial_owner3: $ref: '#/components/schemas/beneficial_owner_request' beneficial_owner4: $ref: '#/components/schemas/beneficial_owner_request' business_name_dba: maxLength: 255 minLength: 0 type: string business_name_legal: maxLength: 255 minLength: 0 type: string business_type: maxLength: 255 minLength: 0 type: string date_established: format: date-time type: string duns_number: maxLength: 255 minLength: 0 type: string general_business_description: maxLength: 255 minLength: 0 type: string history: maxLength: 255 minLength: 0 type: string identifications: items: $ref: '#/components/schemas/IdentificationRequestModel' type: array in_current_location_since: format: date-time type: string incorporation: $ref: '#/components/schemas/business_incorporation' international_office_locations: maxLength: 255 minLength: 0 type: string ip_address: maxLength: 39 minLength: 0 type: string metadata: additionalProperties: type: string type: object notes: maxLength: 255 minLength: 0 type: string office_location: $ref: '#/components/schemas/AddressRequestModel' password: maxLength: 255 minLength: 0 type: string phone: maxLength: 16 minLength: 0 type: string primary_contact: $ref: '#/components/schemas/PrimaryContactInfoModel' proprietor_is_beneficial_owner: default: false type: boolean proprietor_or_officer: $ref: '#/components/schemas/business_proprietor' taxpayer_id: maxLength: 255 minLength: 0 type: string token: maxLength: 36 minLength: 1 type: string website: maxLength: 255 minLength: 0 type: string type: object business_cardholder: properties: account_holder_group_token: maxLength: 36 minLength: 0 type: string active: default: true type: boolean attestation_consent: default: false type: boolean attestation_date: description: YYYY-MM-DDThh:mm:ssZ format: date-time type: string attester_name: maxLength: 64 minLength: 0 type: string attester_title: maxLength: 64 minLength: 0 type: string beneficial_owner1: $ref: '#/components/schemas/beneficial_owner_request' beneficial_owner2: $ref: '#/components/schemas/beneficial_owner_request' beneficial_owner3: $ref: '#/components/schemas/beneficial_owner_request' beneficial_owner4: $ref: '#/components/schemas/beneficial_owner_request' business_name_dba: maxLength: 255 minLength: 0 type: string business_name_legal: maxLength: 255 minLength: 0 type: string business_type: maxLength: 255 minLength: 0 type: string date_established: format: date-time type: string duns_number: maxLength: 255 minLength: 0 type: string general_business_description: maxLength: 255 minLength: 0 type: string history: maxLength: 255 minLength: 0 type: string identifications: items: $ref: '#/components/schemas/IdentificationRequestModel' type: array in_current_location_since: format: date-time type: string incorporation: $ref: '#/components/schemas/business_incorporation' international_office_locations: maxLength: 255 minLength: 0 type: string ip_address: maxLength: 39 minLength: 0 type: string metadata: additionalProperties: type: string type: object notes: maxLength: 255 minLength: 0 type: string office_location: $ref: '#/components/schemas/AddressRequestModel' password: description: Strong password required maxLength: 255 minLength: 1 type: string phone: maxLength: 16 minLength: 0 type: string primary_contact: $ref: '#/components/schemas/PrimaryContactInfoModel' proprietor_is_beneficial_owner: default: false type: boolean proprietor_or_officer: $ref: '#/components/schemas/business_proprietor' taxpayer_id: maxLength: 255 minLength: 0 type: string token: maxLength: 36 minLength: 1 type: string website: maxLength: 255 minLength: 0 type: string type: object business_director_request_model: properties: active: type: boolean address: $ref: '#/components/schemas/AddressRequestModel' birth_date: type: string email: maxLength: 255 minLength: 1 type: string first_name: maxLength: 255 minLength: 0 type: string identifications: items: $ref: '#/components/schemas/IdentificationRequestModel' type: array last_name: maxLength: 255 minLength: 0 type: string middle_name: maxLength: 40 minLength: 0 type: string nationality: maxLength: 255 minLength: 0 type: string phone: maxLength: 255 minLength: 0 type: string place_of_birth: maxLength: 255 minLength: 0 type: string title: maxLength: 255 minLength: 1 type: string token: maxLength: 36 minLength: 1 type: string type: object business_director_response_model: properties: active: type: boolean address: $ref: '#/components/schemas/AddressResponseModel' birth_date: readOnly: true type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string email: type: string first_name: type: string identifications: items: $ref: '#/components/schemas/IdentificationResponseModel' type: array last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string last_name: type: string middle_name: type: string nationality: type: string phone: type: string place_of_birth: type: string title: type: string token: type: string required: - created_time - last_modified_time type: object business_incorporation: properties: address_registered_under: $ref: '#/components/schemas/AddressRequestModel' incorporation_type: enum: - LLC - CORPORATION - SOLE_PROPRIETORSHIP - PARTNERSHIP - COOPERATIVE - OTHER - FINANCIAL_OR_CREDIT_INSTITUTION - FOUNDATION - ASSOCIATION - CHARITY - TRUST maxLength: 255 minLength: 0 type: string is_public: default: false type: boolean is_regulated_entity: type: boolean name_registered_under: maxLength: 255 minLength: 0 type: string state_of_incorporation: maxLength: 255 minLength: 0 type: string stock_symbol: maxLength: 255 minLength: 0 type: string type: object business_incorporation_response: properties: address_registered_under: $ref: '#/components/schemas/AddressResponseModel' incorporation_type: enum: - LLC - CORPORATION - SOLE_PROPRIETORSHIP - PARTNERSHIP - OTHER - FINANCIAL_OR_CREDIT_INSTITUTION - FOUNDATION - ASSOCIATION - CHARITY - TRUST maxLength: 255 minLength: 0 type: string is_public: default: false type: boolean is_regulated_entity: type: boolean name_registered_under: maxLength: 255 minLength: 0 type: string state_of_incorporation: maxLength: 255 minLength: 0 type: string stock_symbol: maxLength: 255 minLength: 0 type: string type: object business_metadata: description: Contains customer-provided information about the business that funded the transaction. properties: metadata: additionalProperties: type: string description: Associates customer-provided metadata with the business. type: object type: object business_proprietor: properties: alternative_names: type: string birth_place: maxLength: 255 minLength: 0 type: string dob: format: date-time type: string email: type: string first_name: type: string home: $ref: '#/components/schemas/AddressRequestModel' identifications: items: $ref: '#/components/schemas/IdentificationRequestModel' type: array last_name: type: string middle_name: type: string nationality: maxLength: 255 minLength: 0 type: string phone: type: string ssn: type: string title: type: string required: - first_name - last_name type: object business_proprietor_response: properties: alternative_names: type: string birth_place: type: string dob: format: date-time type: string email: type: string first_name: type: string home: $ref: '#/components/schemas/AddressResponseModel' identifications: items: $ref: '#/components/schemas/IdentificationResponseModel' type: array last_name: type: string middle_name: type: string nationality: type: string phone: type: string ssn: type: string title: type: string type: object card_acceptor_model: properties: address: maxLength: 255 minLength: 0 type: string business_registration_id: type: string business_registration_id_type: type: string city: maxLength: 40 minLength: 0 type: string country: type: string customer_service_phone: type: string ecommerce_security_level_indicator: type: string geographic_coordinates: type: string legal_business_name: type: string mcc: maxLength: 5 minLength: 0 type: string name: maxLength: 50 minLength: 0 type: string partial_approval_capable: default: false type: boolean phone: type: string service_geographic_coordinates: type: string state: type: string url: type: string zip: maxLength: 10 minLength: 0 type: string type: object card_holder_address_model: properties: active: default: true type: boolean address_1: maxLength: 255 minLength: 0 type: string address_2: maxLength: 255 minLength: 0 type: string business_token: description: Required if 'user_token' is not specified maxLength: 36 minLength: 1 type: string city: maxLength: 40 minLength: 0 type: string country: maxLength: 40 minLength: 1 type: string first_name: maxLength: 40 minLength: 0 type: string is_default_address: default: false type: boolean last_name: maxLength: 40 minLength: 0 type: string phone: maxLength: 255 minLength: 0 type: string postal_code: description: Required if 'zip' is not specified maxLength: 10 minLength: 0 type: string state: maxLength: 2 minLength: 0 type: string token: maxLength: 36 minLength: 1 type: string user_token: description: Required if 'business_token' is not specified maxLength: 36 minLength: 1 type: string zip: description: Required if 'postal_code' is not specified maxLength: 10 minLength: 0 type: string required: - address_1 - city - country - first_name - last_name - state type: object card_holder_address_update_model: properties: active: default: true type: boolean address_1: maxLength: 255 minLength: 0 type: string address_2: maxLength: 255 minLength: 0 type: string city: maxLength: 40 minLength: 0 type: string country: maxLength: 40 minLength: 0 type: string first_name: maxLength: 40 minLength: 0 type: string is_default_address: default: false type: boolean last_name: maxLength: 40 minLength: 0 type: string phone: maxLength: 255 minLength: 0 type: string postal_code: maxLength: 10 minLength: 0 type: string state: maxLength: 2 minLength: 0 type: string zip: maxLength: 10 minLength: 0 type: string type: object card_holder_model: description: Contains information about a cardholder. properties: account_holder_group_token: description: |- Associates the specified account holder group with the cardholder. Send a `GET` request to `/accountholdergroups` to retrieve account holder group tokens. maxLength: 36 minLength: 0 type: string active: default: true description: |- Specifies if the cardholder is in the `ACTIVE` state on the Marqeta platform. *NOTE:* Do not set the value of the `user.active` field directly. Instead, use the `/usertransitions` endpoints to transition user resources between statuses. For more information on status changes, see <>. type: boolean address1: description: |- Cardholder's address. *NOTE:* Required for KYC verification (US-based cardholders only). Cannot perform KYC if set to a PO Box. maxLength: 255 minLength: 0 type: string address2: description: |- Additional address information for the cardholder. *NOTE:* Cannot perform KYC if set to a PO Box. maxLength: 255 minLength: 0 type: string birth_date: description: |- Cardholder's date of birth. *NOTE:* Required for KYC verification (US-based cardholders only). type: string birth_place: description: Country where the cardholder was born. maxLength: 255 minLength: 0 type: string city: description: |- City where the cardholder resides. *NOTE:* Required for KYC verification (US-based cardholders only). maxLength: 40 minLength: 0 type: string company: description: Company name. maxLength: 255 minLength: 0 type: string corporate_card_holder: default: false description: Specifies if the cardholder holds a corporate card. type: boolean country: description: |- Country where the cardholder resides. *NOTE:* Required for KYC verification (US-based cardholders only). maxLength: 40 minLength: 0 type: string email: description: |- Valid email address of the cardholder. This value must be unique among users. *NOTE:* Required for KYC verification by certain banks (US-based cardholders only). To determine if you must provide an email address, contact your Marqeta representative. maxLength: 255 minLength: 1 type: string first_name: description: |- Cardholder's first name. *NOTE:* Required for KYC verification (US-based cardholders only). maxLength: 40 minLength: 0 type: string gender: description: Gender of the cardholder. enum: - F - M maxLength: 1 minLength: 0 type: string honorific: description: 'Cardholder''s title or prefix: Dr., Miss, Mr., Ms., and so on.' maxLength: 10 minLength: 0 type: string id_card_expiration_date: description: Expiration date of the cardholder's identification card. type: string id_card_number: description: Cardholder's identification card number. maxLength: 255 minLength: 0 type: string identifications: description: One or more objects containing identifications associated with the cardholder. items: $ref: '#/components/schemas/IdentificationRequestModel' type: array ip_address: description: Cardholder's IP address. maxLength: 39 minLength: 0 type: string last_name: description: |- Cardholder's last name. *NOTE:* Required for KYC verification (US-based cardholders only). maxLength: 40 minLength: 0 type: string metadata: additionalProperties: type: string description: Associates any additional metadata you provide with the cardholder. type: object middle_name: description: Cardholder's middle name. maxLength: 40 minLength: 0 type: string nationality: description: Cardholder's nationality. maxLength: 255 minLength: 0 type: string notes: description: Any additional information pertaining to the cardholder. maxLength: 255 minLength: 0 type: string parent_token: description: |- Unique identifier of the parent user or business resource. Send a `GET` request to `/users` to retrieve user resource tokens or to `/businesses` to retrieve business resource tokens. Required if `uses_parent_account = true`. This user or business is configured as the parent of the current user. maxLength: 36 minLength: 1 type: string passport_expiration_date: description: Expiration date of the cardholder's passport. type: string passport_number: description: Cardholder's passport number. maxLength: 40 minLength: 0 type: string password: description: |- Password to the cardholder's user account on the Marqeta platform. * Must contain at least one numeral + * Must contain at least one lowercase letter + * Must contain at least one uppercase letter + * Must contain at least one of these symbols: + `@` `#` `$` `%` `!` `^` `&` `*` `(` `)` + `\` `_` `+` `~` `-` `=` `[` `]` `{` `}` + `,` `;` `:` `'` `"` `.` `/` `<` `>` `?` ``` maxLength: 255 minLength: 0 type: string phone: description: |- Telephone number of the cardholder (including area code), prepended by the `+` symbol and the 1- to 3-digit country calling code. Do not include hyphens, spaces, or parentheses. *NOTE:* Required for KYC verification by certain banks (US-based cardholders only). To determine if you must provide a phone number, contact your Marqeta representative. maxLength: 16 minLength: 0 type: string postal_code: description: |- Postal code of the cardholder's address. *NOTE:* Required for KYC verification (US-based cardholders only). maxLength: 10 minLength: 0 type: string ssn: description: Cardholder's Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN). type: string state: description: |- State or province where the cardholder resides. *NOTE:* <> required for KYC verification (US-based cardholders only). maxLength: 32 minLength: 0 type: string title: description: |- Professional title of the cardholder, such as Chief Comptroller. *NOTE:* Do not use this field for honorific titles such as Mr., Mrs., Miss, Ms., Mx., Sir, or Dame. Instead, add these to the `honorific` field. maxLength: 255 minLength: 0 type: string token: description: |- Unique identifier of the cardholder. If you do not include a token, the system generates one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. maxLength: 36 minLength: 1 type: string uses_parent_account: default: false description: |- Indicates whether the child shares balances with the parent (`true`), or the child's balances are independent of the parent (`false`). If set to `true`, you must also include a `parent_token` in the request. This value cannot be updated. type: boolean type: object card_life_cycle: properties: activate_upon_issue: default: false type: boolean card_service_code: default: 101 format: int32 type: integer expiration_offset: $ref: '#/components/schemas/ExpirationOffset' reloadability: enum: - SINGLE_USE_VIRTUAL - NON_RELOADABLE - RELOADABLE type: string update_expiration_upon_activation: default: false type: boolean type: object card_metadata: properties: metadata: additionalProperties: type: string type: object type: object card_options: properties: billing_address: $ref: '#/components/schemas/BillingAddress' card_present: default: false type: boolean cvv: maxLength: 3 minLength: 0 type: string expiration: maxLength: 4 minLength: 4 type: string type: object card_personalization: description: Specifies personalized attributes to be added to the card. properties: carrier: $ref: '#/components/schemas/carrier' images: $ref: '#/components/schemas/images' perso_type: description: Specifies the type of card personalization. enum: - EMBOSS - LASER - FLAT type: string text: $ref: '#/components/schemas/text' required: - text type: object card_product_config: properties: card_life_cycle: $ref: '#/components/schemas/card_life_cycle' clearing_and_settlement: $ref: '#/components/schemas/clearing_and_settlement' digital_wallet_tokenization: $ref: '#/components/schemas/DigitalWalletTokenization' fulfillment: $ref: '#/components/schemas/card_product_fulfillment' jit_funding: $ref: '#/components/schemas/jit_funding' poi: $ref: '#/components/schemas/poi' selective_auth: $ref: '#/components/schemas/selective_auth' special: $ref: '#/components/schemas/Special' transaction_controls: $ref: '#/components/schemas/transaction_controls' type: object card_product_fulfillment: properties: all_zero_card_security_code: default: false type: boolean allow_card_creation: default: true type: boolean bin_issue_country: type: string bin_prefix: type: string bin_prefixes: description: List of BIN prefixes for multi-BIN support items: $ref: '#/components/schemas/BinPrefixRequest' type: array bulk_ship: default: false type: boolean card_personalization: $ref: '#/components/schemas/card_personalization' enable_offline_pin: default: false type: boolean fulfillment_provider: default: PERFECTPLASTIC enum: - PERFECTPLASTIC - ARROWEYE - IDEMIA - IDEMIA_UK - IDEMIA_FR - IDEMIA_CZ - IDEMIA_APAC - IDEMIA_PL - IDEMIA_AU - IDEMIA_LA - GEMALTO - NITECREST - OBERTHUR - ALLPAY type: string package_id: default: '0' maxLength: 50 minLength: 1 type: string pan_length: default: '16' type: string payment_instrument: default: PHYSICAL_MSR enum: - PHYSICAL_MSR - PHYSICAL_ICC - PHYSICAL_CONTACTLESS - PHYSICAL_COMBO - VIRTUAL_PAN type: string shipping: $ref: '#/components/schemas/shipping' uppercase_name_lines: default: true type: boolean required: - card_personalization type: object card_product_request: properties: active: default: false type: boolean config: $ref: '#/components/schemas/card_product_config' end_date: description: yyyy-MM-dd format: date type: string name: maxLength: 40 minLength: 1 type: string start_date: description: yyyy-MM-dd format: date type: string token: maxLength: 36 minLength: 1 type: string required: - name - start_date type: object card_product_response: properties: active: default: false type: boolean config: $ref: '#/components/schemas/card_product_config' created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string end_date: description: yyyy-MM-dd format: date type: string last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string name: maxLength: 40 minLength: 1 type: string start_date: description: yyyy-MM-dd format: date type: string token: maxLength: 36 minLength: 1 type: string required: - created_time - last_modified_time - name - start_date type: object card_product_update_model: properties: active: default: false type: boolean config: $ref: '#/components/schemas/card_product_config' end_date: description: yyyy-MM-dd format: date type: string name: maxLength: 40 minLength: 0 type: string start_date: description: yyyy-MM-dd format: date type: string type: object card_request: properties: account_token: type: string activation_actions: $ref: '#/components/schemas/activation_actions' bulk_issuance_token: type: string card_product_token: maxLength: 36 minLength: 1 type: string expedite: default: false type: boolean expiration_offset: $ref: '#/components/schemas/expiration_offset' fulfillment: $ref: '#/components/schemas/CardFulfillmentRequest' metadata: additionalProperties: type: string type: object new_pan_from_card_token: maxLength: 36 minLength: 0 type: string reissue_pan_from_card_token: maxLength: 36 minLength: 0 type: string token: maxLength: 36 minLength: 1 type: string translate_pin_from_card_token: maxLength: 36 minLength: 0 type: string user_token: maxLength: 36 minLength: 1 type: string required: - card_product_token - user_token type: object card_response: description: Contains information about the card used in the transaction. properties: 3csc: type: string account_tokens: description: List of account tokens associated with the card items: type: string type: array activation_actions: $ref: '#/components/schemas/activation_actions' barcode: description: Barcode printed on the card, expressed as numerals. type: string bulk_issuance_token: description: Unique identifier of the bulk card order. type: string card_product_token: description: Unique identifier of the card product. type: string chip_cvv_contactless_number: type: string chip_cvv_number: description: Three-digit card verification value (ICVV) stored on the chip of the card. type: string contactless_exemption_counter: description: |- Running count of the contactless transactions successfully completed since the last strong customer authentication (SCA) challenge was issued. You can limit the number of contactless transactions that can be performed without issuing an SCA challenge at the card product level. For more information about strong customer authentication, see <>. format: int32 type: integer contactless_exemption_total_amount: description: |- Running total of the money spent in contactless transactions successfully completed since the last strong customer authentication (SCA) challenge was issued. You can limit the total amount that can be spent in contactless transactions without issuing an SCA challenge at the card product level. For more information about strong customer authentication, see <>. type: number contactless_exemption_transaction_currency: description: Indicates the currency type of the transaction. type: string created_time: description: Date and time when the resource was created, in UTC. format: date-time type: string cvv_number: description: Three-digit card verification value (CVV2 or CVC2) printed on the card. type: string expedite: default: false description: A value of `true` indicates that you requested expedited processing of the card from your card fulfillment provider. type: boolean expiration: description: Expiration date in `MMyy` format. type: string expiration_time: description: Expiration date and time, in UTC. format: date-time type: string fulfillment: $ref: '#/components/schemas/CardFulfillmentResponse' fulfillment_status: description: |- Card fulfillment status: * *ISSUED:* Initial state of all newly created/issued cards. * *ORDERED:* Card ordered through the card fulfillment provider. * *REORDERED:* Card reordered through the card fulfillment provider. * *REJECTED:* Card rejected by the card fulfillment provider. * *SHIPPED:* Card shipped by the card fulfillment provider. * *DELIVERED:* Card delivered by the card fulfillment provider. * *DIGITALLY_PRESENTED:* Card digitally presented using the `/cards/{token}/showpan` endpoint; does not affect the delivery of physical cards. enum: - ISSUED - ORDERED - REORDERED - REJECTED - SHIPPED - DELIVERED - DIGITALLY_PRESENTED type: string instrument_type: description: |- Instrument type of the card: * *PHYSICAL_MSR:* A physical card with a magnetic stripe. This is the default physical card type. * *PHYSICAL_ICC:* A physical card with an integrated circuit, or "chip." * *PHYSICAL_CONTACTLESS:* A physical card that uses radio frequency identification (RFID) or near-field communication (NFC) to enable payment over a secure radio interface. * *PHYSICAL_COMBO:* A physical card with a chip that also supports contactless payments. * *VIRTUAL_PAN:* A virtual card with a primary account number (PAN). enum: - PHYSICAL_MSR - PHYSICAL_ICC - PHYSICAL_CONTACTLESS - PHYSICAL_COMBO - VIRTUAL_PAN type: string last_four: description: Last four digits of the card primary account number (PAN). type: string last_modified_time: description: Date and time when the resource was last modified, in UTC. format: date-time type: string metadata: additionalProperties: type: string description: Associates customer-provided metadata with the card. type: object new_pan_from_card_token: description: Reissues the specified card (known as the "source" card) with a new primary account number (PAN). type: string pan: description: Primary account number (PAN) of the card. type: string pin_is_set: default: false description: Specifies if the personal identification number (PIN) has been set for the card. type: boolean reissue_pan_from_card_token: description: Reissues the specified card (known as the "source" card). type: string state: description: Indicates the state of the card. enum: - ACTIVE - SUSPENDED - TERMINATED - UNSUPPORTED - UNACTIVATED - LIMITED type: string state_reason: description: |- Descriptive reason for why the card is in its current state. For example, "Card activated by cardholder". type: string token: description: Unique identifier of the card. type: string translate_pin_from_card_token: description: Copies the personal identification number (PIN) from the specified source card to the newly created card. type: string user: $ref: '#/components/schemas/user_card_holder_response' user_token: description: Unique identifier of the cardholder. type: string required: - barcode - card_product_token - created_time - expiration - expiration_time - fulfillment_status - last_four - last_modified_time - pan - pin_is_set - state - state_reason - token - user_token type: object card_security_code_verification: description: Contains information about a verification check performed on the card's security code. properties: response: $ref: '#/components/schemas/response' type: description: |- Indicates the type of security code. Can have these possible values: * *CVV1* – the security code stored in the magnetic stripe on the card. * *CVV2* – the security code printed on the card. * *ICVV* – the security code stored on the chip of the card. * *DCVV* – a dynamic security code used in some contactless payments when a card or device is tapped against the card reader. enum: - CVV1 - CVV2 - ICVV - DCVV type: string required: - response - type type: object card_swap_hash: description: Contains identifiers for swapping digital wallet tokens between cards. properties: new_card_token: description: Unique identifier of the new card resource to which the digital wallet tokens are assigned. maxLength: 36 minLength: 1 type: string previous_card_token: description: Unique identifier of the existing card resource that has digital wallet tokens assigned to it. maxLength: 36 minLength: 1 type: string required: - new_card_token - previous_card_token type: object card_transition_request: properties: card_token: maxLength: 36 minLength: 1 type: string channel: enum: - API - IVR - FRAUD - ADMIN - SYSTEM type: string reason: maxLength: 255 minLength: 0 type: string reason_code: enum: - '00' - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' - '09' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '86' type: string state: enum: - ACTIVE - LIMITED - SUSPENDED - TERMINATED readOnly: true type: string sync_state_with_dwts: readOnly: true type: boolean token: maxLength: 36 minLength: 1 type: string validations: $ref: '#/components/schemas/ValidationsRequest' required: - card_token - channel - state type: object card_transition_response: properties: barcode: type: string bulk_issuance_token: type: string card: $ref: '#/components/schemas/card_metadata' card_product_token: maxLength: 36 minLength: 0 type: string card_token: maxLength: 36 minLength: 1 type: string channel: enum: - API - IVR - FRAUD - ADMIN - SYSTEM type: string created_time: format: date-time type: string created_timestamp: format: date-time type: string expedite: default: false type: boolean expiration: type: string expiration_time: type: string fulfillment: $ref: '#/components/schemas/CardFulfillmentRequest' fulfillment_status: enum: - ISSUED - ORDERED - REJECTED - SHIPPED - DELIVERED - DIGITALLY_PRESENTED type: string last_four: type: string new_pan_from_card_token: type: string pan: type: string pin_is_set: default: false type: boolean reason: maxLength: 255 minLength: 0 type: string reason_code: enum: - '00' - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' - '09' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '86' type: string reissue_pan_from_card_token: type: string state: enum: - ACTIVE - SUSPENDED - TERMINATED - UNACTIVATED type: string token: maxLength: 36 minLength: 1 type: string type: enum: - fulfillment.issued - state.activated - state.suspended - state.reinstated - state.terminated - state.limited - fulfillment.ordered - fulfillment.rejected - fulfillment.shipped - fulfillment.delivered - fulfillment.digitally_presented readOnly: true type: string user: $ref: '#/components/schemas/cardholder_metadata' user_token: maxLength: 36 minLength: 1 type: string validations: $ref: '#/components/schemas/ValidationsResponse' required: - barcode - card_product_token - card_token - channel - expiration - expiration_time - fulfillment_status - last_four - pan - pin_is_set - state - token - type - user_token type: object card_update_request: properties: expedite: default: false type: boolean fulfillment: $ref: '#/components/schemas/CardFulfillmentRequest' metadata: additionalProperties: type: string type: object token: maxLength: 36 minLength: 1 type: string user_token: maxLength: 36 minLength: 1 type: string required: - token type: object cardholder_authentication_data: description: |- Contains authentication data for 3D Secure and digital wallet token transactions: * `electronic_commerce_indicator` – The level of verification performed. * `verification_result` – The result of the verification. * `verification_value_created_by` – The transaction participant who determined the verification result. * `three_ds_message_version` – The 3D Secure message version used for authentication. * `authentication_method` – The 3D Secure authentication method. * `authentication_status` – The 3D Secure authentication status. * `acquirer_exemption` – Indicates a 3D Secure authentication exemption from the acquirer. * `issuer_exemption` – Indicates a 3D Secure authentication exemption from the issuer. * `cavv_authentication_amount` – CAVV authentication amount. * `raw_cavv_data` – Raw CAVV data provided by the card network. properties: acquirer_exemption: description: |- Indicates 3D Secure authentication exemptions from the acquirer. This array is returned if it is included in the transaction data from the card network. items: type: string type: array authentication_method: description: Specifies the 3D Secure authentication method. type: string authentication_status: description: |- Specifies the status of the 3D Secure authentication: * `ATTEMPTED`: Indicates that 3D Secure authentication was requested and processed by the card network. * `DATA_SHARE_EXEMPTED`: Indicates that 3D Secure authentication was for information only and exempted. * `EXEMPTED`: Indicates that 3D Secure authentication was requested but the challenge was exempted. * `EXEMPTION_CLAIMED`: Indicates that 3D Secure authentication was exempted because acquirer transaction risk analysis (TRA) was already performed. * `SCA_EXEMPTION`: Indicates that 3D Secure authentication was exempted because strong customer authentication (SCA) was already performed. * `SUCCESSFUL`: Indicates that 3D Secure authentication was successful. * `SUCCESSFUL_NON_PAYMENT`: Indicates that 3D Secure non-payment authentication was successful. * `THREEDS_REQUESTER_DATA_SHARE_EXEMPTION`: Status is deprecated and will be removed from a future release of the Marqeta platform. After June 2023, use `DATA_SHARE_EXEMPTION` instead. * `THREEDS_REQUESTER_SCA_EXEMPTION`: Status is deprecated and will be removed in a June 2023 release of the Marqeta platform. After June 2023, use `SCA_EXEMPTION` instead. * `THREEDS_REQUESTER_TRA_EXEMPTION`: Status is deprecated and will be removed in a June 2023 release of the Marqeta platform. After June 2023, use `EXEMPTION_CLAIMED` instead. * `UNAVAILABLE`: ** For Visa transactions, this status indicates that 3D Secure authentication was requested, but Marqeta's access control server (ACS) was not available. ** For Mastercard transactions, this status indicates that 3D Secure authentication was not available. type: string cavv_authentication_amount: description: |- Authentication amount from the cardholder authentication verification value (CAVV) used to validate an authorization. This field is returned if it is included in the transaction data from the card network. To enable this field, contact your Marqeta representative. type: string electronic_commerce_indicator: description: |- Status of the 3D Secure or digital wallet token transaction authentication attempt, as provided by a transaction participant. * `authentication_attempted`: Merchant attempted to authenticate, but either the issuer or the cardholder does not participate in 3D Secure or card tokenization. * `authentication_successful`: Cardholder authentication successful. * `no_authentication`: Non-authenticated e-commerce transaction. type: string issuer_exemption: description: |- Indicates a 3D Secure authentication exemption from the issuer. This field is returned if it is included in the transaction data from the card network. type: string raw_cavv_data: description: |- Raw cardholder authentication verification value provided by the card network. This field is returned if it is included in the transaction data from the card network. To enable this field, contact your Marqeta representative. type: string three_ds_data_quality: type: string three_ds_message_version: description: Specifies the 3D Secure message version used for authentication. type: string three_ds_reference_id: description: The 3D Secure authentication indicator, as provided by the Mastercard card network. type: string verification_result: description: |- Result of cardholder authentication verification value (CAVV) or accountholder authentication value (AAV) verification performed by the card network. * `failed` * `not_present` * `not_provided` * `not_verified` * `not_verified_authentication_outage` * `verified` * `verified_amount_checked` * `verified_amount_greater_than_20_percent`: For Mastercard AAV verification, indicates that the original authentication amount and final authorization amount are mismatched, and that the final authorization amount exceeds the original authentication amount by more than 20%. This 20% margin falls outside Mastercard's suggested tolerance for what a European cardholder might reasonably expect when the total transaction amount is not known in advance. * `verified_amount_less_than_20_percent`: For Mastercard AAV verification, indicates that the original authentication amount and final authorization amount are mismatched, and that the final authorization amount exceeds the original authentication amount by 20% or less. This 20% margin falls within Mastercard's suggested tolerance for what a European cardholder might reasonably expect when the total transaction amount is not known in advance. * `not_verified_mac_key_validation_passed`: For Mastercard only. This field is present when the transaction passes MAC key validation but Dynamic Linking was not performed by the Mastercard card network due to system connectivity issues. * `not_verified_mac_key_validation_failed`: For Mastercard only. This field is present when the transaction fails MAC key validation and Dynamic Linking was not performed by the Mastercard card network due to system connectivity issues. type: string verification_value_created_by: description: Transaction participant who determined the verification result. type: string type: object cardholder_balance: description: Returns general purpose account (GPA) balances for a user or business. properties: available_balance: description: |- 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. type: number balances: additionalProperties: $ref: '#/components/schemas/cardholder_balance' description: Contains GPA balance information, organized by currency code. type: object cached_balance: description: Not currently in use. type: number credit_balance: description: Not currently in use. type: number currency_code: description: Three-digit ISO 4217 currency code. type: string impacted_amount: description: Balance change based on the amount of the transaction. type: number last_updated_time: description: Date and time when the resource was last updated, in UTC. format: date-time type: string ledger_balance: description: |- 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. type: number pending_credits: description: ACH loads that have been accepted, but for which the funding time has not yet elapsed. type: number required: - available_balance - balances - credit_balance - currency_code - last_updated_time - ledger_balance - pending_credits type: object cardholder_balances: properties: gpa: $ref: '#/components/schemas/cardholder_balance' links: items: $ref: '#/components/schemas/link' type: array uniqueItems: true required: - gpa - links type: object cardholder_metadata: description: Contains customer-provided information about the cardholder that performed the transaction. properties: metadata: additionalProperties: type: string description: Associates customer-provided metadata with the cardholder. type: object type: object cardholder_note_request_model: properties: created_by: maxLength: 255 minLength: 0 type: string created_by_user_role: enum: - USER - ADMIN - BANK_USER - BANK_ADMIN - MARQETA_PD - MARQETA_ADMIN type: string description: type: string private: default: false type: boolean token: maxLength: 36 minLength: 1 type: string required: - created_by - description type: object cardholder_note_response_model: properties: created_by: maxLength: 255 minLength: 0 type: string created_by_user_role: enum: - USER - ADMIN - BANK_USER - BANK_ADMIN - MARQETA_PD - MARQETA_ADMIN type: string created_time: format: date-time type: string description: type: string last_modified_time: format: date-time type: string private: default: false type: boolean token: maxLength: 36 minLength: 1 type: string required: - created_by - description type: object cardholder_note_update_request_model: properties: description: type: string required: - description type: object carrier: description: Specifies attributes of the card carrier. properties: logo_file: description: Specifies an image to display on the card carrier. type: string logo_thumbnail_file: description: Specifies a thumbnail-sized rendering of the image specified in the `logo_file` field. type: string message_file: description: Specifies a text file containing a custom message to print on the card carrier. type: string message_line: description: Specifies a custom message that appears on the card carrier. type: string message_line_2: description: Specifies the second line of a custom message that appears on the card carrier. type: string template_id: description: Specifies the card carrier template to use. type: string type: object chargeback_allocation_ack_request: properties: chargeback_token: type: string token: type: string required: - chargeback_token type: object chargeback_funding_source_model: allOf: - $ref: '#/components/schemas/funding_source_model' - properties: credit: type: boolean name: type: string required: - credit - name type: object chargeback_request: properties: amount: exclusiveMinimum: false minimum: 0.01 type: number channel: enum: - GATEWAY - GATEWAY_AUTOMATED - ISSUER - ISSUER_AUTOMATED type: string credit_user: default: true type: boolean currency_code: type: string memo: maxLength: 1024 minLength: 1 type: string pre_initiated: type: boolean reason_code: description: Either 'reason_code' or 'reason_description' is required type: string reason_description: description: Either 'reason_description' or 'reason_code' is required enum: - SERVICE_NOT_PROVIDED_MERCHANDISE_NOT_RECEIVED - CANCELLED_RECURRING_TRANSACTION - NOT_AS_DESCRIBED_OR_DEFECTIVE_MERCHANDISE - FRAUD_MULTIPLE_TRANSACTIONS - FRAUD_TRANSACTION - NO_AUTHORIZATION - LATE_PRESENTMENT - TRANSACTION_NOT_RECOGNIZED - INCORRECT_CURRENCY - INCORRECT_TRANSACTION_CODE - INCORRECT_CURRENCY_OR_TRANSACTION_CODE - INCORRECT_TRANSACTION_AMOUNT - INCORRECT_ACCOUNT_NUMBER - INCORRECT_TRANSACTION_AMOUNT_OR_ACCOUNT_NUMBER - NOT_AUTHORIZED_CARD_PRESENT - NOT_AUTHORIZED_CARD_ABSENT - CREDIT_NOT_PROCESSED - NON_RECEIPT_OF_CASH_OR_LOAD_TRANSACTION_VALUE_AT_ATM - DUPLICATE_PROCESSING_OR_PAID_BY_OTHER_MEANS type: string regulation_type: type: string status: enum: - ARBITRATION - CASE_LOST - CASE_WON - INITIATED - NETWORK_REJECTED - PREARBITRATION - PRE_INITIATED - REPRESENTMENT - WITHDRAWN - WRITTEN_OFF_ISSUER - WRITTEN_OFF_PROGRAM type: string token: maxLength: 36 minLength: 1 type: string transaction_token: maxLength: 36 minLength: 1 type: string required: - amount - channel - transaction_token type: object chargeback_response: description: Contains the chargeback object associated with this transaction if a chargeback has been initiated. properties: amount: description: Amount of the chargeback. exclusiveMinimum: false minimum: 0.01 type: number channel: description: Channel the chargeback came through. enum: - GATEWAY - GATEWAY_AUTOMATED - ISSUER - ISSUER_AUTOMATED type: string created_time: description: |- Date and time when the chargeback was created. Not returned for transactions when the associated chargeback is in the `INITIATED` state. format: date-time type: string credit_user: default: false description: Whether to credit the user for the chargeback amount. type: boolean currency_code: maxLength: 3 minLength: 3 type: string last_modified_time: description: |- Date and time when the chargeback was last modified. Not returned for transactions when the associated chargeback is in the `INITIATED` state. format: date-time type: string memo: description: Additional comments about the chargeback. maxLength: 1024 minLength: 1 type: string network: description: Network handling the chargeback. enum: - MARQETA - DISCOVER - MASTERCARD - PULSE - VISA - AMERICANEXPRESS type: string network_case_id: description: Network-assigned identifier of the chargeback. maxLength: 50 minLength: 0 type: string reason_code: description: Identifies the standardized reason for the chargeback. type: string state: description: State of the case. enum: - INITIATED - REPRESENTMENT - PREARBITRATION - ARBITRATION - CASE_WON - CASE_LOST - NETWORK_REJECTED - WITHDRAWN - RETRIEVAL_REQUEST - RETRIEVAL_RESPONSE type: string token: description: Unique identifier of the chargeback. maxLength: 36 minLength: 1 type: string transaction_token: description: Unique identifier of the transaction being charged back. maxLength: 36 minLength: 1 type: string required: - amount - channel - created_time - credit_user - last_modified_time - network - state - token - transaction_token type: object chargeback_transition_request: properties: amount: description: Representment or prearbitration amount; this is for transitioning to Representment or Prearbitration only exclusiveMinimum: false minimum: 0.01 type: number chargeback_token: maxLength: 36 minLength: 1 type: string reason: maxLength: 3000 minLength: 1 type: string regulation_type: type: string state: enum: - REPRESENTMENT - PREARBITRATION - PREARB_RESPONDED - ARBITRATION - CASE_WON - CASE_LOST - WRITTEN_OFF_ISSUER - WRITTEN_OFF_PROGRAM - ARBITRATION_RESPONSE - ARBITRATION_DECISION - RETRIEVAL_REQUEST - RETRIEVAL_RESPONSE type: string token: maxLength: 36 minLength: 1 type: string type: type: string required: - chargeback_token - state type: object chargeback_transition_response: properties: amount: type: number channel: enum: - GATEWAY - GATEWAY_AUTOMATED - ISSUER - ISSUER_AUTOMATED type: string chargeback_token: maxLength: 36 minLength: 1 type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string previous_state: enum: - INITIATED - REPRESENTMENT - PREARBITRATION - ARBITRATION - CASE_WON - CASE_LOST - NETWORK_REJECTED - WITHDRAWN - ARBITRATION_RESPONSE - ARBITRATION_DECISION type: string reason: maxLength: 1024 minLength: 0 type: string state: enum: - INITIATED - REPRESENTMENT - PREARBITRATION - ARBITRATION - CASE_WON - CASE_LOST - NETWORK_REJECTED - WITHDRAWN - WRITTEN_OFF_ISSUER - WRITTEN_OFF_PROGRAM - ARBITRATION_RESPONSE - ARBITRATION_DECISION type: string token: maxLength: 36 minLength: 0 type: string transaction_token: maxLength: 36 minLength: 0 type: string type: enum: - initiated - representment - prearbitration - arbitration - case.won - case.lost - network.rejected - written.off.issuer - written.off.program type: string required: - channel - chargeback_token - created_time - last_modified_time - previous_state - state - token - type type: object clearing_and_settlement: properties: overdraft_destination: default: GPA description: Default value of GPA does not apply when JIT funding is enabled enum: - GPA - MSA - MERCHANT_CAMPAIGN_ACCOUNT - GLOBAL_OVERDRAFT_ACCOUNT type: string type: object click_to_pay_check_eligibility_response: properties: image_assets: description: List of image assets for the Click to Pay logo if `include_asset` is set to `true` in the request. items: $ref: '#/components/schemas/media_content' type: array is_eligible: default: false description: |- Indicates whether the `bin_prefix` is eligible for Click to Pay. * `true`: The `bin_prefix` is eligible for Click to Pay. * `false`: The `bin_prefix` is not eligible for Click to Pay. type: boolean type: object click_to_pay_enroll_request: properties: basic_auth_password: description: |- Basic auth password to access your callback URL if authentication type is basic. If authentication type is basic, both username and password are required. maxLength: 50 minLength: 20 type: string basic_auth_username: description: |- Basic auth username to access your callback URL if authentication type is basic. If authentication type is basic, both username and password are required. maxLength: 50 minLength: 1 type: string callback_authentication_type: description: |- The type of authentication required for the callback URL. * `OAUTH_BEARER_TOKEN`: OAuth bearer token for the callback URL. * `BASIC_AUTH`: Basic auth username and password for the callback URL. enum: - OAUTH_BEARER_TOKEN - BASIC_AUTH type: string callback_secret_for_signature: description: |- Randomly chosen string used for implementing HMAC-SHA1. HMAC-SHA1 provides an added layer of security by authenticating the message and validating message integrity. Using this functionality requires that your callback endpoint verify the message signature. For information about implementing this functionality, see <>. maxLength: 50 minLength: 20 type: string callback_url: description: The URL to which the Click to Pay request status is sent via webhooks. type: string card_token: description: Unique identifier of the card resource. maxLength: 36 minLength: 1 type: string locale_country: description: |- The user-provided country code. The ISO 3166 country code is a two-letter country code that represents a country. For example, the numeric code for the United States is `US`. The ISO maintains the link:https://www.iso.org/iso-3166-country-codes.html[ISO-3166 country codes, window="_blank"]. maxLength: 2 minLength: 2 type: string locale_language: description: |- The user-provided language choice. The ISO 639-2 language code is a two-letter country code that represents a language. The ISO maintains the link:https://id.loc.gov/vocabulary/iso639-2.html[ISO 639-2 language codes, window="_blank"]. maxLength: 2 minLength: 2 type: string oauth_bearer_token: description: OAuth bearer token to access your callback URL if the `callback_authentication_type` is `OAUTH_BEARER_TOKEN`. type: string user_details: description: User's email address and mobile phone number with country code. items: $ref: '#/components/schemas/click_to_pay_enroll_request_user_details' type: array user_token: description: Unique identifier of the cardholder. maxLength: 36 minLength: 1 type: string required: - card_token - locale_country - locale_language - user_details - user_token type: object click_to_pay_enroll_request_user_details: description: User's email address and mobile phone number with country code. properties: email_address: description: User's email address. type: string mobile_number: $ref: '#/components/schemas/click_to_pay_enroll_request_user_mobile_number' required: - email_address - mobile_number type: object click_to_pay_enroll_request_user_mobile_number: description: User's mobile phone number and country code. properties: country_code: description: User's mobile phone number country code only. type: string phone_number: description: User's mobile phone number without country code. type: string required: - country_code - phone_number type: object click_to_pay_enroll_response: properties: token: description: Unique identifier of the Click to Pay request. maxLength: 36 minLength: 1 type: string type: object click_to_pay_status_response: properties: status: description: |- The status of the Click to Pay request. * `SUCCESS`: The Click to Pay request was successful. * `FAILED`: The Click to Pay request failed. * `RECEIVED`: The Click to Pay request was received. enum: - SUCCESS - FAILED - RECEIVED type: string token: description: Unique identifier of the Click to Pay request, used to track the status of the request. maxLength: 36 type: string token_reference_id: description: Unique identifier of the digital wallet token within the card network. type: string type: object client_access_token_request: properties: application_token: description: Unique identifier of the `application` object. maxLength: 255 minLength: 1 type: string card_token: description: Unique identifier of the card whose sensitive information you want to display. maxLength: 255 minLength: 1 type: string required: - card_token type: object client_access_token_response: properties: application: $ref: '#/components/schemas/Application' card_token: description: Unique identifier of the card whose sensitive information you want to display. type: string created: description: Date and time when the client access token was created, in UTC. format: date-time type: string expires: description: Date and time when the client access token expires, in UTC. format: date-time type: string token: description: Value of the client access token to redeem when displaying sensitive card data. type: string type: object commando_mode_enables: properties: auth_controls: items: type: string type: array ignore_card_suspended_state: default: false type: boolean program_funding_source: type: string use_cache_balance: default: false type: boolean velocity_controls: items: type: string maxItems: 2147483647 minItems: 1 type: array required: - program_funding_source type: object commando_mode_nested_transition: properties: channel: enum: - API - SYSTEM - ADMIN type: string commando_enabled: default: false type: boolean reason: type: string username: type: string required: - channel - commando_enabled type: object commando_mode_response: properties: commando_mode_enables: $ref: '#/components/schemas/commando_mode_enables' created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string current_state: $ref: '#/components/schemas/commando_mode_nested_transition' last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string program_gateway_funding_source_token: type: string real_time_standin_criteria: $ref: '#/components/schemas/real_time_standin_criteria' token: type: string required: - created_time - last_modified_time type: object commando_mode_transition_response: properties: commando_mode_token: type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string name: type: string token: type: string transition: $ref: '#/components/schemas/commando_mode_nested_transition' type: type: string required: - created_time type: object control_token_request: properties: card_token: description: The unique identifier of the card for which you want to generate a control token. maxLength: 36 minLength: 1 type: string controltoken_type: description: |- Specifies the type of action completed by this request. *WARNING:* Sending a request to this endpoint with a `REVEAL_PIN` control token requires PCI DSS compliance. The lifespan of the control token depends on the token type: * *SET_PIN:* 60 minutes * *REVEAL_PIN:* 5 minutes enum: - SET_PIN - REVEAL_PIN type: string required: - card_token type: object control_token_response: properties: control_token: description: |- Unique value generated as a result of issuing a `POST` request to the `/pins/controltoken` endpoint. This value cannot be updated. type: string required: - control_token type: object currency_conversion: description: Contains information about currency conversion. properties: network: $ref: '#/components/schemas/network' type: object customer_due_diligence_request: properties: answer: type: string question: type: string token: maxLength: 36 minLength: 1 type: string required: - answer - question type: object customer_due_diligence_response: properties: account_token: type: string answer: type: string bank: type: string question: type: string token: type: string type: type: string required: - account_token - answer - bank - question - token - type type: object customer_due_diligence_update_response: properties: answer: type: string type: object device: description: Contains information related to the device being provisioned. properties: device_id: description: Identity number of the device. type: string ip_address: description: Device's IP address. type: string language_code: description: Language the device is configured to use. type: string location: description: Geographic coordinates of the device. type: string name: description: Name of the device. type: string phone_number: description: Device's telephone number. type: string token: description: Unique identifier of the device object. type: string type: description: Type of device being provisioned. type: string type: object digital_service_provider: properties: cvm_authentication_indicator: type: string cvm_authentication_method: type: string digital_service_indicator: type: string digital_service_provider_identifier_1: type: string digital_service_provider_identifier_2: type: string digital_service_provider_type_1: type: string digital_service_provider_type_2: type: string first_authentication_factor: type: string first_authentication_factor_name: enum: - NO_AUTHENTICATION - DEVICE_BOUND_PAYMENT - USERNAME_PASSWORD - PASSCODE_OR_PASSWORD - BEHAVIORAL_BIOMETRICS - BIOMETRIC_FINGERPRINT - BIOMETRIC_FACE - BIOMETRIC_IRIS - BIOMETRIC_VOICE - OTHER_BIOMETRICS - KNOWLEDGE_BASED - IN_APP_LOGIN - OTP_SMS - OTP_EMAIL - OTHER_OTP - OTHER type: string second_authentication_factor: type: string second_authentication_factor_name: enum: - NO_AUTHENTICATION - DEVICE_BOUND_PAYMENT - USERNAME_PASSWORD - PASSCODE_OR_PASSWORD - BEHAVIORAL_BIOMETRICS - BIOMETRIC_FINGERPRINT - BIOMETRIC_FACE - BIOMETRIC_IRIS - BIOMETRIC_VOICE - OTHER_BIOMETRICS - KNOWLEDGE_BASED - IN_APP_LOGIN - OTP_SMS - OTP_EMAIL - OTHER_OTP - OTHER type: string token_service_provider_id: type: string type: object digital_wallet_android_pay_provision_request: properties: card_token: description: Unique identifier of the card resource to use for the provisioning request. maxLength: 36 minLength: 1 type: string device_id: description: Unique identifier of the user's Google device, as provided by Google during the provisioning process. maxLength: 24 minLength: 1 type: string device_type: description: Type of device into which the digital wallet token will be provisioned. enum: - MOBILE_PHONE - WATCH - TABLET - WEARABLE_DEVICE - HOUSEHOLD_DEVICE - AUTOMOBILE_DEVICE type: string provisioning_app_version: description: |- Version of the application making the provisioning request. Used for debugging and fraud prevention. maxLength: 50 minLength: 1 type: string wallet_account_id: description: User's Google Wallet account ID, as provided by Google during the provisioning process. maxLength: 50 minLength: 1 type: string required: - card_token - device_id - device_type - provisioning_app_version - wallet_account_id type: object digital_wallet_android_pay_provision_response: properties: card_token: description: Unique identifier of the card resource to use for the provisioning request. type: string created_time: description: Date and time when the digital wallet provisioning request was created, in UTC. format: date-time type: string last_modified_time: description: Date and time when the digital wallet token provisioning request was last updated, in UTC. format: date-time type: string push_tokenize_request_data: $ref: '#/components/schemas/android_push_tokenize_request_data' required: - card_token - created_time - last_modified_time - push_tokenize_request_data type: object digital_wallet_apple_pay_provision_request: properties: card_token: description: Unique identifier of the card resource to use for the provisioning request. maxLength: 36 minLength: 1 type: string certificates: description: |- Base64-encoded leaf and sub-CA certificates provided by Apple. The first element of the array should be the leaf certificate, followed by the sub-CA. items: description: |- Base64-encoded leaf and sub-CA certificates provided by Apple. The first element of the array should be the leaf certificate followed by the sub-CA. type: string type: array device_type: description: Type of device into which the digital wallet token will be provisioned. enum: - MOBILE_PHONE - WATCH - TABLET - WEARABLE_DEVICE - HOUSEHOLD_DEVICE - AUTOMOBILE_DEVICE type: string nonce: description: One-time-use nonce provided by Apple for security purposes. type: string nonce_signature: description: Apple-provided signature to the nonce. type: string provisioning_app_version: description: |- Version of the application making the provisioning request. Used for debugging and fraud prevention. maxLength: 50 minLength: 1 type: string required: - card_token - certificates - device_type - nonce - nonce_signature - provisioning_app_version type: object digital_wallet_apple_pay_provision_response: properties: activation_data: description: Cryptographic one-time passcode conforming to the payment network operator or service provider specifications. type: string card_token: description: Unique identifier of the card resource to use for the provisioning request. type: string created_time: description: Date and time when the digital wallet provisioning request was created, in UTC. format: date-time type: string encrypted_pass_data: description: Payload encrypted with a shared key derived from the Apple Public Certificates and the generated ephemeral private key. type: string ephemeral_public_key: description: Ephemeral public key used for the provisioning attempt. type: string last_modified_time: description: Date and time when the digital wallet token provisioning request was last updated, in UTC. format: date-time type: string required: - activation_data - card_token - created_time - encrypted_pass_data - ephemeral_public_key - last_modified_time type: object digital_wallet_samsung_pay_provision_request: properties: card_token: description: Unique identifier of the card resource to use for the provisioning request. maxLength: 36 minLength: 1 type: string device_id: description: User's Samsung device unique identifier, as provided by Samsung during the provisioning process. maxLength: 24 minLength: 1 type: string device_type: description: Type of device into which the digital wallet token will be provisioned. enum: - MOBILE_PHONE - WATCH - TABLET - WEARABLE_DEVICE - HOUSEHOLD_DEVICE - AUTOMOBILE_DEVICE type: string provisioning_app_version: description: |- Version of the application making the provisioning request. Used for debugging and fraud prevention. maxLength: 50 minLength: 1 type: string wallet_user_id: description: User's Samsung Wallet account ID, as provided by Samsung during the provisioning process. maxLength: 50 minLength: 1 type: string required: - card_token - device_id - device_type - provisioning_app_version - wallet_user_id type: object digital_wallet_samsung_pay_provision_response: properties: card_token: description: Unique identifier of the card resource to use for the provisioning request. type: string created_time: description: Date and time when the digital wallet provisioning request was created, in UTC. format: date-time type: string last_modified_time: description: Date and time when the digital wallet token provisioning request was last updated, in UTC. format: date-time type: string push_tokenize_request_data: $ref: '#/components/schemas/samsung_push_tokenize_request_data' required: - card_token - created_time - last_modified_time - push_tokenize_request_data type: object digital_wallet_token: description: |- Contains information about the digital wallet that funded the transaction. Returned for all transactions funded by a digital wallet or related to digital wallet token provisioning. For more on digital wallets, see the <> API reference and <> developer guide. properties: address_verification: $ref: '#/components/schemas/address_verification' card_token: description: Unique identifier of the card. type: string created_time: description: Date and time when the digital wallet token object was created, in UTC. format: date-time type: string device: $ref: '#/components/schemas/device' fulfillment_status: description: |- Digital wallet token's provisioning status. For fulfillment status descriptions, see <>. type: string issuer_eligibility_decision: description: |- The Marqeta platform's decision as to whether the digital wallet token should be provisioned. * *0000* – The token should be provisioned. * *token.activation.verification.required* – Provisioning is pending; further action is required for completion. For all other values, check the value of the `fulfillment_status` field to definitively ascertain the provisioning outcome. *NOTE:* The value `invalid.cid` indicates an invalid CVV2 number. type: string last_modified_time: description: Date and time when the digital wallet token object was last modified, in UTC. format: date-time type: string metadata: $ref: '#/components/schemas/digital_wallet_token_metadata' state: description: |- State of the digital wallet token. For state descriptions, see <>. type: string state_reason: description: Reason why the digital wallet token transitioned to its current state. type: string token: description: Unique identifier of the digital wallet token. type: string token_service_provider: $ref: '#/components/schemas/token_service_provider' transaction_device: $ref: '#/components/schemas/transaction_device' user: $ref: '#/components/schemas/user_card_holder_response' wallet_provider_profile: $ref: '#/components/schemas/wallet_provider_profile' type: object digital_wallet_token_address_verification: properties: validate: default: true description: Specifies whether or not the address used for address verification is valid. type: boolean type: object digital_wallet_token_hash: description: Contains identifiers of the digital wallet token resource and the card resource. properties: card_token: description: Unique identifier of the card resource to use for the provisioning request. maxLength: 36 minLength: 1 type: string token: description: Unique identifier of the digital wallet token resource. maxLength: 36 minLength: 1 type: string required: - token type: object digital_wallet_token_metadata: description: Contains additional information about the digital wallet token. properties: cardproduct_preferred_notification_language: description: |- Language specified in the `config.transaction_controls.notification_language` field of the card product: * *ces* – Czech * *deu* – German * *eng* – English * *fra* – French * *grc* – Greek * *ita* – Italian * *nld* – Dutch * *pol* – Polish * *por* – Portuguese * *rou* – Romanian * *spa* – Spanish * *swe* – Swedish By default, notifications are sent in English. The ISO maintains the link:https://www.iso.org/iso-3166-country-codes.html[full list of ISO 3166 two- and three-digit numeric country codes, window="_blank"]. type: string issuer_product_config_id: description: Unique identifier of the product configuration on the Marqeta platform. type: string type: object digital_wallet_token_transition_request: properties: channel: description: Mechanism by which the transition was initiated. enum: - TOKEN_SERVICE_PROVIDER - TOKEN_SERVICE_PROVIDER_API - DIGITAL_WALLET - API - IVR - FRAUD - ADMIN - SYSTEM type: string digital_wallet_token: $ref: '#/components/schemas/digital_wallet_token_hash' reason: description: The reason for the transition. maxLength: 255 minLength: 0 type: string reason_code: description: |- Standard code describing the reason for the transition. *NOTE:* This field is required if your program uses v2 of the `user_card_state_version`, which is a program-specific configuration value that is managed by Marqeta and cannot be accessed via the API. To learn more about the `user_card_state_version` program configuration, contact your Marqeta representative. * *00:* Object activated for the first time * *01:* Requested by you * *02:* Inactivity over time * *03:* This address cannot accept mail or the addressee is unknown * *04:* Negative account balance * *05:* Account under review * *06:* Suspicious activity was identified * *07:* Activity outside the program parameters was identified * *08:* Confirmed fraud was identified * *09:* Matched with an Office of Foreign Assets Control list * *10:* Card was reported lost * *11:* Card information was cloned * *12:* Account or card information was compromised * *13:* Temporary status change while on hold/leave * *14:* Initiated by Marqeta * *15:* Initiated by issuer * *16:* Card expired * *17:* Failed KYC * *18:* Changed to `ACTIVE` because information was properly validated * *19:* Changed to `ACTIVE` because account activity was properly validated * *20:* Change occurred prior to the normalization of reason codes * *21:* Initiated by a third party, often a digital wallet provider * *22:* PIN retry limit reached * *23:* Card was reported stolen * *24:* Address issue * *25:* Name issue * *26:* SSN issue * *27:* DOB issue * *28:* Email issue * *29:* Phone issue * *30:* Account/fulfillment mismatch * *31:* Other reason * *32:* Unblock request * *86:* Notification of death enum: - '00' - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' - '09' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '86' type: string state: description: |- Specifies the state to which the digital wallet token will transition. The original state is `REQUESTED`. You cannot modify the state if its current value is either `REQUEST_DECLINED` or `TERMINATED`. enum: - ACTIVE - SUSPENDED - TERMINATED type: string token: description: |- The unique identifier of the digital wallet token transition (not the identifier of the digital wallet token itself). If you do not include a value for the `token` field, the system will generate one automatically. This value is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. maxLength: 36 minLength: 1 type: string token_reference_id: description: |- The unique identifier of the digital wallet token within the card network. The `token_reference_id` is unique at the card network level. type: string required: - digital_wallet_token - state type: object digital_wallet_token_transition_response: properties: card_swap: $ref: '#/components/schemas/card_swap_hash' channel: description: Mechanism by which the transition was initiated. enum: - TOKEN_SERVICE_PROVIDER - DIGITAL_WALLET - API - IVR - FRAUD - ADMIN - SYSTEM - TOKEN_SERVICE_PROVIDER_API type: string created_time: description: Date and time when the transition was created, in UTC. format: date-time type: string digital_wallet_token: $ref: '#/components/schemas/digital_wallet_token_hash' fulfillment_status: description: Provisioning status of the digital wallet token. enum: - DECISION_RED - DECISION_YELLOW - DECISION_GREEN - REJECTED - PROVISIONED type: string reason: description: Reason for the transition. maxLength: 255 minLength: 0 type: string reason_code: description: |- Standard code describing the reason for the transition: * *00:* Object activated for the first time * *01:* Requested by you * *02:* Inactivity over time * *03:* This address cannot accept mail or the addressee is unknown * *04:* Negative account balance * *05:* Account under review * *06:* Suspicious activity was identified * *07:* Activity outside the program parameters was identified * *08:* Confirmed fraud was identified * *09:* Matched with an Office of Foreign Assets Control list * *10:* Card was reported lost * *11:* Card information was cloned * *12:* Account or card information was compromised * *13:* Temporary status change while on hold/leave * *14:* Initiated by Marqeta * *15:* Initiated by issuer * *16:* Card expired * *17:* Failed KYC * *18:* Changed to `ACTIVE` because information was properly validated * *19:* Changed to `ACTIVE` because account activity was properly validated * *20:* Change occurred prior to the normalization of reason codes * *21:* Initiated by a third party, often a digital wallet provider * *22:* PIN retry limit reached * *23:* Card was reported stolen * *24:* Address issue * *25:* Name issue * *26:* SSN issue * *27:* DOB issue * *28:* Email issue * *29:* Phone issue * *30:* Account/fulfillment mismatch * *31:* Other reason * *32:* Unblock request * *86:* Notification of death enum: - '00' - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' - '09' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '86' type: string state: description: Specifies the state to which the digital wallet token is transitioning. enum: - REQUESTED - REQUEST_DECLINED - ACTIVE - SUSPENDED - TERMINATED type: string token: description: Unique identifier of the digital wallet token transition, and not the identifier of the digital wallet token itself. maxLength: 36 minLength: 1 type: string type: description: |- Type of digital wallet token transition. `state.activated`, for example. maxLength: 36 minLength: 0 readOnly: true type: string required: - channel - digital_wallet_token - fulfillment_status - state - token - type type: object digital_wallet_x_pay_provision_request: properties: card_token: description: Unique identifier of the card resource to use for the provisioning request. maxLength: 36 minLength: 1 type: string device_id: description: Unique identifier of the user's XPay device, as provided by XPay during the provisioning process. maxLength: 24 minLength: 1 type: string device_type: description: Type of device into which the digital wallet token will be provisioned. enum: - MOBILE_PHONE - WATCH - TABLET - WEARABLE_DEVICE - HOUSEHOLD_DEVICE - AUTOMOBILE_DEVICE type: string provisioning_app_version: description: |- Version of the application making the provisioning request. Used for debugging and fraud prevention. maxLength: 50 minLength: 1 type: string token_requestor_id: description: |- Unique numerical identifier of the digital wallet token requestor within the card network. These ID numbers map to `token_requestor_name` field values as follows: *Mastercard* * 50110030273 – `APPLE_PAY` * 50120834693 – `ANDROID_PAY` * 50139059239 – `SAMSUNG_PAY` *Visa* * 40010030273 – `APPLE_PAY` * 40010075001 – `ANDROID_PAY` * 40010043095 – `SAMSUNG_PAY` * 40010075196 – `MICROSOFT_PAY` * 40010075338 – `VISA_CHECKOUT` * 40010075449 – `FACEBOOK` * 40010075839 – `NETFLIX` * 40010077056 – `FITBIT_PAY` * 40010069887 – `GARMIN_PAY` maxLength: 11 minLength: 0 type: string wallet_account_id: description: User's XPay account identifier, as provided by XPay during the provisioning process. maxLength: 50 minLength: 1 type: string required: - card_token - device_id - device_type - provisioning_app_version - token_requestor_id - wallet_account_id type: object digital_wallet_x_pay_provision_response: properties: card_token: description: Unique identifier of the card resource to use for the provisioning request. type: string created_time: description: Date and time when the digital wallet provisioning request was created, in UTC. format: date-time type: string last_modified_time: description: Date and time when the digital wallet token provisioning request was last updated, in UTC. format: date-time type: string push_tokenize_request_data: $ref: '#/components/schemas/xpay_push_tokenize_request_data' required: - card_token - created_time - last_modified_time - push_tokenize_request_data type: object direct_deposit_account_response: properties: account_number: maxLength: 17 minLength: 13 type: string allow_immediate_credit: default: false type: boolean business_token: maxLength: 36 minLength: 36 type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string routing_number: maxLength: 9 minLength: 9 type: string state: maxLength: 10 minLength: 6 type: string token: maxLength: 36 minLength: 36 type: string type: maxLength: 36 minLength: 7 type: string user_token: maxLength: 36 minLength: 36 type: string required: - account_number - allow_immediate_credit - business_token - created_time - last_modified_time - routing_number - state - token - user_token type: object direct_deposit_account_transition_response: properties: account_token: maxLength: 36 minLength: 36 type: string business_token: maxLength: 36 minLength: 36 type: string channel: maxLength: 10 minLength: 6 type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string reason: maxLength: 255 minLength: 0 type: string state: maxLength: 10 minLength: 6 type: string token: maxLength: 36 minLength: 36 type: string user_token: maxLength: 36 minLength: 36 type: string required: - account_token - business_token - channel - created_time - reason - state - token - user_token type: object direct_deposit_funding_source_model: allOf: - $ref: '#/components/schemas/funding_source_model' - properties: name: type: string required: - name type: object early_funds_request_model: properties: bank_transfer_token: maxLength: 36 minLength: 0 type: string type: object echo_ping_request: properties: payload: description: Payload of the ping request. type: string token: description: Unique identifier of the ping request. type: string type: object echo_ping_response: properties: id: type: string payload: type: string success: default: false type: boolean type: object error_message_from_web_push_provisioning_request: properties: error_code: description: Code for the error that occurred. example: '400401' type: string error_message: description: Descriptive error message. example: 'Invalid input(s): invalid user token' type: string required: - error_code - error_message type: object expiration_offset: properties: unit: description: specify if a value is provided; default is card product expiration offset unit enum: - YEARS - MONTHS - DAYS - HOURS - MINUTES - SECONDS type: string value: description: specify if unit is provided; default is card product expiration offset value format: int32 type: integer type: object fee: description: Contains details about the fee. properties: amount: description: Amount of the fee. type: number created_time: description: Date and time when the `fees` object was created, in UTC. format: date-time type: string currency_code: description: Three-digit ISO 4217 currency code. type: string last_modified_time: description: Date and time when the `fees` object was last modified, in UTC. format: date-time type: string memo: description: Optional property to be used as Dispaly field when the fee is applied 255 char max type: string name: description: Name of the fee. type: string tags: description: Descriptive metadata about the fee. type: string token: description: Unique identifier of the `fees` object. type: string required: - amount - created_time - currency_code - last_modified_time - name - token type: object fee_attributes: properties: reason: type: string region: type: string status: type: string transaction_type: type: string type: object fee_detail: description: Contains details about a fee. properties: fee: $ref: '#/components/schemas/fee' memo: description: Additional text describing the fee. maxLength: 99 minLength: 1 type: string overrideAmount: description: Dynamic fee amount that overrides the `fee.amount` field value. type: number tags: description: Descriptive metadata about the fee. maxLength: 255 minLength: 0 type: string token: description: Unique identifier of the fee. maxLength: 36 minLength: 1 type: string transaction_token: description: Unique identifier of the fee transaction. type: string required: - fee - token - transaction_token type: object fee_model: description: |- Contains attributes that define characteristics of one or more fees. This array is returned in the response when it is included in the request. properties: memo: description: Additional text describing the fee. maxLength: 99 minLength: 1 type: string overrideAmount: description: Dynamic fee amount that overrides the `fee.amount` field value. type: number tags: description: Descriptive metadata about the fee. maxLength: 255 minLength: 0 type: string token: description: Unique identifier of the fee. maxLength: 36 minLength: 1 type: string required: - token type: object fee_refund_request: properties: original_fee_transaction_token: type: string tags: type: string type: object fee_refund_response: properties: created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string fee: $ref: '#/components/schemas/fee' memo: maxLength: 99 minLength: 1 type: string original_fee_transaction_token: type: string overrideAmount: type: number state: type: string tags: maxLength: 255 minLength: 0 type: string token: description: 36 char max maxLength: 36 minLength: 1 type: string transaction_token: type: string required: - created_time - fee - token - transaction_token type: object fee_request: properties: active: default: true type: boolean amount: type: number category: enum: - STANDALONE - REALTIME type: string currency_code: type: string fee_attributes: $ref: '#/components/schemas/fee_attributes' memo: maxLength: 255 minLength: 0 type: string name: maxLength: 50 minLength: 1 type: string tags: maxLength: 255 minLength: 1 type: string token: maxLength: 36 minLength: 1 type: string type: enum: - FLAT - PERCENTAGE type: string required: - amount - currency_code - name type: object fee_response: properties: active: readOnly: true type: boolean amount: type: number category: readOnly: true type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time readOnly: true type: string currency_code: readOnly: true type: string fee_attributes: $ref: '#/components/schemas/fee_attributes' last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time readOnly: true type: string memo: description: 255 char max type: string name: description: 50 char max type: string tags: description: 255 char max type: string token: description: 36 char max type: string type: readOnly: true type: string required: - active - amount - created_time - currency_code - last_modified_time - name - token type: object fee_transfer_request: properties: business_token: description: Required if 'user_token' is null maxLength: 36 minLength: 1 type: string fees: items: $ref: '#/components/schemas/fee_model' type: array tags: maxLength: 255 minLength: 0 type: string token: maxLength: 36 minLength: 1 type: string user_token: description: Required if 'business_token' is null maxLength: 36 minLength: 1 type: string required: - business_token - fees - user_token type: object fee_transfer_response: description: Contains information about a fee charge, including the amount, currency code, and user or business token. properties: business_token: description: Specifies the business account holder to which the fee applies. maxLength: 36 minLength: 1 type: string created_time: description: Date and time when the `fee_charge` object was created, in UTC. format: date-time type: string fees: description: Contains attributes that define characteristics of one or more fees. items: $ref: '#/components/schemas/fee_detail' type: array tags: description: |- Metadata about the fee charge. This field is returned if it exists in the resource. maxLength: 255 minLength: 0 type: string token: description: Unique identifier of the fee transfer. maxLength: 36 minLength: 1 type: string user_token: description: Specifies the user account holder to which the fee applies. maxLength: 36 minLength: 1 type: string required: - business_token - created_time - fees - token - user_token type: object fee_update_request: properties: active: default: true type: boolean amount: type: number category: enum: - STANDALONE - REALTIME type: string currency_code: type: string fee_attributes: $ref: '#/components/schemas/fee_attributes' memo: maxLength: 255 minLength: 0 type: string name: maxLength: 50 minLength: 1 type: string tags: maxLength: 255 minLength: 1 type: string type: enum: - FLAT - PERCENTAGE type: string type: object financial_request_model: properties: amount: type: number card_acceptor: $ref: '#/components/schemas/card_acceptor_model' card_token: maxLength: 36 minLength: 1 type: string cash_back_amount: type: number is_pre_auth: default: false type: boolean mid: maxLength: 50 minLength: 1 type: string pin: maxLength: 15 minLength: 1 type: string transaction_options: $ref: '#/components/schemas/transaction_options' webhook: $ref: '#/components/schemas/webhook' required: - amount - card_acceptor - card_token - mid type: object flex: description: Contains information about a Flexible Credential transaction. properties: action: description: Indicates whether the Flexible Credential transaction object is actionable (`inquiry`) or merely informative (`advice`). enum: - inquiry - advice type: string eligible: description: Indicates whether or not the transaction is eligible for Flexible Credential transactions. type: string eligible_products: description: |- Specifies which of the payment instrument's credentials is eligible for this transaction: * A value of `DEBIT` indicates the primary credential. * A value of `LOAN` indicates the secondary credential. items: type: string type: array secondary_credential_identifier: description: Identifies the secondary credential used in the transaction, if applicable. type: string selected_product: description: Indicates the eligible product that was used in the transaction. type: string type: object fraud_view: description: Contains one or more fraud determinations by the card network that apply to either the transaction or the cardholder's account. properties: issuer_processor: $ref: '#/components/schemas/issuer_fraud_view' network: $ref: '#/components/schemas/network_fraud_view' network_account_intelligence_score: $ref: '#/components/schemas/network_account_intelligence_score' type: object fulfillment_address_request: properties: address1: maxLength: 255 minLength: 0 type: string address2: maxLength: 255 minLength: 0 type: string city: maxLength: 40 minLength: 0 type: string country: maxLength: 40 minLength: 0 type: string first_name: maxLength: 40 minLength: 0 type: string last_name: maxLength: 40 minLength: 0 type: string middle_name: maxLength: 40 minLength: 0 type: string phone: maxLength: 20 minLength: 0 type: string postal_code: maxLength: 10 minLength: 0 type: string state: maxLength: 32 minLength: 0 type: string zip: maxLength: 10 minLength: 0 type: string type: object funding: description: Contains funding information for the transaction, including funding amount, type, and time. properties: amount: description: Amount of funds loaded into the GPA. type: number gateway_log: $ref: '#/components/schemas/gateway_log_model' source: $ref: '#/components/schemas/funding_source_model' source_address: $ref: '#/components/schemas/CardholderAddressResponse' required: - source type: object funding_account_response_model: properties: account_suffix: type: string account_type: type: string active: default: false type: boolean business_token: type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string date_sent_for_verification: format: date-time type: string date_verified: format: date-time type: string exp_date: type: string is_default_account: default: false type: boolean last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string link_partner_account_reference_token: type: string name_on_account: type: string partner: type: string token: type: string type: type: string user_token: type: string verification_notes: type: string verification_override: default: false type: boolean verification_status: type: string required: - created_time - last_modified_time type: object funding_source_model: description: Contains funding source information for the transaction, including the funding type and time. discriminator: mapping: bankaccount: '#/components/schemas/bank_account_funding_source_model' chargeback: '#/components/schemas/chargeback_funding_source_model' directdeposit: '#/components/schemas/direct_deposit_funding_source_model' paymentcard: '#/components/schemas/payment_card_funding_source_model' program: '#/components/schemas/program_funding_source_model' programgateway: '#/components/schemas/program_gateway_funding_source_model' propertyName: type properties: active: default: false description: Whether the funding source is active. type: boolean created_time: description: Date and time when the funding source was created, in UTC. format: date-time type: string is_default_account: default: false description: Whether the GPA order unload's funding source is the default funding account. type: boolean last_modified_time: description: Date and time when the funding source was last modified, in UTC. format: date-time type: string token: description: Unique identifier of the funding source. type: string type: description: Funding type of the funding source. type: string required: - active - created_time - is_default_account - last_modified_time - token - type type: object gateway_log_model: description: Contains information from the JIT Funding gateway in response to a funding request. properties: duration: description: Length of time in milliseconds that the gateway took to respond to a funding request. format: int64 type: integer message: description: |- 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. type: string order_number: description: Customer order number, same value as `transaction.token`. type: string response: $ref: '#/components/schemas/gateway_response' timed_out: default: false description: Whether the gateway sent a response (`true`) or timed out (`false`). type: boolean transaction_id: description: Customer-defined identifier for the transaction. type: string required: - message - order_number - transaction_id type: object gateway_program_custom_header_update_request: properties: custom_header: additionalProperties: type: string description: Custom headers type: object type: object gateway_program_funding_source_request: properties: active: type: boolean basic_auth_password: maxLength: 100 minLength: 20 type: string basic_auth_username: maxLength: 50 minLength: 1 type: string custom_header: additionalProperties: type: string description: Custom headers type: object name: maxLength: 50 minLength: 1 type: string timeout_millis: description: Total timeout in milliseconds for gateway processing format: int64 maximum: 7000 minimum: 1000 type: integer token: maxLength: 36 minLength: 1 type: string url: maxLength: 250 minLength: 0 type: string use_mtls: default: false description: Use MTLS for funding request type: boolean required: - basic_auth_password - basic_auth_username - name - url type: object gateway_program_funding_source_response: properties: account: type: string active: type: boolean basic_auth_password: description: 50 char max. Required if URL is present. Minimum 20 chars with upper and lowercase letters, numbers, and symbols type: string basic_auth_username: description: 50 char max. Required if URL is present type: string created_time: format: date-time type: string custom_header: additionalProperties: type: string description: Custom headers to be passed along with request type: object last_modified_time: format: date-time type: string name: maxLength: 50 minLength: 1 type: string timeout_millis: description: Total timeout in milliseconds for gateway processing format: int64 type: integer token: maxLength: 36 minLength: 1 type: string url: description: 250 char max. Empty string (disabled). Must be HTTPS. type: string use_mtls: default: false description: Use MTLS for funding request type: boolean version: type: string required: - account - basic_auth_password - basic_auth_username - created_time - custom_header - last_modified_time - name - timeout_millis - token - url - use_mtls - version type: object gateway_program_funding_source_update_request: properties: active: type: boolean basic_auth_password: description: Required if URL is present; must contain upper and lowercase letters, numbers, and symbols maxLength: 100 minLength: 20 type: string basic_auth_username: description: Required if URL is present maxLength: 50 minLength: 1 type: string custom_header: additionalProperties: type: string description: Custom headers type: object name: maxLength: 50 minLength: 1 type: string timeout_millis: description: Total timeout in milliseconds for gateway processing format: int64 maximum: 7000 minimum: 1000 type: integer url: description: Empty string (disabled); must be HTTPS maxLength: 250 minLength: 0 type: string use_mtls: default: false description: Use MTLS for funding request type: boolean required: - basic_auth_password - basic_auth_username - url type: object gateway_response: description: Contains information from the gateway in response to a funding request. properties: code: description: Code received from the gateway. type: string data: $ref: '#/components/schemas/jit_program_response' required: - code type: object gpa: description: Defines the type of order. properties: reload_amount: description: |- Available balance on the card after the reload has completed. This value must be greater than or equal to the value of `trigger_amount`. Note that this is not the same as the amount added to the card, which will vary from reload to reload. exclusiveMinimum: false minimum: 0.01 type: number trigger_amount: description: |- Threshold that determines when the reload happens. The reload is triggered when the card balance falls below this amount. exclusiveMinimum: false minimum: 0.01 type: number required: - reload_amount - trigger_amount type: object gpa_request: properties: amount: type: number business_token: description: Required if 'user_token' is null maxLength: 36 minLength: 1 type: string currency_code: type: string fees: items: $ref: '#/components/schemas/fee_model' type: array funding_source_address_token: maxLength: 36 minLength: 1 type: string funding_source_token: maxLength: 36 minLength: 1 type: string memo: maxLength: 99 minLength: 1 type: string tags: maxLength: 255 minLength: 1 type: string token: maxLength: 36 minLength: 1 type: string user_token: description: Required if 'business_token' is null maxLength: 36 minLength: 1 type: string required: - amount - currency_code - funding_source_token type: object gpa_response: description: |- Contains information about a GPA order, including fees, funding sources, and addresses. See <> for more information. properties: amount: description: Amount funded. type: number business_token: description: |- Unique identifier of the business. This field is returned if it exists in the resource. type: string created_time: description: Date and time when the GPA order was created, in UTC. format: date-time type: string currency_code: description: Three-digit ISO 4217 currency code. type: string fees: description: |- List of fees associated with the funding transaction. This array is returned if it exists in the resource. items: $ref: '#/components/schemas/fee_detail' type: array funding: $ref: '#/components/schemas/funding' funding_source_address_token: description: Unique identifier of the funding source address to use for this order. type: string funding_source_token: description: Unique identifier of the funding source to use for this order. type: string gateway_message: description: |- Message about the status of the funding request. Useful for determining whether it was approved and completed successfully, declined by the gateway, or timed out. This field is returned if it exists in the resource. type: string gateway_token: description: |- Unique identifier of the JIT Funding request and response. This field is returned if it exists in the resource. format: int64 type: integer jit_funding: $ref: '#/components/schemas/jit_funding_api' last_modified_time: description: Date and time when the GPA order was last modified, in UTC. format: date-time type: string memo: description: |- Additional descriptive text. This field is returned if it exists in the resource. type: string response: $ref: '#/components/schemas/response' state: description: Current status of the funding transaction. type: string tags: description: |- Comma-delimited list of tags describing the GPA order. This field is returned if it exists in the resource. type: string token: description: Unique identifier of the GPA order. type: string transaction_token: description: Unique identifier of the transaction being funded. type: string user_token: description: |- Unique identifier of the user resource. This field is returned if it exists in the resource. type: string required: - amount - created_time - currency_code - funding - funding_source_token - last_modified_time - response - state - token - transaction_token type: object gpa_returns: description: Contains information about a GPA unload order. properties: amount: description: Amount of funds returned to the funding source. type: number created_time: description: Date and time when the GPA unload order was created, in UTC. format: date-time type: string funding: $ref: '#/components/schemas/funding' funding_source_address_token: description: Identifies the funding source used for this order. type: string funding_source_token: description: Identifies the funding source used for this order. type: string jit_funding: $ref: '#/components/schemas/jit_funding_api' last_modified_time: description: Date and time when the GPA unload order was last modified, in UTC. format: date-time type: string memo: description: Additional descriptive text. type: string original_order_token: description: Identifies the original GPA order. type: string response: $ref: '#/components/schemas/response' state: description: Current status of the GPA unload order. type: string tags: description: Comma-delimited list of tags describing the GPA order. type: string token: description: Unique identifier of the GPA unload order. type: string transaction_token: description: Unique identifier of the transaction. type: string required: - amount - created_time - funding - funding_source_token - last_modified_time - response - state - token - transaction_token type: object hold_increase: properties: type: default: AMOUNT enum: - AMOUNT - PERCENT - UP_TO_LIMIT type: string value: type: number required: - type - value type: object images: description: Specifies personalized images that appear on the card. properties: card: $ref: '#/components/schemas/images_card' carrier: $ref: '#/components/schemas/ImagesCarrier' carrier_return_window: $ref: '#/components/schemas/images_carrier_return_window' signature: $ref: '#/components/schemas/images_signature' type: object images_card: description: Specifies personalized images that appear on the card. properties: name: description: Specifies a PNG image to display on the card. type: string thermal_color: description: Specifies the color of the image displayed on the card. type: string type: object images_carrier_return_window: description: Specifies a custom image to display in the return address window of the card carrier envelope. properties: name: description: Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. type: string type: object images_signature: description: Specifies an image of the cardholder's signature. properties: name: description: Specifies a PNG image of the cardholder's signature. type: string type: object in_app_provisioning: properties: address_verification: $ref: '#/components/schemas/digital_wallet_token_address_verification' enabled: default: false description: Specifies if in-app provisioning is enabled. type: boolean type: object installment_data: description: Contains the installment plan identifier used by the Visa Transaction Matching Service for Issuers. properties: installment_plan_identifier: description: |- (_Visa only_) Visa Transaction Matching Service for Issuers identifier. This identifier matches a transaction on the Marqeta platform to an installment plan or Pay by Points transaction on the Visa card network. type: string type: object issuer_fraud_view: description: Contains one or more fraud determinations by the card network that apply to either the transaction or the cardholder's account. properties: fraud_score_reasons: items: type: string type: array recommended_action: description: The action recommended based on the fraud score. type: string risk_level: description: The fraud rating, or level of risk associated with the transaction. type: string riskcontrol_tags: description: The RiskControl tags that were triggered by the transaction. items: $ref: '#/components/schemas/riskcontrol_tags' type: array rule_violations: description: The rules violated by the transaction. items: type: string type: array score: description: |- The risk score generated by RiskControl. This is either the Mastercard Decision Intelligence or Visa Advance Authorization transaction risk score. format: int32 type: integer triggered_rules: description: Provides a list of rules triggered by a fraud event, along with the information on tags and rule characteristics. items: $ref: '#/components/schemas/triggered_rule' type: array type: object jit_account_name_verification: description: |- Contains account name verification data used to make JIT Funding decisions from one of the following objects: * The `gateway` object, which contains account name verification data from your JIT Funding gateway. * The `issuer` object, which contains account name verification data from the Marqeta platform. * The `request` object, which contains account name verification data as it appears in a JIT Funding request. properties: gateway: $ref: '#/components/schemas/account_name_verification_source' issuer: $ref: '#/components/schemas/account_name_verification_source' request: $ref: '#/components/schemas/ani_information' type: object jit_address_verification: description: Contains address verification data used to make JIT Funding decisions. properties: gateway: $ref: '#/components/schemas/address_verification_source' issuer: $ref: '#/components/schemas/address_verification_source' request: $ref: '#/components/schemas/avs_information' type: object jit_funding: properties: paymentcard_funding_source: $ref: '#/components/schemas/jit_funding_paymentcard_funding_source' program_funding_source: $ref: '#/components/schemas/jit_funding_program_funding_source' programgateway_funding_source: $ref: '#/components/schemas/jit_funding_programgateway_funding_source' type: object jit_funding_api: description: |- Contains information about the JIT Funding load event, in which funds are loaded into an account. This object is returned if your program uses JIT Funding. properties: account_name_verification: $ref: '#/components/schemas/jit_account_name_verification' acting_user_token: description: |- User who conducted the transaction. Can be a child user configured to share its parent's account balance. maxLength: 36 minLength: 0 type: string address_verification: $ref: '#/components/schemas/jit_address_verification' amount: description: Requested amount of funding. exclusiveMinimum: false minimum: 0 type: number anticipated_amount_supported: type: boolean balances: additionalProperties: $ref: '#/components/schemas/cardholder_balance' description: Contains the GPA's balance details. type: object business_token: description: Holder of the business account that was funded. maxLength: 36 minLength: 0 type: string decline_reason: description: Reason why the transaction was declined. enum: - INVALID_AMOUNT - INSUFFICIENT_FUNDS - TRANSACTION_NOT_PERMITTED - SUSPECTED_FRAUD - AMOUNT_LIMIT_EXCEEDED - TRANSACTION_COUNT_LIMIT_EXCEEDED - DUPLICATE_TRANSACTION - INVALID_MERCHANT - INVALID_CARD - NO_CREDIT_ACCOUNT - EXPIRED_CARD - NO_CHECKING_ACCOUNT - NO_SAVINGS_ACCOUNT - STOP_PAYMENT - REVOCATION_AUTHORIZATION_ORDER - REVOCATION_ALL_AUTHORIZATION_ORDER - SOFT_DECLINE_AUTHENTICATION_REQUIRED - CLOSED_ACCOUNT - SOFT_DECLINE_PIN_REQUIRED - CARD_NOT_ACTIVE - CARDHOLDER_NOT_ACTIVE - BLOCKED_BY_ISSUER - BLOCKED_BY_CARDHOLDER - BLOCKED_MERCHANT_BY_CARDHOLDER - INVALID_DRIVER_NUMBER - INVALID_VEHICLE_NUMBER type: string incremental_authorization_jit_funding_tokens: description: |- 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. items: type: string type: array jit_account_name_verification: $ref: '#/components/schemas/jit_account_name_verification' memo: description: Additional information that describes the JIT Funding transaction. maxLength: 99 minLength: 0 type: string method: description: |- JIT Funding response type. See <> for the purpose, funding event type, and description of each method. enum: - pgfs.authorization - pgfs.authorization.clearing - pgfs.authorization.advice - pgfs.authorization.incremental - pgfs.authorization.capture - pgfs.authorization.reversal - pgfs.authorization.cashback - pgfs.balanceinquiry - pgfs.auth_plus_capture - pgfs.refund - pgfs.refund.authorization - pgfs.refund.authorization.reversal - pgfs.refund.authorization.clearing - pgfs.force_capture - pgfs.authorization.capture.chargeback - pgfs.authorization.capture.chargeback.reversal - pgfs.pindebit - pgfs.pindebit.chargeback - pgfs.pindebit.chargeback.reversal - pgfs.pindebit.cashback - pgfs.pindebit.refund - pgfs.pindebit.authorization - pgfs.pindebit.authorization.clearing - pgfs.pindebit.authorization.reversal - pgfs.pindebit.atm.withdrawal - pgfs.pindebit.balanceinquiry - pgfs.pindebit.quasi.cash - pgfs.dispute.credit - pgfs.dispute.debit - pgfs.directdeposit.credit - pgfs.directdeposit.debit - pgfs.directdeposit.credit.reversal - pgfs.directdeposit.debit.reversal - pgfs.adjustment.credit - pgfs.adjustment.debit - pgfs.auth_plus_capture.standin - pgfs.authorization.standin - pgfs.network.load - pgfs.original.credit.authorization - pgfs.original.credit.auth_plus_capture - pgfs.original.credit.authorization.clearing - pgfs.original.credit.authorization.reversal - pgfs.billpayment - pgfs.billpayment.capture - pgfs.billpayment.reversal - pgfs.atm.withdrawal - pgfs.atm.clearing.withdrawal - pgfs.authorization.quasi.cash - pgfs.authorization.clearing.quasi.cash - pgfs.authorization.account_verification - pgfs.product.inquiry type: string original_jit_funding_token: description: |- 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. maxLength: 36 minLength: 0 type: string tags: description: Customer-defined tags related to the JIT Funding transaction. maxLength: 255 minLength: 0 type: string token: description: |- Existing JIT Funding token matching the `funding.gateway_log.transaction_id` field of the associated GPA order. *NOTE:* The `transaction_id` field updates if a subsequent JIT Funding message associated with that GPA order is sent. If multiple JIT Funding messages are associated with the same GPA order, the `transaction_id` field matches the token of the most recent message. maxLength: 36 minLength: 0 type: string user_token: description: Holder of the user account that was funded. maxLength: 36 minLength: 0 type: string required: - amount - method - token - user_token type: object jit_funding_paymentcard_funding_source: properties: enabled: default: false type: boolean refunds_destination: description: 'Valid values: GATEWAY, GPA, WATERFALL' maxLength: 50 minLength: 0 type: string type: object jit_funding_program_funding_source: properties: enabled: default: false type: boolean funding_source_token: description: required if enabled maxLength: 36 minLength: 0 type: string refunds_destination: description: 'Valid values: PROGRAM_FUNDING_SOURCE, GPA, WATERFALL' maxLength: 50 minLength: 0 type: string type: object jit_funding_programgateway_funding_source: properties: always_fund: default: false type: boolean enabled: default: false type: boolean funding_source_token: description: Required if enabled maxLength: 36 minLength: 0 type: string refunds_destination: description: 'Valid values: GATEWAY, GPA, WATERFALL' maxLength: 50 minLength: 0 type: string type: object jit_program_response: description: Contains the gateway's information about the JIT Funding transaction. properties: flex: $ref: '#/components/schemas/flex' jit_funding: $ref: '#/components/schemas/jit_funding_api' network_metadata: $ref: '#/components/schemas/network_metadata' required: - jit_funding type: object kyc_request: properties: business_token: description: Required if 'user_token' is null maxLength: 36 minLength: 1 type: string manual_override: default: false type: boolean notes: maxLength: 255 minLength: 0 type: string reference_id: maxLength: 32 minLength: 0 type: string token: maxLength: 36 minLength: 1 type: string user_token: description: Required if 'business_token' is null maxLength: 36 minLength: 1 type: string type: object kyc_response: properties: business_token: type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string manual_override: default: false readOnly: true type: boolean notes: readOnly: true type: string reference_id: type: string result: $ref: '#/components/schemas/result' token: type: string user_token: type: string required: - created_time - last_modified_time type: object link: properties: href: readOnly: true type: string method: type: string rel: type: string required: - href - method - rel type: object login_request_model: properties: email: description: Cardholder email address. type: string password: description: Password to the cardholder's user account on the Marqeta platform. maxLength: 255 minLength: 1 type: string user_token: description: |- Identifies the cardholder to log in. Send a `GET` request to `/users` to retrieve user tokens. maxLength: 36 minLength: 1 type: string type: object login_response_model: properties: access_token: $ref: '#/components/schemas/access_token_response' user: $ref: '#/components/schemas/user_card_holder_response' type: object manual_entry: properties: address_verification: $ref: '#/components/schemas/digital_wallet_token_address_verification' enabled: default: false description: Specifies if manual entry is enabled. type: boolean type: object mcc_group_model: properties: active: default: false type: boolean config: $ref: '#/components/schemas/MCCConfig' mccs: items: properties: { } type: object maxItems: 500 minItems: 0 type: array name: maxLength: 255 minLength: 0 type: string token: maxLength: 36 minLength: 1 type: string required: - mccs - name type: object mcc_group_update_model: properties: active: default: false type: boolean config: $ref: '#/components/schemas/MCCConfig' mccs: items: type: string maxItems: 500 minItems: 1 type: array name: type: string type: object media_content: properties: data: description: Media data content. type: string height: description: |- Height of non-SVG image asset. Specified in pixels. type: string type: description: | Type of media. Specified as Multipurpose Internet Mail Extension (MIME). Supported media types include: * application/pdf * image/png * image/svg+xml * text/plain * text/html type: string width: description: |- Width of non-SVG image asset. Specified in pixels. type: string type: object merchant_group_request: properties: active: default: false type: boolean mids: items: type: string maxItems: 4000 minItems: 1 type: array name: maxLength: 40 minLength: 1 type: string token: maxLength: 36 minLength: 1 type: string required: - name type: object merchant_group_response: properties: active: default: false type: boolean created_time: format: date-time type: string last_modified_time: format: date-time type: string mids: items: type: string type: array name: type: string token: type: string type: object merchant_group_update_request: properties: active: default: false type: boolean mids: items: type: string maxItems: 4000 minItems: 1 type: array name: maxLength: 40 minLength: 1 type: string type: object merchant_response_model: properties: active: default: true type: boolean address1: maxLength: 255 minLength: 0 type: string address2: maxLength: 255 minLength: 0 type: string city: maxLength: 40 minLength: 0 type: string contact: maxLength: 40 minLength: 0 type: string contact_email: maxLength: 40 minLength: 0 type: string country: maxLength: 40 minLength: 0 type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string latitude: format: float type: number longitude: format: float type: number name: maxLength: 40 minLength: 0 type: string partial_auth_flag: default: true type: boolean phone: maxLength: 10 minLength: 0 type: string province: maxLength: 20 minLength: 0 type: string state: maxLength: 2 minLength: 0 type: string token: description: The unique identifier of the merchant maxLength: 36 minLength: 1 type: string zip: maxLength: 10 minLength: 0 type: string required: - created_time - last_modified_time - name type: object merchant_scope: description: |- Defines the group of merchants to which the velocity control applies. Populate no more than one field of the `merchant_scope` object. If no fields are populated, the velocity control applies to all merchants. properties: mcc: description: |- Merchant Category Code (MCC). Identifies the type of products or services provided by the merchant. Enter a value to control spending on a particular type of product or service. maxLength: 4 minLength: 1 type: string mcc_group: description: |- Token identifying a group of MCCs. Enter a value to control spending on a group of product or service types. Send a `GET` request to `/mccgroups` to retrieve MCC group tokens. maxLength: 36 minLength: 1 type: string mid: description: |- Merchant identifier (MID). Identifies a specific merchant. Enter a value to control spending with a particular merchant. maxLength: 36 minLength: 1 type: string type: object money_in_transaction: description: |- Defines the original credit transaction (OCT) types that are subject to velocity control. Your request can contain either a `money_in_transaction` object or the `include_credits` field, not both. properties: include_credits_types: description: Specifies the types of credits to include in the original credit transaction (OCT). items: type: string type: array include_network_load_types: description: Indicates whether or not cash and check network load transactions will be subject to velocity control. items: type: string type: array type: object msa: properties: campaign_token: type: string reload_amount: exclusiveMinimum: false minimum: 0.01 type: number trigger_amount: exclusiveMinimum: false minimum: 0.01 type: number required: - campaign_token - reload_amount - trigger_amount type: object network: description: Contains information from the card network about currency conversion, including the original currency of the transaction, the amount of the transaction in the original currency, and the conversion rate. properties: conversion_rate: description: |- Conversion rate between the origination currency and the settlement currency. Returned when the transaction currency is different from the origination currency. type: number dynamic_currency_conversion: default: false description: Indicates whether currency conversion was performed dynamically at the point of sale. type: boolean original_amount: description: Amount of the transaction in the currency in which it originated. type: number original_currency_code: description: Currency type of the origination currency. type: string settlement_data: $ref: '#/components/schemas/settlement_data' type: object network_account_intelligence_score: description: Account intelligence score information, as provided by the Mastercard network. properties: name: description: The name, as provided by the Mastercard network. type: string service_type: description: The service type, as provided by the Mastercard network. type: string value: description: The value, as provided by the Mastercard network. type: string type: object network_fee_model: description: Contains card network fees assessed against the cardholder. properties: amount: description: Amount of the network fee. type: number credit_debit: description: |- Indicates whether the fee is a credit or a debit. * *C* indicates a credit * *D* indicates a debit enum: - C - D type: string currency: description: |- Type of currency used when assessing a `CROSS_BORDER_ISSUER_FEE` or `INTERCHANGE_FEE` on Mastercard multi-currency transactions. Three-digit link:https://www.iso.org/iso-4217-currency-codes.html[ISO 4217 currency code, window="_blank"]. type: string type: description: Type of fee assessed by the card network. enum: - ISSUER_FEE - SWITCH_FEE - PINDEBIT_ASSOC_FEE - ACQUIRER_FEE - INTERCHANGE_FEE - CUR_CONV_CARDHOLDER_FEE - CUR_CONV_ISSUER_FEE - CROSS_BORDER_ISSUER_FEE type: string type: object network_fraud_view: description: Contains network-provided information about fraud determinations. properties: account_risk_score: description: |- _(Visa only)_ Account holder risk condition code evaluated by the card network. A higher score indicates a greater likelihood that the card number is compromised. type: string account_risk_score_reason_code: description: _(Visa only)_ Unique code that describes the main driver of the `account_risk_score`. type: string card_not_present_transaction_risk_score: description: |- _(Visa only)_ Visa-provided score ranking the risk of fraud for a card-not-present transaction. A higher score indicates higher risk. Useful for making authorization decisions. type: string dii_score: description: Mastercard Digital Identity Insights risk score, where `0` indicates the lowest risk and `9` indicates the highest risk. type: string dii_score_reason_code: description: Mastercard Digital Identity Insights risk score reason code, where `AA` indicates the lowest risk, and `ZZ` indicates the highest risk. type: string transaction_account_attack_intelligence_score: description: |- _(Visa only)_ Visa-provided score ranking the risk of an account enumeration attack in a card-not-present transaction. A higher score indicates higher risk. A score of 00 indicates insufficient data to determine risk. Useful for making authorization decisions. type: string transaction_risk_score: description: |- Network-provided risk score for the transaction. A higher score indicates higher risk. Useful for making authorization decisions. format: int32 type: integer transaction_risk_score_reason_code: description: _(Mastercard only)_ Unique code that describes the main driver of the `transaction_risk_score`. type: string transaction_risk_score_reason_description: description: _(Mastercard only)_ Description of the `transaction_risk_score_reason_code`. type: string type: object network_metadata: description: |- Contains network-related metadata for the transaction, including details about the card program and the card product. Returned if provided by the card network properties: account_identification_1: type: string incoming_response_code: description: |- Network response code, as provided by the card network. For example, Visa response code `59` indicates suspected fraud. type: string network_funding_txn_type: description: Transaction type indicator provided by the card network for original credit and account funding transactions. type: string outgoing_response_code: description: |- Network response code, as provided by Marqeta. For example, Visa response code `59` indicates suspected fraud. type: string product_id: description: |- Product identification value assigned by the card network to each card product. Can be used to track card-level activity by individual account number for premium card products. type: string program_id: description: Program identification number used with `product_id` that identifies the programs associated with a card within a program registered by the issuer with the card network. type: string spend_qualifier: description: Indicates whether or not the base spend-assessment threshold defined by the card network has been met. type: string surcharge_free_atm_network: description: Name of the surcharge-free ATM network used to complete the transaction. type: string terminal_verification_results: type: string type: object one_time_request_model: properties: email: description: |- Cardholder email address. Required when neither the user token nor the admin access token is provided as the Basic Authentication password (case #3). maxLength: 255 minLength: 1 type: string password: description: |- Password to the cardholder's user account on the Marqeta platform. Required when neither the user token nor the admin access token is provided as the Basic Authentication password (case #3). maxLength: 255 minLength: 1 type: string user_token: description: |- Identifies the cardholder whose data is accessed. Send a `GET` request to `/users` to retrieve cardholder tokens. Required when the Basic Authentication password is set to an admin access token (case #2). maxLength: 36 minLength: 1 type: string type: object order_scope: description: Defines the balance threshold and reload amounts. properties: gpa: $ref: '#/components/schemas/gpa' type: object original_credit: description: 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. properties: deferred_hold_by: enum: - absent - visa - originator - payment type: string entry_device_type: enum: - OFF_THE_SHELF_MOBILE_CONSUMER type: string fast_funds_enabled: description: |- Indicates that Fast Funds are enabled for dual-message original credit transactions. If the value of this field is `true`, you must make the funds available to your cardholder within 30 minutes of the transaction. type: boolean funding_source: description: Sender's account from which the OCT draws funds. enum: - CREDIT - DEBIT - PREPAID - DEPOSIT_ACCOUNT - CASH - MOBILE_MONEY_ACCOUNT - NON_VISA_CREDIT - CHECK - ACH type: string reference_id: type: string screening_score: description: |- Sanctions screening score to assist with meeting Anti-Money Laundering (AML) obligations. Higher scores indicate that the sender's data more closely resembles an entry on the regulatory watchlist. A value of 999 means that no screening score is available. type: string sender_account_number: type: string sender_account_type: description: The type of account from which the OCT draws funds. enum: - OTHER - RTN_BANK_ACCOUNT - IBAN - CARD_ACCOUNT - EMAIL - PHONE_NUMBER - BANK_ACCOUNT_NUMBER_AND_BANK_IDENTIFICATION_CODE - WALLET_ID - SOCIAL_NETWORK_ID type: string sender_address: description: Sender's street address. type: string sender_city: description: Sender's city. type: string sender_country: description: Sender's country. type: string sender_date_of_birth: type: string sender_name: description: Full name of the sender. type: string sender_postal_code: type: string sender_state: description: Sender's state. type: string transaction_purpose: description: The purpose of the original credit transaction. type: string transaction_type: description: Type of original credit transaction. enum: - account_to_account - person_to_person - wallet_transfer - money_transfer_by_bank - business_to_business - disbursement - government_disbursement - gambling_payout - loyalty - merchant_disbursement - online_gambling_payout - pension_disbursement - prepaid_loads - card_bill_payment - bill_payment - cash_claim - cash_in - cash_out - mobile_air_time_payment - money_transfer_by_merchant - face_to_face_merchant_payment - government_payment - payments_goods_services - funds_transfer - general_business_to_business_transfer - business_to_business_transfer - cash_deposit - purchase_repayment - aft_or_oct_eligibility - consumer_bill_payment - request_to_pay - gaming_payment - visa_accept type: string type: object original_credit_sender_data: properties: deferred_hold_by: enum: - absent - visa - originator - payment type: string fast_funds_enabled: type: boolean funding_source: enum: - credit - debit - prepaid - deposit_account - cash - mobile_money_payment - non_visa_credit - check - ach type: string sender_account_number: type: string sender_account_type: enum: - other - rtn_bank_account - iban - card_account - email - phone_number - bank_account_number_and_identification_code - wallet_id - social_network_id type: string sender_address: type: string sender_city: type: string sender_country: type: string sender_name: type: string sender_reference_number: type: string sender_state: type: string transaction_purpose: enum: - family_support - labor_transfers - travel - education - medical_treatment - emergency_need - savings - gifts - other - salary - lending - crypto_currency type: string unique_transaction_reference_number: maxLength: 17 minLength: 1 type: string visa_transaction_purpose: type: string required: - funding_source type: object orignalcredit_request_model: properties: amount: type: number card_acceptor: $ref: '#/components/schemas/card_acceptor_model' card_token: maxLength: 36 minLength: 1 type: string mid: maxLength: 50 minLength: 1 type: string screening_score: type: string sender_data: $ref: '#/components/schemas/original_credit_sender_data' transactionPurpose: type: string type: enum: - account_to_account - person_to_person - prepaid - wallet_transfer - money_transfer_by_bank - business_to_business - disbursement - government_disbursement - gambling_payout - loyalty - merchant_disbursement - online_gambling_payout - pension_disbursement - prepaid_loads - card_bill_payment - bill_payment - cash_claim - cash_in - cash_out - mobile_air_time_payment - money_transfer_by_merchant - face_to_face_merchant_payment - government_payment - payments_goods_services - purchase_repayment - visa_accept type: string webhook: $ref: '#/components/schemas/webhook' required: - amount - card_token - mid - type type: object other_poi: properties: allow: default: true type: boolean card_presence_required: default: false description: Default = false type: boolean cardholder_presence_required: default: false description: Default = false type: boolean track1_discretionary_data: type: string track2_discretionary_data: type: string use_static_pin: default: false type: boolean type: object pan_request: properties: cvv_number: type: string expiration: type: string pan: type: string required: - pan type: object pan_response: properties: card_token: description: The unique identifier of the card type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string user_token: description: The unique identifier of the cardholder type: string required: - card_token - created_time - last_modified_time - user_token type: object password_update_model: properties: current_password: description: Current password to the cardholder's user account on the Marqeta platform. maxLength: 255 minLength: 1 type: string new_password: description: |- New password to the cardholder's user account on the Marqeta platform. * Must contain at least one numeral + * Must contain at least one lowercase letter + * Must contain at least one uppercase letter + * Must contain at least one of these symbols: + `@` `#` `$` `%` `!` `^` `&` `*` `(` `)` + `\` `_` `+` `~` `-` `=` `[` `]` `{` `}` + `,` `;` `:` `'` `"` `.` `/` `<` `>` `?` ``` maxLength: 255 minLength: 1 type: string required: - current_password - new_password type: object payment_card_funding_source_model: allOf: - $ref: '#/components/schemas/funding_source_model' - properties: account_suffix: type: string account_type: type: string business_token: description: Required if 'user_token' is null type: string exp_date: type: string user_token: description: Required if 'business_token' is null type: string required: - account_suffix - account_type - exp_date type: object payment_card_response_model: properties: account_suffix: type: string account_type: type: string active: default: false type: boolean business_token: description: Required if 'user_token' is not present type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string exp_date: type: string is_default_account: default: false type: boolean last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string token: type: string type: type: string user_token: description: Required if 'business_token' is not present type: string required: - account_suffix - account_type - active - created_time - exp_date - is_default_account - last_modified_time - token - type type: object payment_facilitator_model: description: Information about the payment facilitator of an account funding or original credit transaction. properties: city: description: Payment facilitator's city. type: string country_code: description: Payment facilitator's country code. type: string postal_code: description: Payment facilitator's postal code. type: string state: description: Payment facilitator's state location. type: string street_address: description: Payment facilitator's street address. type: string type: object peer_transfer_request: properties: amount: type: number currency_code: type: string memo: maxLength: 99 minLength: 1 type: string recipient_business_token: description: Required if 'recipient_business_token' is null maxLength: 36 minLength: 1 type: string recipient_user_token: description: Required if 'recipient_business_token' is null maxLength: 36 minLength: 1 type: string sender_business_token: description: Required if 'send_user_token' is null maxLength: 36 minLength: 1 type: string sender_user_token: description: Required if 'send_business_token' is null maxLength: 36 minLength: 1 type: string tags: maxLength: 255 minLength: 1 type: string token: maxLength: 36 minLength: 1 type: string required: - amount - currency_code type: object peer_transfer_response: description: Contains information about an intra-account transfer, including sender and recipient tokens, transfer amount, and currency code. properties: amount: description: Amount of the transfer. type: number created_time: format: date-time type: string currency_code: description: Three-digit ISO 4217 currency code. type: string memo: description: Additional descriptive text about the intra-account transfer. type: string recipient_business_token: description: Specifies the business account holder that receives funds. type: string recipient_user_token: description: Specifies the user account holder that receives funds. type: string sender_business_token: description: Specifies the business account holder that sends funds. type: string sender_user_token: description: Specifies the user account holder that sends funds. type: string tags: description: Metadata about the intra-account transfer. type: string token: description: Unique identifier of the intra-account transfer request. type: string required: - amount - created_time - currency_code - token type: object pin_request: properties: control_token: description: |- Unique value generated as a result of issuing a `POST` request to the `/pins/controltoken` endpoint. This value cannot be updated. maxLength: 36 minLength: 1 type: string pin: description: Four-digit number to associate with the card. type: string required: - control_token - pin type: object pin_reveal_request: properties: cardholder_verification_method: description: |- The supplemental method used to verify the cardholder's identity before revealing the card's personal identification number (PIN). The possible cardholder verification methods are: * *BIOMETRIC_FACE:* In-app authentication via facial recognition * *BIOMETRIC_FINGERPRINT:* In-app authentication via biometric fingerprint * *EXP_CVV:* In-app authentication by entering the card's expiration date and card verification value (CVV) * *LOGIN:* In-app authentication by re-entering the app password * *OTP:* Two-factor authentication involving a one-time password (OTP) * *OTP_CVV:* Two-factor authentication involving the card's CVV and an OTP * *OTHER:* Authentication that relies on other secure methods enum: - BIOMETRIC_FACE - BIOMETRIC_FINGERPRINT - LOGIN - EXP_CVV - OTP_CVV - OTP - OTHER type: string control_token: description: |- Unique value generated as a result of issuing a `POST` request to the `/pins/controltoken` endpoint. This value cannot be updated. maxLength: 36 minLength: 1 type: string required: - cardholder_verification_method - control_token type: object ping_response: properties: env: type: string id: type: string revision: type: string success: type: boolean timestamp: type: string version: type: string type: object poi: properties: atm: default: false description: Default = false type: boolean ecommerce: default: true type: boolean other: $ref: '#/components/schemas/other_poi' type: object pos: description: |- Contains information about the point of sale, including details on how the card was presented. Returned if provided by the card network, and the request uses Transaction Model v2 of the Marqeta Core API. Not returned for Transaction Model v1 requests. properties: card_data_input_capability: description: How the terminal accepts card data. enum: - UNKNOWN - NO_TERMINAL - MAG_STRIPE - MAG_STRIPE_CONTACTLESS - MAG_STRIPE_KEY_ENTRY - CHIP - CHIP_CONTACTLESS - CHIP_MAG_STRIPE - CHIP_MAG_STRIPE_KEY_ENTRY - KEY_ENTRY - OCR - MICR - BAR_CODE - CREDENTIALS_ON_FILE type: string card_holder_presence: default: false description: Whether the cardholder was present during the transaction. type: boolean card_presence: default: false description: Whether the card was present during the transaction. type: boolean cardholder_authentication_method: description: Method used to authenticate the cardholder. enum: - UNSPECIFIED - NON_AUTHENTICATED - SIGNATURE - PIN - ID_VERIFIED - ELECTRONIC_SIGNATURE - BIOMETRIC - BIOGRAPHIC - MANUAL_SIGNATURE - ELECTRONIC_TICKET_ENVIRONMENT type: string country_code: description: Country code of the card acceptor or terminal. type: string county: description: County of the card acceptor or terminal. type: string is_installment: default: false description: Whether the transaction is an installment payment. type: boolean is_recurring: default: false description: Whether the transaction is recurring. type: boolean pan_entry_mode: description: Method used for capturing the card primary account number (PAN) during the transaction. enum: - UNKNOWN - MANUAL - MAG_STRIPE - MAG_STRIPE_CONTACTLESS - BAR_CODE - OCR - MICR - CHIP - CHIP_CONTACTLESS - CARD_ON_FILE - CHIP_FALLBACK - OTHER - KEY_ENTERED - CREDENTIALS_ON_FILE - KEYED_CARD_PCSC - MAG_STRIPE_READ_KEYED_PCSC type: string partial_approval_capable: default: false description: Indicates whether the card acceptor or terminal supports partial-approval transactions. type: boolean pin_entry_mode: description: |- Indicates whether the card acceptor or terminal can capture card personal identification numbers (PINs). *NOTE:* This field does not indicate whether a PIN was entered. enum: - UNKNOWN - 'TRUE' - 'FALSE' - DEFECTIVE type: string pin_present: default: false description: Indicates whether the cardholder entered a PIN during the transaction. type: boolean purchase_amount_only: default: false description: Indicates whether the card acceptor or terminal supports purchase-only approvals. type: boolean special_condition_indicator: description: |- Indicates a higher-risk operation, such as a quasi-cash or cryptocurrency transaction. These transactions typically involve non-financial institutions. enum: - UNSPECIFIED - CRYPTOCURRENCY_PURCHASE - QUASI_CASH - DEBT_PAYMENT - CENTRAL_BANK_DIGITAL_CURRENCY_PURCHASE - STABLECOIN_PURCHASE - BLOCKCHAIN_NATIVE_TOKEN_PURCHASE - NON_FUNGIBLE_TOKEN_PURCHASE type: string state: description: State, province, or territory of the card acceptor or terminal. type: string terminal_attendance: description: Whether the card acceptor/terminal was attended. enum: - UNSPECIFIED - ATTENDED - UNATTENDED - NO_TERMINAL - MOBILE_REMOTE - TRANSIT_ACCESS_TERMINAL type: string terminal_id: description: Card acceptor or terminal identification number. type: string terminal_location: description: Location of the card acceptor/terminal. enum: - ON_PREMISE - ON_PREMISE_CARDHOLDER - OFF_PREMISE_CARDHOLDER - ON_PREMISE_MERCHANT - OFF_PREMISE_MERCHANT - NO_TERMINAL - MOBILE_REMOTE - TRANSIT_ACCESS_TERMINAL - UNSPECIFIED type: string terminal_type: description: Type of card acceptor/terminal. enum: - AUTO_DISPENSER_WITH_PIN - SELF_SERVICE - LIMITED_AMOUNT - IN_FLIGHT - ECOMMERCE - TRANSPONDER type: string transaction_initiated_by: description: Specifies the initiator of the transaction. enum: - CONSUMER - MERCHANT - UNKNOWN - MARQETA - NETWORK type: string transaction_initiated_category: description: Specifies the category of a point-of-sale transaction. enum: - CARD_ON_FILE - RECURRING_VAR_AMT_FIXED_FREQ - RECURRING_PAYMENT - INSTALLMENT_PAYMENT - UNSCHEDULED_PAYMENT - PARTIAL_SHIPMENT - DELAYED_PAYMENT - NO_SHOW - RESUBMISSION - DEFERRED_BILLING - ACCOUNT_INQUIRY - INCREMENTAL_AUTHORIZATION - REAUTHORIZATION type: string zip: description: United States ZIP code of the card acceptor or terminal. type: string type: object pre_kyc_controls: properties: balance_max: description: Minimum is 0 exclusiveMinimum: false minimum: 0 type: number cash_access_enabled: default: false type: boolean enable_non_program_loads: default: false type: boolean international_enabled: default: false type: boolean is_reloadable_pre_kyc: default: false type: boolean type: object preceding_transaction: description: |- Returned for `authorization.clearing` transaction types following a financial advice. Contains information about the preceding transaction. properties: amount: description: Amount of the preceding transaction. type: number token: description: Unique identifier of the preceding transaction. type: string type: object program: description: Information about the program on the Marqeta platform. properties: long_code: description: The program long code on the Marqeta platform. type: string program_id: description: The program identifier on the Marqeta platform. type: string short_code: description: The program short code on the Marqeta platform. type: string required: - long_code - program_id - short_code type: object program_funding_source_model: allOf: - $ref: '#/components/schemas/funding_source_model' - properties: name: type: string required: - name type: object program_funding_source_request: properties: active: type: boolean name: maxLength: 50 minLength: 1 type: string token: maxLength: 36 minLength: 1 type: string required: - name type: object program_funding_source_response: properties: account: type: string active: type: boolean created_time: format: date-time type: string last_modified_time: format: date-time type: string name: maxLength: 50 minLength: 1 type: string token: maxLength: 36 minLength: 1 type: string required: - account - created_time - last_modified_time - name - token type: object program_funding_source_update_request: properties: active: type: boolean name: maxLength: 50 minLength: 1 type: string type: object program_gateway_funding_source_model: allOf: - $ref: '#/components/schemas/funding_source_model' - properties: name: type: string required: - name type: object program_reserve_account_balance: properties: available_balance: description: |- Ledger balance, minus any authorized transactions that have not yet cleared. When using JIT Funding, this balance is usually equal to $0.00. readOnly: true type: number balances: additionalProperties: $ref: '#/components/schemas/program_reserve_account_balance' description: |- Contains program reserve account balance information, organized by currency code. Sometimes referred to as a _program funding account_. type: object credit_balance: description: Not currently in use. readOnly: true type: number currency_code: description: Three-digit ISO 4217 currency code. type: string ledger_balance: description: |- 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. readOnly: true type: number pending_credits: description: ACH loads that have been accepted, but for which the funding time has not yet elapsed. readOnly: true type: number type: object program_reserve_deposit_request: properties: amount: description: Amount of the deposit. type: number currency_code: description: Three-digit ISO 4217 currency code. type: string idempotentHash: description: Idempotent hash value associated with the deposit request. type: string is_collateral: type: boolean memo: description: Memo or note describing the deposit request. type: string tags: description: Comma-delimited list of tags describing the deposit request. type: string token: description: Unique identifier of the deposit request. type: string required: - amount - currency_code - token type: object program_reserve_transaction_response: properties: amount: description: |- Amount of the program reserve account credit or debit. Sometimes referred to as a _program funding account_. type: number created_time: description: Date and time when the resource was created, in UTC. format: date-time type: string currency_code: description: Three-digit ISO 4217 currency code. type: string is_collateral: type: boolean last_modified_time: description: The date and time when the resource was last modified, in UTC. format: date-time type: string memo: description: Memo or note describing the transaction. type: string state: description: Transaction state. enum: - PENDING - COMPLETE type: string tags: description: Comma-delimited list of tags describing the transaction. type: string token: description: The unique identifier of the transaction response. type: string transaction_token: description: Unique identifier of the transaction. type: string type: description: Transaction type. enum: - CREDIT - DEBIT - PENDING_CREDIT - PENDING_DEBIT type: string required: - created_time - last_modified_time type: object program_transfer: properties: amount: description: Amount of program transfer. type: number business_token: description: |- Unique identifier of the business. Pass either a `business_token` or a `user_token`, not both. Send a `GET` request to `/businesses` to retrieve business tokens. maxLength: 36 minLength: 1 type: string currency_code: description: Three-digit ISO 4217 currency code. type: string fees: description: |- Contains attributes that define characteristics of one or more fees. This array is returned in the response when it is included in the request. items: $ref: '#/components/schemas/fee_model' type: array memo: description: Memo or note describing the program transfer. maxLength: 99 minLength: 1 type: string tags: description: Comma-delimited list of tags describing the program transfer. maxLength: 255 minLength: 1 type: string token: description: |- Unique identifier of the program transfer. If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. maxLength: 36 minLength: 1 type: string type_token: description: |- Unique identifier of the program transfer type. Send a `GET` request to `/programtransfers/types` to retrieve program transfer type tokens. maxLength: 36 minLength: 1 type: string user_token: description: |- Unique identifier of the user. Pass either a `user_token` or a `business_token`, not both. Send a `GET` request to `/users` to retrieve business tokens. maxLength: 36 minLength: 1 type: string required: - amount - currency_code - type_token type: object program_transfer_response: description: Contains information about a program transfer, which moves funds from an account holder's GPA to a program funding source. properties: amount: description: Amount of program transfer. type: number business_token: description: |- Unique identifier of the business account holder. Returned if `user_token` is not specified. maxLength: 36 minLength: 1 type: string created_time: description: Date and time when the program transfer object was created, in UTC. format: date-time type: string currency_code: description: Three-digit ISO 4217 currency code. type: string fees: description: Contains attributes that define characteristics of one or more fees. items: $ref: '#/components/schemas/fee_detail' type: array jit_funding: $ref: '#/components/schemas/jit_funding_api' memo: description: Additional description of the program transfer. maxLength: 99 minLength: 1 type: string tags: description: Comma-delimited list of tags describing the program transfer. maxLength: 255 minLength: 1 type: string token: description: Unique identifier of the program transfer. maxLength: 36 minLength: 1 type: string transaction_token: description: Unique identifier of the transaction. type: string type_token: description: Unique identifier of the program transfer type. maxLength: 36 minLength: 1 type: string user_token: description: |- Unique identifier of the user account holder. Returned if `business_token` is not specified. maxLength: 36 minLength: 1 type: string required: - amount - currency_code - transaction_token - type_token type: object program_transfer_type_request: properties: memo: description: Memo or note describing the program transfer type. maxLength: 99 minLength: 1 type: string program_funding_source_token: description: |- Unique identifier of the program funding source to which program transfers will be credited. Send a `GET` request to `/fundingsources/program` to retrieve program funding source tokens. maxLength: 36 minLength: 1 type: string tags: description: Comma-delimited list of tags describing the program transfer type. maxLength: 255 minLength: 1 type: string token: description: |- Unique identifier of the program transfer type. If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. maxLength: 36 minLength: 1 type: string required: - memo - program_funding_source_token type: object program_transfer_type_response: properties: created_time: description: The date and time when the program transfer type object was created, in UTC. format: date-time type: string last_modified_time: description: Date and time when the program transfer type object was last modified, in UTC. format: date-time type: string memo: description: Memo or note describing the program transfer type. type: string program_funding_source_token: description: Unique identifier of the program funding source to which program transfers will be credited. type: string tags: description: Comma-delimited list of tags describing the program transfer type. type: string token: description: Unique identifier of the program transfer type request object. type: string required: - program_funding_source_token - token type: object provisioning_controls: properties: dwt_tar_avs_decline_on_address_number_mismatch: type: boolean dwt_tar_avs_decline_on_postal_code_mismatch: type: boolean dwt_use_card_status_during_auth: type: boolean dwt_verify_atc_during_auth: type: boolean enable_discretionary_data_during_tar: type: boolean force_yellow_path_for_card_product: description: A value of `true` requires identity verification set-up for all digital wallets at the card product level. type: boolean in_app_provisioning: $ref: '#/components/schemas/in_app_provisioning' manual_entry: $ref: '#/components/schemas/manual_entry' wallet_provider_card_on_file: $ref: '#/components/schemas/wallet_provider_card_on_file' web_push_provisioning: $ref: '#/components/schemas/web_push_provisioning' type: object push_to_card_disburse_request: properties: amount: exclusiveMaximum: false exclusiveMinimum: false maximum: 50000 minimum: 0.01 type: number currency_code: type: string memo: maxLength: 99 minLength: 1 type: string payment_instrument_token: maxLength: 36 minLength: 1 type: string soft_descriptor: $ref: '#/components/schemas/PTCSoftDescriptor' tags: maxLength: 255 minLength: 1 type: string token: maxLength: 36 minLength: 1 type: string required: - amount - currency_code - payment_instrument_token type: object push_to_card_disbursement_response: properties: amount: type: number created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string currency_code: type: string last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string memo: maxLength: 99 minLength: 1 type: string payment_instrument_token: maxLength: 36 minLength: 1 type: string status: type: string tags: maxLength: 255 minLength: 1 type: string token: maxLength: 36 minLength: 1 type: string required: - created_time - last_modified_time type: object push_to_card_request: properties: address_1: maxLength: 255 minLength: 1 type: string address_2: maxLength: 255 minLength: 1 type: string city: maxLength: 40 minLength: 1 type: string country: type: string cvv: type: string exp_date: type: string name_on_card: maxLength: 50 minLength: 1 type: string pan: maxLength: 19 minLength: 14 type: string postal_code: maxLength: 10 minLength: 1 type: string state: maxLength: 2 minLength: 1 type: string token: maxLength: 36 minLength: 1 type: string user_token: maxLength: 36 minLength: 1 type: string required: - address_1 - city - country - cvv - exp_date - name_on_card - pan - postal_code - state - user_token type: object push_to_card_response: properties: address_1: maxLength: 255 minLength: 1 type: string address_2: maxLength: 255 minLength: 1 type: string city: maxLength: 40 minLength: 1 type: string country: type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string exp_date: type: string fast_fund_transfer_eligible: default: false type: boolean gambling_fund_transfer_eligible: default: false type: boolean last_four: type: string last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string last_name: readOnly: true type: string name_on_card: type: string postal_code: maxLength: 10 minLength: 1 type: string state: maxLength: 2 minLength: 1 type: string token: maxLength: 36 minLength: 1 type: string required: - created_time - last_modified_time type: object real_time_fee_group: description: Contains information about a real-time fee group. properties: active: default: false description: Indicates whether the real-time fee group is active. type: boolean created_time: description: Date and time when the real-time fee group was created, in UTC. format: date-time type: string fee_tokens: description: Specifies the fees in this real-time fee group. items: type: string type: array uniqueItems: true last_modified_time: description: Date and time when the real-time fee group was last modified, in UTC. format: date-time type: string name: description: Descriptive name for the real-time fee group. type: string token: description: Unique identifier of the real-time fee group. type: string required: - active - name - token type: object real_time_fee_group_create_request: properties: active: default: true description: Indicates whether the real-time fee group is active. type: boolean fee_tokens: description: |- Unique identifiers of the fees in this real-time fee group. Send a `GET` request to `/fees` to retrieve fee resource tokens. No two fees in the group can be applicable to the same transaction type (in other words, each fee must have a different value for its `real_time_assessment.transaction_type` field). items: type: string type: array uniqueItems: true name: description: Descriptive name for the real-time fee group. maxLength: 50 minLength: 1 type: string token: description: |- Unique identifier of the real-time fee group. If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. maxLength: 36 minLength: 1 type: string required: - name type: object real_time_fee_group_request: properties: active: default: true description: Indicates whether the real-time fee group is active. type: boolean fee_tokens: description: |- Specifies the fees in this real-time fee group. Send a `GET` request to `/fees` to retrieve fee resources tokens. No two fees in the group can be applicable to the same transaction type (in other words, each fee must have a different value for its `real_time_assessment.transaction_type` field). items: type: string type: array uniqueItems: true name: description: Descriptive name for the real-time fee group. maxLength: 50 minLength: 1 type: string type: object real_time_standin_criteria: properties: enabled: default: false type: boolean include_application_errors: default: false type: boolean include_connection_errors: default: false type: boolean include_response_timeouts: default: false type: boolean type: object realtime_fee_transfer_request: properties: fee: $ref: '#/components/schemas/fee_model' original_transaction_token: type: string token: type: string type: object request_for_apple_pay_wpp_JWT: properties: card_token: description: Unique identifier of the card resource. example: 5855opl9-abcc-4cb7-a330-xyze5799ea5 type: string req-sys-id: description: |- Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. type: string required: - card_token type: object request_for_wpp_parameters: properties: card_token: description: Unique identifier of the card resource. example: 5855opl9-abcc-4cb7-a330-xyze5799ea5 type: string required: - card_token type: object reset_user_password_email_model: properties: email: description: Cardholder email address. maxLength: 255 minLength: 1 type: string required: - email type: object reset_user_password_model: properties: new_password: description: New password to the cardholder's user account on the Marqeta platform. maxLength: 255 minLength: 1 type: string user_token: description: Unique identifier of the cardholder. maxLength: 36 minLength: 1 type: string required: - new_password - user_token type: object response: description: Response codes and memos for account name verification, address verification, card security verification, and transactions. properties: additional_information: description: |- Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. type: string code: description: |- Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. * `0` indicates no validation was performed * `1` indicates the match was unsuccessful (not matched) * `2` indicates the match was partial * `3` indicates the match was exact For example: [cols="2,3,3,3,3"] !=== ! Code ! First Name ! Middle Name ! Last Name ! Full Name ! `0000` ! Not validated ! Not validated ! Not validated ! Not validated ! `1111` ! Not matched ! Not matched ! Not matched ! Not matched ! `3333` ! Exact match ! Exact match ! Exact match ! Exact match ! `1232` ! Not matched ! Partial match ! Exact match ! Partial match !=== For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: [cols="2,3,3"] !=== ! Code ! Address ! Postal Code ! `0000` ! Match ! Match ! `0001` ! Match ! Not matched ! `0100` ! Not matched ! Match ! `0101` ! Not matched ! Not matched ! `0200` ! Data not present ! Match ! `0201` ! Data not present ! Not matched ! `0002` ! Match ! Data not present ! `0102` ! Not matched ! Data not present ! `0303` ! Not validated ! Not validated !=== For card security verification, the code indicates whether the verification check passed and can have these possible values: * `0000` – Passed * `0001` – Did not pass For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see <>. type: string memo: description: Additional text that describes the response. type: string required: - code type: object result: properties: codes: items: $ref: '#/components/schemas/result_code' type: array status: type: string type: object result_code: properties: code: type: string message: type: string type: object risk_assessment: description: Contains the digital wallet provider's risk assessment for provisioning the digital wallet token. properties: score: description: Wallet provider's decision as to whether the digital wallet token should be provisioned. type: string version: description: Wallet provider's risk assessment version. type: string type: object riskcontrol_tags: description: The RiskControl tags that were triggered by the transaction. properties: rule_name: description: Name of the rule, as defined in the Real-Time Decisioning dashboard, that was triggered. type: string tag: description: Tag name defined in the rule definition in the Real-Time Decisioning dashboard. type: string values: description: Value associated with the tag. items: type: string type: array type: object samsung_push_tokenize_request_data: description: Contains details about a card tokenization push request. properties: card_type: description: Specifies the type of card. type: string display_name: description: |- Name of the card as displayed in the digital wallet, typically showing the card brand and last four digits of the primary account number (PAN). `Visa 5678`, for example. type: string extra_provision_payload: description: Encrypted card or cardholder details. type: string last_digits: description: Last four digits of the primary account number of the physical or virtual card. type: string network: description: Specifies the card network of the physical or virtual card. type: string token_service_provider: description: Specifies the network that provides the digital wallet token service, as determined by the Samsung Wallet library. type: string type: object selective_auth: properties: dmd_location_sensitivity: default: 0 enum: - 0 - 1 - 2 - 3 - 4 format: int32 type: integer enable_regex_search_chain: default: false type: boolean sa_mode: default: 1 enum: - 0 - 1 - 2 format: int32 type: integer type: object sending_provisioning_data_to_google_pay_backend_request: properties: card_setting: description: |- Indicates if the Funding Primary Account Number (FPAN) will be attempted. * *1* - FPAN save will be attempted. * *0* - FPAN save will not be attempted. enum: - 0 - 1 example: 0 format: int32 type: integer card_token: description: Unique identifier of the card resource. example: 5855opl9-abcc-4cb7-a330-xyze5799ea5 type: string client_session_id: description: String provided by Google Wallet that identifies the client session. example: 5855opl9-abcc-4cb7-a330-xyze5799ea5 type: string integrator_id: description: Google-assigned string that uniquely identifies both the integrator that is initiating the session and the issuer of the card. example: ACMEISSUER_1 type: string public_device_id: description: String provided by Google Wallet that identifies the Android device that will receive the digital wallet token. example: 5855opl9-abcc-4cb7-a330-xyze5799ea5 type: string public_wallet_id: description: String provided by Google Wallet that identifies the device-scoped wallet that receives the digital wallet token. example: 5855opl9-abcc-4cb7-a330-xyze5799ea5 type: string server_session_id: description: String provided by Google Wallet that identifies the backend session. example: 8c84fab9-889c-4cb7-a330-accac5799ea5 type: string token_setting: description: |- Indicates if tokenization will be attempted. * *1* - Tokenization will be attempted. * *0* - Tokenization will not be attempted. enum: - 0 - 1 example: 0 format: int32 type: integer required: - card_setting - card_token - client_session_id - integrator_id - public_device_id - public_wallet_id - server_session_id - token_setting type: object settlement_data: description: Contains information from the card network about currency conversion at the time of settlement, including the original currency of the transaction, the amount of the transaction in the original currency, and the conversion rate. properties: amount: description: The settled amount. type: number conversion_rate: description: |- Returned when the transaction currency is different from the origination currency. Conversion rate between the origination currency and the settlement currency. type: number currency_code: description: The ISO 4217 code of the currency used in the transaction. type: string type: object shipping: properties: care_of_line: description: 255 char max type: string method: enum: - LOCAL_MAIL - LOCAL_MAIL_PACKAGE - GROUND - TWO_DAY - OVERNIGHT - INTERNATIONAL - INTERNATIONAL_PRIORITY - LOCAL_PRIORITY - FEDEX_EXPEDITED - FEDEX_REGULAR - UPS_EXPEDITED - UPS_REGULAR - USPS_EXPEDITED - USPS_REGULAR type: string recipient_address: $ref: '#/components/schemas/fulfillment_address_request' return_address: $ref: '#/components/schemas/fulfillment_address_request' type: object simulation_response_model: properties: raw_iso8583: additionalProperties: properties: { } type: object readOnly: true type: object transaction: $ref: '#/components/schemas/transaction_model' type: object spend_control_association: description: Defines the group of users to which the velocity control applies. properties: account_template_token: maxLength: 36 minLength: 1 type: string card_product_token: description: |- Unique identifier of the card product. Pass either `card_product_token` or `user_token`, not both. maxLength: 36 minLength: 1 type: string user_token: description: |- Unique identifier of the cardholder. Pass either `card_product_token` or `user_token`, not both. maxLength: 36 minLength: 1 type: string type: object ssn_response_model: description: Contains tax identification information. properties: nin: description: National Identification Number (NIN). type: string sin: description: Social Insurance Number (SIN). type: string ssn: description: United States Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN). type: string tin: description: Taxpayer Identification Number (TIN). type: string type: object store_response_model: properties: active: default: true type: boolean address1: maxLength: 255 minLength: 0 type: string address2: maxLength: 255 minLength: 0 type: string city: maxLength: 40 minLength: 0 type: string contact: maxLength: 40 minLength: 0 type: string contact_email: maxLength: 40 minLength: 0 type: string country: maxLength: 40 minLength: 0 type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string keyed_auth_cvv_enforced: default: false type: boolean last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string latitude: format: float type: number longitude: format: float type: number merchant_token: maxLength: 36 minLength: 0 type: string mid: maxLength: 50 minLength: 1 type: string name: maxLength: 40 minLength: 0 type: string network_mid: maxLength: 50 minLength: 1 type: string partial_approval_capable: default: false type: boolean partial_auth_flag: default: true description: 1 char max type: boolean phone: maxLength: 10 minLength: 0 type: string postal_code: maxLength: 10 minLength: 0 type: string province: maxLength: 20 minLength: 0 type: string state: maxLength: 255 minLength: 0 type: string token: description: The unique identifier of the merchant maxLength: 36 minLength: 1 type: string zip: maxLength: 10 minLength: 0 type: string required: - address1 - city - created_time - last_modified_time - merchant_token - mid - name - state type: object strong_customer_authentication_limits: properties: cavv_authentication_amount_incremental_percentage: readOnly: true type: string enable_biometric_bypass_sca_contactless: readOnly: true type: boolean enable_cavv_authentication_amount_validation: readOnly: true type: boolean enable_issuer_tra_exemption: readOnly: true type: boolean sca_contactless_cumulative_amount_limit: readOnly: true type: number sca_contactless_transaction_limit: readOnly: true type: number sca_contactless_transactions_count_limit: format: int32 readOnly: true type: integer sca_contactless_transactions_currency: readOnly: true type: string sca_lvp_cumulative_amount_limit: readOnly: true type: number sca_lvp_transaction_limit: readOnly: true type: number sca_lvp_transactions_count_limit: format: int32 readOnly: true type: integer sca_lvp_transactions_currency: readOnly: true type: string sca_tra_exemption_amount_limit: readOnly: true type: number type: object tag: properties: name: description: Name of the tag. type: string value: description: Value of the tag. type: string type: object terminal_model: description: |- Contains information about the point of sale, including details on how the card was presented. Returned if provided by the card network, and the request uses Transaction Model v1 of the Marqeta Core API. Not returned for Transaction Model v2 requests. properties: card_presence: description: Indicates whether the card was present during the transaction. type: string cardholder_presence: description: Indicates whether the cardholder was present during the transaction. type: string partial_approval_capable: description: Indicates whether the card acceptor or terminal supports partial-approval transactions. type: string pin_present: description: Indicates whether the cardholder entered a PIN during the transaction. type: string special_condition_indicator: description: |- Indicates a higher-risk operation, such as a quasi-cash or cryptocurrency transaction. These transactions typically involve non-financial institutions. enum: - UNSPECIFIED - CRYPTOCURRENCY_PURCHASE - QUASI_CASH - DEBT_PAYMENT - CENTRAL_BANK_DIGITAL_CURRENCY_PURCHASE - STABLECOIN_PURCHASE - BLOCKCHAIN_NATIVE_TOKEN_PURCHASE - NON_FUNGIBLE_TOKEN_PURCHASE type: string tid: description: Card acceptor or terminal identification number. type: string transaction_initiated_by: description: Specifies the initiator of the transaction. enum: - CONSUMER - MERCHANT - UNKNOWN - MARQETA - NETWORK type: string transaction_initiated_category: description: Specifies the category of a point-of-sale transaction. enum: - CARD_ON_FILE - RECURRING_VAR_AMT_FIXED_FREQ - RECURRING_PAYMENT - INSTALLMENT_PAYMENT - UNSCHEDULED_PAYMENT - PARTIAL_SHIPMENT - DELAYED_PAYMENT - NO_SHOW - RESUBMISSION - DEFERRED_BILLING - ACCOUNT_INQUIRY - INCREMENTAL_AUTHORIZATION - REAUTHORIZATION type: string type: object text: description: Specifies personalized text that appears on the card. properties: name_line_1: $ref: '#/components/schemas/text_value' name_line_2: $ref: '#/components/schemas/text_value' name_line_3: $ref: '#/components/schemas/text_value' required: - name_line_1 type: object text_value: properties: value: description: Line of personalized text printed on the card. type: string type: object token_request: properties: account_number: type: string business_token: description: required if 'user_token' is null maxLength: 36 minLength: 1 type: string cvv_number: maxLength: 4 minLength: 3 type: string exp_date: type: string is_default_account: default: false type: boolean postal_code: type: string token: maxLength: 36 minLength: 1 type: string user_token: description: required if 'business_token' is null maxLength: 36 minLength: 1 type: string zip: type: string required: - account_number - cvv_number - exp_date type: object token_service_provider: description: Contains information held and provided by the token service provider (card network). properties: correlation_id: description: Unique value representing a tokenization request (Mastercard only). type: string pan_reference_id: description: Unique identifier of the digital wallet token primary account number (PAN) within the card network. type: string token_assurance_level: description: _(Mastercard only)_ Represents the confidence level in the digital wallet token. type: string token_eligibility_decision: description: Digital wallet's decision as to whether the digital wallet token should be provisioned. type: string token_expiration: description: Expiration date of the digital wallet token. type: string token_pan: description: Primary account number (PAN) of the digital wallet token. type: string token_reference_id: description: Unique identifier of the digital wallet token within the card network. type: string token_requestor_id: description: |- Unique numerical identifier of the token requestor within the card network. These ID numbers map to `token_requestor_name` field values as follows: *Mastercard* * 50110030273 – `APPLE_PAY` * 50120834693 – `ANDROID_PAY` * 50139059239 – `SAMSUNG_PAY` *Visa* * 40010030273 – `APPLE_PAY` * 40010075001 – `ANDROID_PAY` * 40010043095 – `SAMSUNG_PAY` * 40010075196 – `MICROSOFT_PAY` * 40010075338 – `VISA_CHECKOUT` * 40010075449 – `FACEBOOK` * 40010075839 – `NETFLIX` * 40010077056 – `FITBIT_PAY` * 40010069887 – `GARMIN_PAY` type: string token_requestor_name: description: |- Name of the token requestor within the card network. *NOTE:* The list of example values for this field is maintained by the card networks and is subject to change. type: string token_score: description: Token score assigned by the digital wallet. type: string token_service_provider_id: type: string token_type: description: Type of the digital wallet token. type: string required: - pan_reference_id type: object token_update_request: properties: active: default: true type: boolean exp_date: type: string is_default_account: default: false type: boolean required: - exp_date type: object transaction_card_acceptor: description: Contains information about the merchant. properties: address: description: |- 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. type: string business_registration_id: description: Business registration identifier, as provided by the Visa card network. type: string business_registration_id_type: description: Business registration identifier type, as provided by the Visa card network. enum: - unspecified - tax_registration_identification - national_identification - company_registration_identification - passport - default_value type: string city: description: Card acceptor's city. type: string country_code: description: |- 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. type: string country_of_origin: description: |- The merchant's country of origin. A merchant's country of origin can be different from the country in which the merchant is located. For example, embassies are physically located in countries that are not their country of origin: a Mexican embassy might be physically located in Singapore, but the country of origin is Mexico. This field is included when the cardholder conducts a transaction with a government-controlled merchant using a Marqeta-issued card. type: string customer_service_phone: type: string geographic_coordinates: description: For Mastercard only. + Geographic coordinates of the card acceptor in `latitudeE7,longitudeE7` format. type: string independent_sales_organization_id: type: string legal_business_name: description: Legal business name, as provided by the Visa card network. type: string mcc: description: Merchant category code (MCC). type: string mcc_groups: description: An array of `mcc_groups`. items: type: string type: array merchant_tax_id: type: string merchant_vat_registration_id: description: The VAT registration identifier of the merchant. type: string mid: description: The merchant identifier. type: string name: description: Card acceptor's name. type: string network_assigned_id: description: Identifier assigned by the card network. type: string network_mid: description: The merchant identifier on the card network. type: string payment_facilitator_id: type: string payment_facilitator_name: description: |- The name of the payment facilitator, including the sub-merchant identifier, of an original credit transaction. This field is returned when a payment facilitator participates in the transaction. type: string phone: type: string poi: $ref: '#/components/schemas/terminal_model' postal_code: description: Card acceptor's postal code. type: string service_geographic_coordinates: description: For Mastercard only. + Geographic coordinates of the service provider in `latitudeE7,longitudeE7` format. type: string special_merchant_id: type: string state: description: |- State, provincial, territorial, or federal abbreviation (`CA` for California or `CAN` for Canada, for example). For the complete list, see <>. *Note*: Non-US merchants may return more than 2 char for this field. type: string sub_merchant_id: type: string transfer_service_provider_name: description: |- The name of the transfer service provider of a money transfer original credit transaction. This field is included when a transfer service provider participates in the transaction. type: string url: type: string type: object transaction_controls: properties: accepted_countries_token: description: 50 char max (default = accept_us_only) type: string address_verification: $ref: '#/components/schemas/avs_controls' allow_chip_fallback: default: false type: boolean allow_first_pin_set_via_financial_transaction: default: false type: boolean allow_gpa_auth: default: false type: boolean allow_mcc_group_authorization_controls: default: false type: boolean allow_network_load: default: false type: boolean allow_network_load_card_activation: default: false type: boolean allow_quasi_cash: default: false type: boolean always_require_icc: default: false type: boolean always_require_pin: default: false type: boolean enable_credit_service: default: false type: boolean enable_partial_auth_approval: default: false type: boolean ignore_card_suspended_state: default: false type: boolean notification_language: type: string quasi_cash_exempt_merchant_group_token: description: 36 char max maxLength: 36 minLength: 1 type: string quasi_cash_exempt_mids: type: string require_card_not_present_card_security_code: default: false type: boolean strong_customer_authentication_limits: $ref: '#/components/schemas/strong_customer_authentication_limits' type: object transaction_device: description: |- Contains information about the device used in the transaction to enhance the risk decisioning process. Use this data to improve fraud prevention and dispute resolution. properties: binding_id: description: Unique identifier of the data component bound to the credential. type: string ip_address: description: |- IP address of the device. The presence of the IP address helps determine if the transaction was initiated from an unusual network, helping establish a pattern of safe device usage that further confirms the authenticity of the consumer who initiated the transaction. type: string location: description: |- Geographic coordinates of the device. Contains the latitude and longitude of the device used when the cardholder was authenticated during checkout. This field helps to determine if the transaction was initiated from an unexpected location. type: string phone_number: description: |- Telephone number of the device. Contains the phone number that was used to authenticate the consumer during checkout, or the consumer's preferred phone number. The presence of the phone number helps establish the consumer's authenticity when matching the phone number provided during checkout to a list of known phone numbers for the consumer. type: string type: object transaction_fleet_model: properties: prompt_data: $ref: '#/components/schemas/PromptData' purchase_type: enum: - fuel - non_fuel - fuel_and_non_fuel type: string type: object transaction_metadata: description: |- Contains merchant-provided metadata related to the transaction, including details about lodging- and transit-related purchases. May be returned if the request uses Transaction Model v2 of the Marqeta Core API. Not returned for Transaction Model v1 requests. properties: airline: $ref: '#/components/schemas/airline' authorization_life_cycle: description: Number of days the pre-authorization is in effect. format: int32 type: integer cross_border_transaction: default: false description: Whether the transaction is cross-border, i.e., when the merchant and the cardholder are located in two different countries. type: boolean is_deferred_authorization: description: Indicates an offline authorization made during an interruption of card network connectivity, such as a purchase on a flight. type: boolean is_lodging_auto_rental: default: false description: Whether the transaction is a lodging or vehicle rental. type: boolean lodging_auto_rental_start_date: description: Date and time when the lodging check-in or vehicle rental began. format: date-time type: string memo: description: Indicates a credit or debit adjustment in a clearing transaction. enum: - CREDIT_ADJUSTMENT - DEBIT_ADJUSTMENT maxLength: 99 minLength: 1 type: string moto_indicator: description: Indicates the type of mail or telephone order transaction. enum: - UNKNOWN - MANUAL - RECURRING - INSTALLMENT - OTHERS type: string one_leg_out: type: boolean payment_channel: description: Channel from which the transaction was originated. enum: - OTHER - ATM - ECOMMERCE - MAIL - PHONE - MOTO type: string special_purchase_id: type: string transaction_category: description: Type of product or service being purchased, if provided by the merchant. enum: - RETAIL_SALE - BILL_PAY - HOTEL - HEALTH_CARE - RESTAURANT - AUTO_RENTAL - AIRLINE - PAYMENT - HOSPITALIZATION_COLLEGE - PHONE_MAIL_ECOMMERCE - ATM - TRANSIT - EXTENDED_AUTHORIZATION type: string transit: $ref: '#/components/schemas/transit' type: object transaction_model: description: |- Transactions are represented by the `transaction` object. The Marqeta platform creates a separate `transaction` object for each transaction message received from the card network. The attributes of a given `transaction` object depend on the transaction type. This section documents all fields that might be included in a `transaction` object. // This schema is used by InfoDev to generate API reference documentation. // File location in GitHub is: openapi/transactions/schemas/transaction_model.yaml properties: account_funding: $ref: '#/components/schemas/account_funding' account_name_verification: $ref: '#/components/schemas/account_name_verification_model' account_owner: $ref: '#/components/schemas/account_owner_model' accounts: items: $ref: '#/components/schemas/account_balance' type: array acquirer: $ref: '#/components/schemas/acquirer' acquirer_fee_amount: description: |- Indicates the amount of the acquirer fee. Account holders are sometimes charged an acquirer fee for card use at ATMs, fuel dispensers, and so on. type: number acquirer_reference_data: description: |- Acquirer-assigned unique identifier of the transaction. Useful for settlement and reconciliation. type: string acquirer_reference_id: description: |- Acquirer-assigned unique identifier of the transaction. Useful for settlement and reconciliation. type: string acting_user_token: description: |- Unique identifier of the user who conducted the transaction. This might be a child user configured to share its parent's account balance. maxLength: 36 minLength: 0 type: string address_verification: $ref: '#/components/schemas/address_verification_model' advice_reason_code: description: Extended stand-in processing (STIP) reason code, as provided by the card network. type: string advice_reason_details: description: Extended stand-in processing (STIP) reason details, as provided by the card network. type: string amount: description: Amount of the transaction. type: number amount_to_be_released: description: |- Amount of original authorization to be released. This field appears in final clearing transactions where the clearing amount is lower than the authorization amount. type: number anticipated_amount: description: |- Anticipated amount of the transaction, as provided by the card network. This field applies to anticipated amount verification transactions (AAVTs). type: number approval_code: description: Unique identifier assigned to an authorization, printed on the receipt at point of sale. type: string atc_information: $ref: '#/components/schemas/ATCInformationModel' authorization_expiration: format: date-time type: string auto_reload: $ref: '#/components/schemas/auto_reload_model' bank_transfer_token: type: string batch_number: description: The batch number of the transaction. type: string billpay: $ref: '#/components/schemas/BillPayResponse' business: $ref: '#/components/schemas/business_metadata' business_token: description: Unique identifier of the business that owns the account that funded the transaction. maxLength: 36 minLength: 0 type: string card: $ref: '#/components/schemas/card_response' card_acceptor: $ref: '#/components/schemas/transaction_card_acceptor' card_holder_model: $ref: '#/components/schemas/user_card_holder_response' card_product_token: description: Unique identifier of the card product. maxLength: 36 minLength: 0 type: string card_security_code_verification: $ref: '#/components/schemas/card_security_code_verification' card_token: description: |- Unique identifier of the card. Useful when a single account holder has multiple cards. maxLength: 36 minLength: 0 type: string cardholder_authentication_data: $ref: '#/components/schemas/cardholder_authentication_data' cash_back_amount: description: |- Amount of cash back requested by the cardholder during the transaction. Included in the total transaction amount. type: number cashloads_direct: $ref: '#/components/schemas/CashloadsResponseModel' chargeback: $ref: '#/components/schemas/chargeback_response' clearing_record_sequence_number: description: A sequence number that identifies a specific clearing message among multiple clearing messages for an authorization. type: string created_time: description: |- 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. format: date-time type: string currency_code: description: Currency type of the transaction. type: string currency_conversion: $ref: '#/components/schemas/currency_conversion' deferred_settlement_days: type: string digital_commerce_authentication_indicator: description: |- Visa Digital Commerce Authentication Program (VDCAP) indicator for U.S. domestic card-not-present transactions. Indicates the presence of key data elements, along with the eligible method used to share authentication data. * *02:* Visa Secure * *03:* Visa data only * *04:* Visa Payment Passkey with Visa Secure * *05:* Visa Payment Passkey with Visa Token Service * *06:* IDX 3rd party * *07:* Visa Token Service data only type: string digital_wallet_token: $ref: '#/components/schemas/digital_wallet_token' digital_wallet_token_transaction_service_provider_info: $ref: '#/components/schemas/digital_service_provider' direct_deposit: $ref: '#/components/schemas/DepositDepositResponse' dispute: $ref: '#/components/schemas/DisputeModel' duration: description: Duration of the transaction on Marqeta's servers, in milliseconds. format: int32 type: integer enhanced_data_token: description: The enhanced commercial card data token for the transaction. type: string estimated_authorization: description: |- Indicates an estimated authorization. An estimated authorization allows the merchant to obtain an approval for funds before the cardholder has finalized exactly what goods or services will be purchased. type: boolean fee: $ref: '#/components/schemas/fee' fee_transfer: $ref: '#/components/schemas/fee_transfer_response' fees: description: |- List of fees associated with the transaction. This array is returned if it exists in the resource. items: $ref: '#/components/schemas/network_fee_model' type: array fleet_data: $ref: '#/components/schemas/transaction_fleet_model' flex: $ref: '#/components/schemas/flex' fraud: $ref: '#/components/schemas/fraud_view' from_account: description: Specifies the funding account type. type: string from_account_token: type: string gpa: $ref: '#/components/schemas/cardholder_balance' gpa_order: $ref: '#/components/schemas/gpa_response' gpa_order_unload: $ref: '#/components/schemas/gpa_returns' identifier: description: Sequential identifier of the transaction. type: string incremental_authorization_transaction_tokens: description: An array of incremental authorization transaction tokens. items: type: string type: array installment_data: $ref: '#/components/schemas/installment_data' interchange_rate_descriptor: type: string is_final_clearing: description: |- Indicates the final clearing event for an authorization. If the final cleared amount is lower than the authorized amount, you must release the hold on the funds per the value in the `amount_to_be_released` field. type: boolean is_preauthorization: default: false description: Indicates if the transaction is a pre-authorization. type: boolean isaIndicator: description: The international service assessment indicator indicates if an ISA fee is applicable to the transaction. enum: - MULTI_CURRENCY - SINGLE_CURRENCY - REBATE_CANCELLED - MULTI_CURRENCY_NON_US_COUNTRIES - SINGLE_CURRENCY_PAID_BY_ISSUER - NO_CHARGE_ASSESSED type: string issuer_interchange_amount: description: The amount of interchange charged by the card issuer. type: number issuer_payment_node: description: Unique identifier of the Marqeta platform server that received the transaction from the card network. type: string issuer_received_time: description: Date and time when the Marqeta platform received the transaction from the card network, in UTC. type: string local_transaction_date: description: |- Indicates the local time of the transaction at the card acceptor's location. You can use this field to determine the correct time of the transaction when filing a dispute. format: date-time type: string merchant: $ref: '#/components/schemas/merchant_response_model' merchant_initiated_original_trace_id: description: Unique network identification value formed by combining the 6- to 9-character Mastercard Banknet Reference Number and the 4-digit settlement date for recurring payments and other merchant-initiated transactions. type: string multi_clearing_sequence_count: description: |- If an authorization has multiple clearing transactions, this field displays their total number. For example, if an authorization has four clearing transactions, the sequence count is `04`. type: string multi_clearing_sequence_number: description: |- If an authorization has multiple clearing transactions, this field displays the sequence number for the clearing transaction. For example, if this is the second clearing transaction of four, the sequence number is `02`. type: string national_net_cpd_of_original: type: string network: description: Indicates which card network was used to complete the transactions. type: string network_metadata: $ref: '#/components/schemas/network_metadata' network_reference_id: description: |- Network-assigned unique identifier of the transaction. Useful for settlement and reconciliation. type: string network_transaction_lifecycle_id: description: |- Transaction identifier, as provided by the card network. This identifier connects the original transaction to all subsequent activities throughout the transaction lifecycle. type: string original_credit: $ref: '#/components/schemas/original_credit' original_network_transaction_lifecycle_id: type: string original_transaction_token: description: Unique identifier of the original transaction in a series of related transactions. type: string payment_facilitator: $ref: '#/components/schemas/payment_facilitator_model' peer_transfer: $ref: '#/components/schemas/peer_transfer_response' polarity: description: Indicates whether the transaction is credit or debit. enum: - CREDIT - DEBIT - PENDING_CREDIT - PENDING_DEBIT type: string pos: $ref: '#/components/schemas/pos' preceding_related_transaction_token: description: |- Returned for final transaction types. Unique identifier of the preceding related transaction. Useful for identifying the transaction that preceded the current one. For example, `authorization`, a temporary transaction type, precedes and is completed by `authorization.clearing`, a final transaction type. In this case, the `authorization` token is returned with this field. For which transaction types are temporary or final, see <>. type: string preceding_transaction: $ref: '#/components/schemas/preceding_transaction' program: $ref: '#/components/schemas/program' program_reserve_deposit_info: $ref: '#/components/schemas/program_reserve_transaction_response' program_transfer: $ref: '#/components/schemas/program_transfer_response' real_time_fee_group: $ref: '#/components/schemas/real_time_fee_group' reconciliation_cycle: type: string relay_resistance_protocol_result: type: string request_amount: description: Merchant-requested amount, including any fees. type: number response: $ref: '#/components/schemas/response' settlement_date: description: |- 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. format: date-time type: string settlement_indicator: description: Indicates the settlement service used for the transaction. type: string standin_approved_by: description: |- Indicates which party approved a transaction: the card network using stand-in processing, or Marqeta using Commando Mode. Returned only when a transaction is approved. type: string standin_by: description: 'Indicates which party approved a transaction: the card network using stand-in processing, or Marqeta using Commando Mode.' type: string standin_reason: description: Indicates why the card network handled a transaction requiring stand-in processing. type: string state: description: |- Current state of the transaction. For more information about the `state` field, see <>. enum: - PENDING - CLEARED - COMPLETION - DECLINED - ERROR type: string store: $ref: '#/components/schemas/store_response_model' strong_customer_authentication: $ref: '#/components/schemas/StrongCustomerAuthenticationModel' subnetwork: description: |- Indicates which subnetwork was used to complete the transaction. Possible values include the following: * *VISANET* – Used for VisaNet signature-based transactions. * *VISANETDEBIT* – Used for VisaNet Debit PIN-based transaction. * *VISAINTERLINK* – Used for Visa Interlink PIN-based transactions. * *VISAPLUS* – Used for ATM withdrawals on Visa. * *MAESTRO* – Used for PIN-based transactions on Mastercard. * *CIRRUS* – Used for ATM withdrawals on Mastercard. * *MASTERCARDDEBIT* – Used for signature-based transactions on Mastercard. * *GATEWAY_JIT* – Used for Gateway JIT Funding transactions. * *MANAGED_JIT* – Used for Managed JIT Funding transactions or for transactions that occur while Commando Mode is enabled. type: string to_account: description: Specifies the receiving account type. type: string token: description: |- Unique identifier of the transaction, formatted as a UUID. *NOTE:* For subsequent related transactions, this token value appears as the `preceding_related_transaction_token`. maxLength: 36 minLength: 1 readOnly: true type: string transaction_attributes: additionalProperties: type: string description: Additional transaction attributes. type: object transaction_metadata: $ref: '#/components/schemas/transaction_metadata' type: description: |- Transaction event type. For more information about the `type` field, see <>. enum: - gpa.credit - gpa.credit.pending - gpa.credit.pending.reversal - gpa.credit.reversal - gpa.credit.networkload - gpa.credit.networkload.reversal - gpa.debit.networkload - gpa.debit - gpa.debit.pending - gpa.debit.pending.reversal - gpa.grant - gpa.credit.issueroperator - gpa.debit.issueroperator - gpa.credit.chargeback - gpa.credit.chargeback.reversal - gpa.credit.billpayment - gpa.credit.authorization.billpayment - gpa.credit.authorization.billpayment.reversal - authorization - authorization.advice - authorization.reversal - authorization.clearing - authorization.reversal.issuerexpiration - dispute.credit - dispute.debit - authorization.clearing.chargeback - authorization.clearing.chargeback.reversal - refund - pindebit.atm.withdrawal - pindebit.balanceinquiry - pindebit.cashback - pindebit.checkavs - pindebit - programreserve.credit - programreserve.debit - fee.charge.pending - fee.charge - fee.charge.refund - fee.charge.reversal - fee.charge.waived - funds.expire - reward.earn - transfer.peer - transfer.fee - account.funding.authorization - account.funding.authorization.reversal - account.funding.authorization.clearing - account.funding.auth_plus_capture - account.funding.auth_plus_capture.reversal - account.credit - account.debit - balanceinquiry - authorization.atm.withdrawal - authorization.pin.change - authorization.pin.unblock - authorization.clearing.atm.withdrawal - authorization.cashback - authorization.clearing.cashback - transfer.program - authorization.quasi.cash - authorization.clearing.quasi.cash - authorization.incremental - gpa.credit.authorization - gpa.credit.authorization.reversal - gpa.debit.authorization - gpa.debit.reversal - original.credit.authorization - original.credit.authorization.reversal - original.credit.authorization.clearing - original.credit.auth_plus_capture - original.credit.auth_plus_capture.reversal - refund.authorization - refund.authorization.advice - refund.authorization.clearing - refund.authorization.reversal - token.activation-request - token.advice - pindebit.authorization - pindebit.authorization.clearing - pindebit.authorization.reversal - pindebit.authorization.reversal.issuerexpiration - authorization.standin - authorization.clearing.chargeback.completed - authorization.clearing.chargeback.provisional.credit - authorization.clearing.chargeback.provisional.debit - authorization.clearing.chargeback.writeoff - directdeposit.credit - directdeposit.credit.pending - directdeposit.credit.reject - directdeposit.credit.pending.reversal - directdeposit.credit.reversal - directdeposit.debit - directdeposit.debit.pending - directdeposit.debit.reject - directdeposit.debit.reversal - pin.change.reversal - pin.change.reversal.advice - directdeposit.debit.pending.reversal - pindebit.chargeback - pindebit.chargeback.completed - pindebit.chargeback.provisional.credit - pindebit.chargeback.provisional.debit - pindebit.chargeback.reversal - pindebit.chargeback.writeoff - pindebit.pin.change - pindebit.pin.unblock - pindebit.credit.adjustment - pindebit.quasi.cash - pindebit.refund - pindebit.refund.reversal - pindebit.reversal - pindebit.transfer - pushtocard.debit - pushtocard.reversal - credit.adjustment - debit.adjustment - pin.change.via.api - product.inquiry - transit.offer - transfer.from.checking.hold - transfer.from.checking.clear - transfer.to.checking.open - transfer.to.checking.clear - transfer.to.savings.open - transfer.to.savings.clear - transfer.from.savings.hold - transfer.from.savings.clear - fps.debit.hold - fps.debit.clear - fps.debit.hold.reverse - fps.debit.clear.reverse - fps.credit.open - fps.credit.clear - fps.credit.open.reverse - fps.credit.clear.reverse - open.banking.fps.debit.hold - open.banking.fps.debit.clear - open.banking.fps.debit.hold.reverse - open.banking.fps.debit.clear.reverse - interest.posting.clear - interest.posting.clear.reverse - interest.posting.adjustment - unknown type: string user: $ref: '#/components/schemas/cardholder_metadata' user_token: description: Unique identifier of the user who owns the account that funded the transaction; subsequent related transactions retain the same `user_token`, even if the card used to complete the transaction moves to another user. maxLength: 36 minLength: 0 type: string user_transaction_time: description: |- Date and time when the user initiated the transaction, in UTC. For example, when a merchant performed the original authorization for a refund. format: date-time type: string vdcap_qualified: type: boolean velocity_control_balances: additionalProperties: $ref: '#/components/schemas/available' type: object visa_pop_code: type: string required: - acting_user_token - amount - state - token - type title: Transaction object type: object transaction_options: properties: additional_data: type: string card_expiration_date_yymm: type: string database_transaction_timeout: format: int32 type: integer encryption_key_id: type: string is_async: default: false type: boolean pre_auth_time_limit: type: string send_expiration_date: default: false type: boolean send_track_data: default: false type: boolean transaction_timeout_threshold_seconds: format: int64 type: integer transaction_token: type: string type: object transit: description: Contains merchant-provided, transit-related metadata related to the transaction. properties: transaction_type: description: Type of transit transaction. enum: - PRE_FUNDED - REAL_TIME_AUTHORIZED - POST_AUTHORIZED_AGGREGATED - AUTHORIZED_AGGREGATED_SPLIT_CLEARING - OTHER - DEBIT_RECOVERY - AGGREGATED_TRANSACTION - ACCOUNT_STATUS_INQUIRY type: string transportation_mode: description: Mode of transportation. enum: - BUS - TRAIN - WATER_BORNE_VEHICLE - TOLL - PARKING - TAXI - PARA_TRANSIT - SELF_DRIVE_VEHICLE - COACH - LOCOMOTIVE - POWERED_MOTOR_VEHICLE - TRAILER - INTER_CITY - CABLE_CAR type: string type: object triggered_rule: description: Provides a list of rules triggered by a fraud event, along with the information on tags and rule characteristics. properties: alert: description: Indicates if the rule triggered an alert. type: boolean entity_type: description: The entity type where the triggered rule was defined. type: string rule_name: description: Name of the rule, as defined in the Real-Time Decisioning dashboard that was triggered. type: string suppress_alert: description: Indicates if the triggered rule has `suppress_alert` in the definition. type: boolean tags: description: All the tags defined in the triggered rule. items: $ref: '#/components/schemas/tag' type: array type: object unload_request_model: properties: amount: type: number funding_source_address_token: maxLength: 36 minLength: 1 type: string memo: maxLength: 99 minLength: 0 type: string original_order_token: maxLength: 36 minLength: 1 type: string tags: maxLength: 255 minLength: 0 type: string token: maxLength: 36 minLength: 1 type: string required: - amount - original_order_token type: object user_accounts_balance_response: properties: account_balances: items: $ref: '#/components/schemas/account_balance' type: array user_token: type: string required: - account_balances type: object user_association: properties: single_inventory_user: default: false type: boolean single_inventory_user_token: default: 'false' maxLength: 36 minLength: 1 type: string type: object user_card_holder_response: description: Contains information about a cardholder. properties: account_holder_group_token: description: Associates the specified account holder group with the cardholder. maxLength: 36 minLength: 0 type: string active: default: false description: Specifies if the cardholder is in the `ACTIVE` state on the Marqeta platform. type: boolean address1: description: Cardholder's address. maxLength: 255 minLength: 0 type: string address2: description: Additional address information for the cardholder. maxLength: 255 minLength: 0 type: string authentication: $ref: '#/components/schemas/Authentication' birth_date: description: Cardholder's date of birth. type: string birth_place: description: Country where the cardholder was born. maxLength: 255 minLength: 0 type: string business_token: description: Unique identifier of the business resource. type: string city: description: City where the cardholder resides. maxLength: 40 minLength: 0 type: string company: description: Company name. maxLength: 255 minLength: 0 type: string corporate_card_holder: default: false description: Specifies if the cardholder holds a corporate card. type: boolean country: description: Country where the cardholder resides. maxLength: 40 minLength: 0 type: string created_time: description: Date and time when the resource was created, in UTC. format: date-time type: string email: description: Valid email address of the cardholder. maxLength: 255 minLength: 1 type: string first_name: description: Cardholder's first name. maxLength: 40 minLength: 0 type: string gender: description: Gender of the cardholder. enum: - F - M maxLength: 1 minLength: 0 type: string honorific: description: 'Cardholder''s title or prefix: Dr., Miss, Mr., Ms., and so on.' maxLength: 10 minLength: 0 type: string id_card_expiration_date: description: Expiration date of the cardholder's identification. readOnly: true type: string id_card_number: description: Cardholder's identification card number. maxLength: 255 minLength: 0 type: string identifications: description: One or more objects containing identifications associated with the cardholder. items: $ref: '#/components/schemas/IdentificationResponseModel' type: array ip_address: description: Cardholder's IP address. maxLength: 39 minLength: 0 type: string last_modified_time: description: Date and time when the resource was last updated, in UTC. format: date-time type: string last_name: description: Cardholder's last name. maxLength: 40 minLength: 0 type: string metadata: additionalProperties: type: string description: Associates any additional metadata you provide with the cardholder. type: object middle_name: description: Cardholder's middle name. maxLength: 40 minLength: 0 type: string nationality: description: Cardholder's nationality. maxLength: 255 minLength: 0 type: string notes: description: Any additional information pertaining to the cardholder. maxLength: 255 minLength: 0 type: string parent_token: description: Unique identifier of the parent user or business resource. maxLength: 36 minLength: 1 type: string passport_expiration_date: description: Expiration date of the cardholder's passport. readOnly: true type: string passport_number: description: Cardholder's passport number. maxLength: 40 minLength: 0 type: string password: description: Password to the cardholder's user account on the Marqeta platform. maxLength: 255 minLength: 1 type: string phone: description: Cardholder's telephone number. maxLength: 255 minLength: 0 type: string postal_code: description: Postal code of the cardholder's address. maxLength: 10 minLength: 0 type: string ssn: description: Cardholder's Social Security Number (SSN). type: string state: description: State or province where the cardholder resides. maxLength: 2 minLength: 0 type: string status: description: Specifies the status of the cardholder on the Marqeta platform. enum: - UNVERIFIED - LIMITED - ACTIVE - SUSPENDED - CLOSED type: string title: description: Professional title of the cardholder, such as Chief Comptroller. maxLength: 255 minLength: 0 type: string token: description: Unique identifier of the cardholder. maxLength: 36 minLength: 1 type: string uses_parent_account: default: false description: Indicates whether the child shares balances with the parent (`true`), or the child's balances are independent of the parent (`false`). type: boolean zip: description: United States ZIP code of the cardholder's address. maxLength: 10 minLength: 0 type: string required: - created_time - last_modified_time type: object user_card_holder_search_model: properties: dda: description: |- Performs a match on the specified deposit account number. Send a `GET` request to `/directdeposits/accounts/{user_token}` to retrieve the deposit account number for a specific cardholder. type: string email: description: Performs a non-case-sensitive, exact match on the cardholder's `email` field. maxLength: 255 minLength: 1 type: string first_name: description: |- Performs a non-case-sensitive match on the cardholder's `first_name` field. Matching is partial on the beginning of the name. For example, a match on "Alex" returns both "Alex" and "Alexander". maxLength: 40 minLength: 0 type: string last_name: description: |- Performs a non-case-sensitive match on the cardholder's `last_name` field. Matching is partial on the beginning of the name. For example, a match on "Smith" returns both "Smith" and "Smithfield". maxLength: 40 minLength: 0 type: string phone: description: Performs a match on the cardholder's `phone` field. maxLength: 255 minLength: 0 type: string ssn: description: Performs a match on the cardholder's identification number. type: string type: object velocity_control_balance_response: properties: active: description: Indicates whether the velocity control is active. type: boolean amount_limit: description: |- Maximum monetary sum that can be cleared within the time period defined by the `velocity_window` field. Refunds and reversals cannot exceed this limit. exclusiveMinimum: false minimum: 0 type: number approvals_only: description: |- If set to `true`, only approved transactions are subject to control. If set to `false`, only declined transactions are subject to control. type: boolean association: $ref: '#/components/schemas/spend_control_association' available: $ref: '#/components/schemas/available' currency_code: description: Three-character ISO 4217 currency code. type: string include_cashback: description: If set to `true`, the cashback components of point-of-sale transactions are subject to control. type: boolean include_credits: description: If set to `true`, original credit transactions (OCT) are subject to control. type: boolean include_purchases: description: |- If set to `true`, the following transactions are subject to control: * *Account funding:* All account funding transactions * *Cashback:* Only the purchase component of cashback transactions * *Purchase transactions:* All authorizations, PIN debit transactions, and incremental transactions * *Quasi-cash:* All quasi-cash transactions * *Refunds:* All refund transactions (see <> for more information) * *Reversals:* All reversal transactions type: boolean include_transfers: description: |- If set to `true`, account-to-account transfers are subject to control. Account-to-account transfers are not currently supported. type: boolean include_withdrawals: description: If set to `true`, ATM withdrawals are subject to control. type: boolean merchant_scope: $ref: '#/components/schemas/merchant_scope' money_in_transaction: $ref: '#/components/schemas/money_in_transaction' name: description: Description of how the velocity control restricts spending, for example, "Max spend of $500 per day" or "Max spend of $5000 per month for non-exempt employees". maxLength: 255 minLength: 0 type: string token: description: Unique identifier of the velocity control. maxLength: 36 minLength: 1 type: string usage_limit: description: Maximum number of times a card can be used within the time period defined by the `velocity_window` field. format: int32 minimum: -1 type: integer velocity_window: description: |- Defines the time period to which the `amount_limit` and `usage_limit` fields apply: * *DAY* – one day; days begin at 00:00:00 UTC. * *WEEK* – one week; weeks begin Sundays at 00:00:00 UTC. * *MONTH* – one month; months begin on the first day of month at 00:00:00 UTC. * *LIFETIME* – forever; time period never expires. * *TRANSACTION* – a single transaction. enum: - DAY - WEEK - MONTH - LIFETIME - TRANSACTION type: string required: - amount_limit - available - currency_code - velocity_window type: object velocity_control_request: properties: active: description: Indicates whether the velocity control is active. type: boolean amount_limit: description: |- Maximum monetary sum that can be cleared within the time period defined by the `velocity_window` field. Refunds and reversals cannot exceed this limit. exclusiveMinimum: false minimum: 0 type: number approvals_only: description: |- If set to `true`, only approved transactions are subject to control. If set to `false`, only declined transactions are subject to control. type: boolean association: $ref: '#/components/schemas/spend_control_association' currency_code: description: Three-character ISO 4217 currency code. type: string include_cashback: description: If set to `true`, the cashback components of point-of-sale transactions are subject to control. type: boolean include_credits: description: |- If set to `true`, original credit transactions (OCT) are subject to control. Your request can contain either a `money_in_transaction` object or the `include_credits` field, not both. type: boolean include_purchases: description: |- If set to `true`, the following transactions are subject to control: * *Account funding:* All account funding transactions * *Cashback:* Only the purchase component of cashback transactions * *Purchase transactions:* All authorizations, PIN debit transactions, and incremental transactions * *Quasi-cash:* All quasi-cash transactions * *Refunds:* All refund transactions (see <> for more information) * *Reversals:* All reversal transactions type: boolean include_transfers: description: |- If set to `true`, account-to-account transfers are subject to control. Account-to-account transfers are not currently supported. type: boolean include_withdrawals: description: If set to `true`, ATM withdrawals are subject to control. type: boolean merchant_scope: $ref: '#/components/schemas/merchant_scope' money_in_transaction: $ref: '#/components/schemas/money_in_transaction' name: description: |- Description of how the velocity control restricts spending, for example, "Max spend of $500 per day" or "Max spend of $5000 per month for non-exempt employees". Ensure that the description you provide here adequately captures the kind of restriction exerted by this velocity control, because the Marqeta platform will send this information to you in a webhook in the event that the transaction authorization attempt is declined by the velocity control. *NOTE:* This field is very important. If your program has multiple velocity controls in place, it is not always clear which one prevented the transaction from being approved. Adding specific details to this field gives you more contextual information when debugging or monitoring declined authorization attempts. maxLength: 255 minLength: 0 type: string token: description: |- Unique identifier of the velocity control. If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. maxLength: 36 minLength: 1 type: string usage_limit: description: |- Maximum number of times a card can be used within the time period defined by the `velocity_window` field. If `velocity_window` is set to `TRANSACTION`, do not include a `usage_limit` in your request. Set to `-1` to indicate that the card can be used an unlimited number of times. format: int32 minimum: -1 type: integer velocity_window: description: |- Defines the time period to which the `amount_limit` and `usage_limit` fields apply: * *DAY* – one day; days begin at 00:00:00 UTC. * *WEEK* – one week; weeks begin Sundays at 00:00:00 UTC. * *MONTH* – one month; months begin on the first day of month at 00:00:00 UTC. * *LIFETIME* – forever; time period never expires. * *TRANSACTION* – a single transaction. // (2023-05-03): This statement was validated by Processing, as part of a customer inquiry. *NOTE:* If set to `DAY`, `WEEK`, or `MONTH`, the velocity control takes effect retroactively from the beginning of the specified period. The amount and usage data already collected within the first period is counted toward the limits. If set to `LIFETIME`, the velocity control only applies to transactions on or after the date and time that the velocity control was created. `LIFETIME` velocity controls are not retroactively applied to historical transactions. // (2023-05-03): Commenting this note out, as it is untrue in testing as reported by customers and confirmed by transaction engine team //*NOTE:* Editing any of the following fields on a velocity control resets its usage and amount count to 0: //* `merchant_scope.mcc` //* `merchant_scope.mid` //* `merchant_scope.mcc_group` //* `association.user_token` //* `association.card_product_token` enum: - DAY - WEEK - MONTH - LIFETIME - TRANSACTION type: string required: - amount_limit - currency_code - velocity_window type: object velocity_control_response: properties: active: description: Indicates whether the velocity control is active. type: boolean amount_limit: description: |- Maximum monetary sum that can be cleared within the time period defined by the `velocity_window` field. Refunds and reversals cannot exceed this limit. exclusiveMinimum: false minimum: 0 type: number approvals_only: description: |- If set to `true`, only approved transactions are subject to control. If set to `false`, only declined transactions are subject to control. type: boolean association: $ref: '#/components/schemas/spend_control_association' currency_code: description: Three-character ISO 4217 currency code. type: string include_cashback: description: If set to `true`, the cashback components of point-of-sale transactions are subject to control. type: boolean include_credits: description: If set to `true`, original credit transactions (OCT) are subject to control. type: boolean include_purchases: description: |- If set to `true`, the following transactions are subject to control: * *Account funding:* All account funding transactions * *Cashback:* Only the purchase component of cashback transactions * *Purchase transactions:* All authorizations, PIN debit transactions, and incremental transactions * *Quasi-cash:* All quasi-cash transactions * *Refunds:* All refund transactions (see <> for more information) * *Reversals:* All reversal transactions type: boolean include_transfers: description: |- If set to `true`, account-to-account transfers are subject to control. Account-to-account transfers are not currently supported. type: boolean include_withdrawals: description: If set to `true`, ATM withdrawals are subject to control. type: boolean merchant_scope: $ref: '#/components/schemas/merchant_scope' money_in_transaction: $ref: '#/components/schemas/money_in_transaction' name: description: |- Description of how the velocity control restricts spending. For example, "Max spend of $500 per day" or "Max spend of $5000 per month for non-exempt employees". maxLength: 255 minLength: 0 type: string token: description: Unique identifier of the velocity control. maxLength: 36 minLength: 1 type: string usage_limit: description: Maximum number of times a card can be used within the time period defined by the `velocity_window` field. format: int32 minimum: -1 type: integer velocity_window: description: |- Defines the time period to which the `amount_limit` and `usage_limit` fields apply: * *DAY* – one day; days begin at 00:00:00 UTC. * *WEEK* – one week; weeks begin Sundays at 00:00:00 UTC. * *MONTH* – one month; months begin on the first day of month at 00:00:00 UTC. * *LIFETIME* – forever; time period never expires. * *TRANSACTION* – a single transaction. enum: - DAY - WEEK - MONTH - LIFETIME - TRANSACTION type: string required: - amount_limit - currency_code - velocity_window type: object velocity_control_update_request: properties: active: description: Indicates whether the velocity control is active. type: boolean amount_limit: description: |- Maximum monetary sum that can be cleared within the time period defined by the `velocity_window` field. Refunds and reversals cannot exceed this limit. exclusiveMinimum: false minimum: 0 type: number approvals_only: description: |- If set to `true`, only approved transactions are subject to control. If set to `false`, only declined transactions are subject to control. type: boolean association: $ref: '#/components/schemas/spend_control_association' currency_code: description: Three-character ISO 4217 currency code. type: string include_cashback: description: If set to `true`, the cashback components of point-of-sale transactions are subject to control. type: boolean include_credits: description: |- If set to `true`, original credit transactions are subject to control. Your request can contain either a `money_in_transaction` object or the `include_credits` field, not both. type: boolean include_purchases: description: |- If set to `true`, the following transactions are subject to control: * *Account funding:* All account funding transactions * *Cashback:* Only the purchase component of cashback transactions * *Purchase transactions:* All authorizations, PIN debit transactions, and incremental transactions * *Quasi-cash:* All quasi-cash transactions * *Refunds:* All refund transactions (see <> for more information) * *Reversals:* All reversal transactions type: boolean include_transfers: description: |- If set to `true`, account-to-account transfers are subject to control. Account-to-account transfers are not currently supported. type: boolean include_withdrawals: description: If set to `true`, ATM withdrawals are subject to control. type: boolean merchant_scope: $ref: '#/components/schemas/merchant_scope' money_in_transaction: $ref: '#/components/schemas/money_in_transaction' name: description: |- Description of how the velocity control restricts spending. For example, "Max spend of $500 per day" or "Max spend of $5000 per month for non-exempt employees". Ensure that the description you provide here adequately captures the kind of restriction exerted by this velocity control, because the Marqeta platform will send this information to you in a webhook in the event that the transaction authorization attempt is declined by the velocity control. *NOTE:* This field is very important. If your program has multiple velocity controls in place, it is not always clear which one prevented the transaction from being approved. Adding specific details to this field gives you more contextual information when debugging or monitoring declined authorization attempts. maxLength: 255 minLength: 0 type: string token: description: Unique identifier of the velocity control resource. maxLength: 36 minLength: 1 type: string usage_limit: description: |- Maximum number of times a card can be used within the time period defined by the `velocity_window` field. If `velocity_window` is set to `TRANSACTION`, do not include a `usage_limit` in your request. format: int32 minimum: -1 type: integer velocity_window: description: |- Defines the time period to which the `amount_limit` and `usage_limit` fields apply: * *DAY* – one day; days begin at 00:00:00 UTC. * *WEEK* – one week; weeks begin Sundays at 00:00:00 UTC. * *MONTH* – one month; months begin on the first day of month at 00:00:00 UTC. * *LIFETIME* – forever; time period never expires. * *TRANSACTION* – a single transaction. // (2023-05-03): This statement was validated by Processing, as part of a customer inquiry. *NOTE:* If set to `DAY`, `WEEK`, or `MONTH`, the velocity control takes effect retroactively from the beginning of the specified period. The amount and usage data already collected within the first period is counted toward the limits. If set to `LIFETIME`, the velocity control only applies to transactions on or after the date and time that the velocity control was created. `LIFETIME` velocity controls are not retroactively applied to historical transactions. // (2023-05-03): Commenting this note out, as it is untrue in testing as reported by customers and confirmed by transaction engine team //*NOTE:* Editing any of the following fields on a velocity control resets its usage and amount count to 0: //* `merchant_scope.mcc` //* `merchant_scope.mid` //* `merchant_scope.mcc_group` //* `association.user_token` //* `association.card_product_token` enum: - DAY - WEEK - MONTH - QUARTER - YEAR - LIFETIME - TRANSACTION type: string required: - token type: object visa_click_to_pay_billing_address: description: Billing address for Visa Click to Pay. properties: address1: description: First line of the billing address. maxLength: 64 minLength: 1 type: string address2: description: Optional second line of the billing address. maxLength: 64 minLength: 1 type: string city: description: City of the billing address. maxLength: 32 minLength: 1 type: string country: description: Country of the billing address. maxLength: 3 minLength: 3 type: string postalCode: description: Postal code of the billing address. maxLength: 9 minLength: 1 type: string state: description: State of the billing address. maxLength: 3 minLength: 1 type: string required: - country type: object visa_click_to_pay_card: description: Card information for Visa Click to Pay. properties: billingAddress: $ref: '#/components/schemas/visa_click_to_pay_billing_address' cardToken: description: Unique identifier of the card. maxLength: 36 minLength: 1 type: string nameOnCard: description: Name of the cardholder that appears on the card. maxLength: 120 minLength: 1 type: string required: - billingAddress - cardToken - nameOnCard type: object visa_click_to_pay_enroll_cards_request: description: Request to enroll a card for an existing cardholder. properties: card: $ref: '#/components/schemas/visa_click_to_pay_card' userToken: description: Unique identifier of the cardholder. maxLength: 36 minLength: 1 type: string required: - card - userToken type: object visa_click_to_pay_enroll_request: description: Request to enroll a new cardholder and card. properties: card: $ref: '#/components/schemas/visa_click_to_pay_card' user: $ref: '#/components/schemas/visa_click_to_pay_user' required: - card - user type: object visa_click_to_pay_get_user_data_response: description: Response containing the external consumer ID of a Visa Click to Pay cardholder. properties: externalConsumerId: description: External consumer ID type: string required: - externalConsumerId type: object visa_click_to_pay_intent: description: Intent of the Visa Click to Pay operation. properties: type: description: Type of the operation. enum: - PRODUCT_CODE type: string value: description: Value of the operation. enum: - CLICK_TO_PAY type: string required: - type - value type: object visa_click_to_pay_response: description: Response containing the request trace ID of a Visa Click to Pay request. properties: requestTraceId: description: Unique identifier of the Visa Click to Pay request. maxLength: 36 minLength: 1 type: string required: - requestTraceId type: object visa_click_to_pay_status_details: properties: errorDetails: description: Details of error occurred while executing the operation. items: properties: field: description: Field that caused the error in the operation. maxLength: 100 minLength: 1 type: string message: description: Message describing the error. maxLength: 256 minLength: 1 type: string reason: description: Description of why the error has occurred. maxLength: 100 minLength: 1 type: string required: - field - message - reason type: object type: array intent: $ref: '#/components/schemas/visa_click_to_pay_intent' status: description: Status of the operation. enum: - SUCCESS - FAILED type: string required: - errorDetails - intent - status type: object visa_click_to_pay_status_response: description: Response containing the status of a Visa Click to Pay request. properties: consumerInformation: description: Consumer information. properties: externalConsumerID: description: External consumer ID. maxLength: 100 minLength: 1 type: string externalConsumerIDOwnerBID: description: Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. maxLength: 8 minLength: 1 type: string type: object details: description: Additional status details of the operation. items: $ref: '#/components/schemas/visa_click_to_pay_status_details' type: array status: description: Status of the operation. enum: - IN_PROGRESS - COMPLETED type: string required: - status type: object visa_click_to_pay_update_card_request: description: Request to update a card for an existing cardholder. properties: card: $ref: '#/components/schemas/visa_click_to_pay_card' userToken: description: Unique identifier of the cardholder. maxLength: 36 minLength: 1 type: string required: - card - userToken type: object visa_click_to_pay_update_cardholder_request: description: Request to update cardholder information. properties: user: $ref: '#/components/schemas/visa_click_to_pay_user' required: - user type: object visa_click_to_pay_user: description: User's email address, mobile phone number without country code, first name, last name, locale, and country. properties: country: description: ISO 3166-1 alpha-3 country code. maxLength: 3 minLength: 3 type: string email: description: User's email address. type: string firstName: description: User's first name. maxLength: 35 minLength: 1 type: string lastName: description: User's last name. maxLength: 35 minLength: 1 type: string locale: description: |- The user-provided language choice. The ISO 639-2 language code is a two-letter country code that represents a language. The ISO maintains the link:https://id.loc.gov/vocabulary/iso639-2.html[ISO 639-2 language codes, window="_blank"]. maxLength: 5 minLength: 2 type: string phone: description: User's mobile phone number without country code. maxLength: 16 minLength: 1 type: string userToken: description: Unique identifier of the cardholder. maxLength: 36 minLength: 1 type: string required: - country - email - firstName - lastName - locale - phone - userToken type: object wallet_provider_card_on_file: properties: address_verification: $ref: '#/components/schemas/digital_wallet_token_address_verification' enabled: default: false description: Specifies if the card on file is enabled. type: boolean type: object wallet_provider_profile: description: Contains information held and provided by the digital wallet provider. properties: account: $ref: '#/components/schemas/account' device_score: description: Score from the device. type: string pan_source: description: Source from which the digital wallet provider obtained the card primary account number (PAN). type: string reason_code: description: |- Reason for the wallet provider's provisioning decision. * *01* – Cardholder's wallet account is too new relative to launch. * *02* – Cardholder's wallet account is too new relative to provisioning request. * *03* – Cardholder's wallet account/card pair is newer than date threshold. * *04* – Changes made to account data within the account threshold. * *05* – Suspicious transactions linked to this account. * *06* – Account has not had activity in the last year. * *07* – Suspended cards in the secure element. * *08* – Device was put in lost mode in the last seven days for longer than the duration threshold. * *09* – The number of provisioning attempts on this device in 24 hours exceeds threshold. * *0A* – There have been more than the threshold number of different cards attempted at provisioning to this phone in 24 hours. * *0B* – The card provisioning attempt contains a distinct name in excess of the threshold. * *0C* – The device score is less than 3. * *0D* – The account score is less than 4. * *0E* – Device provisioning location outside of the cardholder's wallet account home country. * *0G* – Suspect fraud. type: string recommendation_reasons: description: Array of recommendation reasons from the digital wallet provider. items: type: string type: array risk_assessment: $ref: '#/components/schemas/risk_assessment' type: object web_push_provisioning: properties: wpp_apple_card_template_id: description: Identifier that Apple uses to identify the program to process the request for. type: string wpp_apple_partner_id: description: Identifier that Apple uses to identify the program to provide the correct card art for. type: string wpp_google_piaid: description: Identifier that Google uses to identify the program to process the request for and to provide the correct card art for. type: string type: object web_push_provisioning_apple_pay_JWS_header: description: Contains header data for the JWS object. properties: kid: description: Unique identifier of the JSON Web Signature (JWS) public key of the key pair used to generate the signature. example: 8dc7aed4-29e3-41e4-9cdb-673a05e6615c type: string required: - kid type: object web_push_provisioning_apple_pay_JWS_model: description: Object containing JSON Web Signature (JWS) data. properties: header: $ref: '#/components/schemas/web_push_provisioning_apple_pay_JWS_header' payload: description: JSON Web Signature (JWS) message payload. type: string protected: description: Contains header parameters that are integrity-protected by the JSON Web Signature (JWS). type: string signature: description: The JSON Web Signature (JWS). example: 5lD1znG2DD2DytqGUcSDOwJQMYbCGDCCCiXxyhpC1zOWTH1Y6jUJFAupl0jEud9nUvw3mmpuSt6zcAE1r4yb0w type: string required: - header - payload - protected - signature type: object web_push_provisioning_apple_pay_JWT_response: properties: jws: $ref: '#/components/schemas/web_push_provisioning_apple_pay_JWS_model' state: description: |- Unique state associated with the digital wallet token. The Marqeta platform returns a universally unique identifier (UUID) in this field. example: e2675f06-7e4d-11ec-90d6-0242ac120003 type: string required: - jws - state type: object webhook: properties: endpoint: description: Valid URL maxLength: 512 minLength: 1 type: string password: description: Authentication password type: string secret: description: Authentication secret type: string username: description: Authentication username type: string required: - endpoint - password - username type: object xml: name: webhook webhook_base_model: properties: active: default: true description: Indicates whether the webhook is active. type: boolean config: $ref: '#/components/schemas/webhook_config_request_model' events: description: |- Specifies the types of events for which notifications are sent. The wildcard character `\*` indicates that you receive all webhook notifications, or all notifications of a specified category. For example, `*` indicates that you receive all webhook notifications; `transaction.*` indicates that you receive all `transaction` webhook notifications. *NOTE:* You can only use the wildcard character with the _base_ type events, not subcategories. For example, you cannot subscribe to `cardtransition.fulfillment.\*` events, but you can subscribe to `cardtransition.*`. items: type: string type: array name: description: Descriptive name of the webhook. maxLength: 64 minLength: 1 type: string required: - config - events - name type: object webhook_config_request_model: description: Contains the configuration information for the webhook. properties: basic_auth_password: description: Password for accessing your webhook endpoint. maxLength: 50 minLength: 20 type: string basic_auth_username: description: Username for accessing your webhook endpoint. maxLength: 50 minLength: 1 type: string custom_header: additionalProperties: type: string description: Custom headers to be passed along with the request. type: object secret: description: |- Randomly chosen string used for implementing HMAC-SHA1 or HMAC-SHA256 depending on value in `signature_algorithm`. A signature provides an added layer of security by authenticating the message and validating message integrity. Using this functionality requires that your webhook endpoint verify the message signature. For information about implementing this functionality, see <>. maxLength: 50 minLength: 20 type: string signature_algorithm: description: |- The algorithm used for signature verification. A signature provides an added layer of security by authenticating the message and validating message integrity. Using this functionality requires that your webhook endpoint verify the message signature. For information about implementing this functionality, see <>. maxLength: 20 minLength: 1 type: string url: description: URL of your webhook endpoint. maxLength: 255 minLength: 1 type: string use_mtls: default: false description: |- Set to `true` to use use mutual transport layer security (mTLS) authentication for the webhook. mTLS authentication is in the beta testing phase, and is not yet generally available. Contact your Marqeta representative for more information about using mTLS authentication. type: boolean required: - basic_auth_password - basic_auth_username - url type: object webhook_config_response_model: description: Contains the configuration information for the webhook. properties: basic_auth_password: description: Password for accessing your webhook endpoint. maxLength: 12 minLength: 12 type: string basic_auth_username: description: Username for accessing your webhook endpoint. maxLength: 12 minLength: 12 type: string custom_header: additionalProperties: type: string description: Custom headers to be passed along with the request. type: object secret: description: |- Randomly chosen string used for implementing HMAC-SHA1 or HMAC-SHA256 depending on value in signature_algorithm. A signature provides an added layer of security by authenticating the message and validating message integrity. Using this functionality requires that your webhook endpoint verify the message signature. For information about implementing this functionality, see <>. maxLength: 12 minLength: 12 type: string signature_algorithm: description: |- The algorithm used for signature verification. A signature provides an added layer of security by authenticating the message and validating message integrity. Using this functionality requires that your webhook endpoint verify the message signature. For information about implementing this functionality, see <>. maxLength: 20 minLength: 1 type: string url: description: URL of your webhook endpoint. maxLength: 255 minLength: 1 type: string use_mtls: default: false description: |- Set to `true` to use use mutual transport layer security (mTLS) authentication for the webhook. mTLS authentication is in the beta testing phase, and is not yet generally available. Contact your Marqeta representative for more information about using mTLS authentication. type: boolean required: - basic_auth_password - basic_auth_username - url type: object webhook_ping_model: properties: pings: description: Array of ping requests to your webhook endpoint. items: $ref: '#/components/schemas/echo_ping_request' type: array required: - pings type: object webhook_request_model: properties: active: default: true description: Indicates whether the webhook is active. type: boolean config: $ref: '#/components/schemas/webhook_config_request_model' events: description: |- Specifies the types of events for which notifications are sent. The wildcard character `\*` indicates that you receive all webhook notifications, or all notifications of a specified category. For example, `*` indicates that you receive all webhook notifications; `transaction.*` indicates that you receive all `transaction` webhook notifications. *NOTE:* You can only use the wildcard character with the _base_ type events, not subcategories. For example, you cannot subscribe to `cardtransition.fulfillment.\*` events, but you can subscribe to `cardtransition.*`. items: type: string type: array name: description: Descriptive name of the webhook. maxLength: 64 minLength: 1 type: string token: description: Unique identifier of the webhook. maxLength: 36 minLength: 1 type: string required: - config - events - name type: object webhook_response_model: properties: active: default: true description: |- Indicates whether the webhook is active. This field is returned if you included it in your webhook. type: boolean config: $ref: '#/components/schemas/webhook_config_response_model' created_time: description: Date and time when the webhook event was created, in UTC. format: date-time type: string events: description: |- Specifies the types of events for which notifications are sent. The wildcard character `\*` indicates that you receive all webhook notifications, or all notifications of a specified category. For example, `*` indicates that you receive all webhook notifications; `transaction.*` indicates that you receive all `transaction` webhook notifications. *NOTE:* You can only use the wildcard character with the _base_ type events, not subcategories. For example, you cannot subscribe to `cardtransition.fulfillment.\*` events, but you can subscribe to `cardtransition.*`. items: type: string type: array last_modified_time: description: Date and time when the associated object was last modified, in UTC. format: date-time type: string name: description: Descriptive name of the webhook. maxLength: 64 minLength: 1 type: string token: description: Unique identifier of the webhook. maxLength: 36 minLength: 1 type: string required: - config - events - name type: object withdrawal_request_model: properties: account_type: enum: - checking - savings - credit type: string amount: type: number card_acceptor: $ref: '#/components/schemas/card_acceptor_model' card_token: maxLength: 36 minLength: 1 type: string mid: maxLength: 50 minLength: 1 type: string pin: maxLength: 15 minLength: 1 type: string webhook: $ref: '#/components/schemas/webhook' required: - amount - card_token - mid type: object xpay_push_tokenize_request_data: description: Contains details about a card tokenization push request. properties: card_type: description: Specifies the type of card. type: string display_name: description: |- Name of the card as displayed in the digital wallet, typically showing the card brand and last four digits of the primary account number (PAN). `Visa 5678`, for example. type: string extra_provision_payload: description: Encrypted card or cardholder details. type: string last_digits: description: Last four digits of the primary account number of the physical or virtual card. type: string network: description: Specifies the card network of the physical or virtual card. type: string token_service_provider: description: Specifies the network that provides the digital wallet token service. type: string type: object securitySchemes: mqAppAndAccessToken: scheme: basic type: http