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.10 servers: - url: /v3 security: - mqAppAndAccessToken: [ ] tags: - description: 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: |- 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. [NOTE] This feature is currently in beta and subject to change. It also requires additional activation steps. To learn more about the beta program for this feature and about activating it for your program, contact your Marqeta representative. 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 (Beta) - 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: |- 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: 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: |- 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: 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: 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 sync by dequeuer - name: digital wallet token transitions - name: digital wallet tokens - name: direct deposit accounts - name: direct deposits - name: fee transfers - name: fees - name: file processing - name: 'Find Original: Operations resolve Original Transactions for Auth service' - name: funding sources - name: gateways - name: Generic money transfers - name: GPA fund transfers - name: gpa orders - name: health checks - name: internal auth control check - name: internal cards - name: Internal Commando Mode APIs - name: internal config operations - name: internal cryptokeys - name: internal data rehydration - name: internal dwt - name: internal health - name: internal kyc - name: internal mcc groups - name: internal post jcard transactions - name: internal program configs - name: internal result codes - name: internal spend controls - name: internal system information - name: internal transactions - name: internal user validation - 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: program - name: program configs - name: program reserve - name: program transfers - name: push to card - name: real time fee groups - name: simulate - name: token service gateway - name: transaction caches - name: transactions - name: 'transactions : Dispute transactions' - name: user transitions - name: users - name: velocity controls - name: web push provisioning - name: webhooks - description: |- A `fees` resource represents a monetary assessment against a user's general purpose account (GPA). Assessing a fee transfers funds from the user's GPA account to your program's fee account. By default, every user 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, leverage the fees array in `/gpaorders`. [NOTE] If your program uses Gateway JIT Funding, you cannot assess fees. name: Fees - description: |- A fee transfer moves funds from the GPA of an account holder to your program's fee account. The transfer 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 Transfers - description: |- 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: |- 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: |- 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: |- 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: |- 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: |- 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: |- A peer transfer moves funds from the general purpose account (GPA) of an account holder (a user or business) to another account belonging to the same account holder. Both the sender and recipient accounts must be active. name: Peer Transfers - description: Use the `/pins` endpoint to create, update, or reveal a personal identification number (PIN) for a card. name: PINs - description: Use the Program Reserve API to credit or debit your program reserve account (sometimes referred to as a _program funding account_), and to return program reserve balances and transactions. name: Program Reserve - description: |- 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. 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: |- 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: |- 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: |- 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: 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: |- 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). name: Velocity Controls - description: |- 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 - description: |- [NOTE] This feature is currently in limited-availability beta and subject to change. To learn more about the beta program for this feature, contact your Marqeta representative. Marqeta's credit platform's credit applications feature enables you to create and manage credit account applications and retrieve disclosures that you can show to an applicant during the application process. To receive webhook notifications when application transition events occur, see <> in Event Types. name: Applications - description: |- 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: |- 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 <>. name: Account Rewards - description: |- 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: |- 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: |- 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 About Credit Account Journal Entries guide. name: Balance Refunds - description: |- [NOTE] This feature is currently in limited-availability beta and subject to change. To learn more about the beta program for this feature, contact your Marqeta Customer Service representative. 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]. For more on bundles in the dashboard, see <>.   + The following endpoints are displayed for reference purposes only. ==== name: Bundles (Beta) - description: |- 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: |- Use the credit 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 Disputes - description: |- [IMPORTANT] This feature is being 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]. For more, see <>.   + The following endpoints are displayed for reference purposes only. ==== name: Credit Products - description: |- 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: |- 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: |- [IMPORTANT] ==== This feature is being 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: |- [NOTE] This feature is currently in limited-availability beta and subject to change. To learn more about the beta program for this feature, contact your Marqeta Customer Service representative. 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]. For more on policies in the dashboard, see <>.   + The following endpoints are displayed for reference purposes only. ==== name: Policies (Beta) - description: |- 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: |- 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: |- 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: |- 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: |- Use the `/credit/rewardprograms/{token}` endpoint to manage reward programs and track reward accruals on a credit account. The configurations for a reward program are defined in the <> on the account's associated bundle. To receive webhook notifications when reward entry events occur, see <> in Event Types. name: Reward Programs (Beta) - description: |- Use the `/credit/rewardprograms/{token}/redemptions` endpoint to the manage reward redemptions on a credit account. A reward program's rules configuration specifies how rewards are redeemed and is defined in the <> on the account's associated bundle. To receive webhook notifications when reward redemption transition events occur, see <> in Event Types. name: Reward Redemptions (Beta) paths: /acceptedcountries: get: description: Retrieve a list of `acceptedcountries` objects. operationId: getAcceptedcountries parameters: - description: Number of accepted countries objects 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: Name of the accepted countries object. explode: true in: query name: name required: false schema: type: string style: form - description: Specifies if the accepted countries object is an allow list. explode: true in: query name: whitelist required: false schema: type: boolean style: form - description: Specifies the type of search you want to perform. 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: schema: $ref: '#/components/schemas/AcceptedCountriesListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server failure summary: List accepted countries objects tags: - Accepted Countries /acceptedcountries/{token}: get: description: |- Retrieve a specific `acceptedcountries` object. Send a `GET` request to the `/acceptedcountries` endpoint to retrieve existing `acceptedcountries` object tokens. operationId: getAcceptedcountriesToken parameters: - description: Unique identifier of the accepted countries object. 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: schema: $ref: '#/components/schemas/accepted_countries_model' description: Success '400': content: { } description: Bad request '404': content: { } description: Accepted countries object not found '500': content: { } description: Server failure summary: Retrieve an accepted countries object tags: - Accepted Countries /accountholdergroups: get: description: Use this endpoint to return an array of all account holder groups. operationId: getAccountholdergroups parameters: - description: Number of resources to retrieve. explode: true in: query name: count required: false schema: default: 10 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: -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 1 data: - config: is_reloadable: true kyc_required: ALWAYS pre_kyc_controls: balance_max: 500 cash_access_enabled: false enable_non_program_loads: false international_enabled: false is_reloadable_pre_kyc: false name: Account Holder Group 01 token: account_holder_group_01 end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/AccountHolderGroupListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List account holder groups tags: - Account Holder Groups post: description: Use this endpoint to create an account holder group. operationId: postAccountholdergroups requestBody: content: application/json: example: name: Account Holder Group 01 token: account_holder_group_01 schema: $ref: '#/components/schemas/account_holder_group_request' description: Account holder group object required: true responses: '201': content: application/json: example: config: is_reloadable: true kyc_required: ALWAYS pre_kyc_controls: balance_max: 1000 cash_access_enabled: false enable_non_program_loads: false international_enabled: false is_reloadable_pre_kyc: false name: Account Holder Group 01 token: account_holder_group_01 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: Create account holder group tags: - Account Holder Groups /accountholdergroups/{token}: get: description: Use this endpoint to retrieve a specific account holder group. operationId: getAccountholdergroupsToken parameters: - description: Unique identifier of the account holder group. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: config: is_reloadable: true kyc_required: ALWAYS pre_kyc_controls: balance_max: 1000 cash_access_enabled: false enable_non_program_loads: false international_enabled: false is_reloadable_pre_kyc: false name: Account Holder Group 01 token: account_holder_group_01 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: Retrieve account holder group tags: - Account Holder Groups put: description: |- Use this endpoint to update a specific account holder group. Only values of parameters in the request are modified; all others are left unchanged. To update a specific account holder group, send a `PUT` request to the `/accountholdergroups/{token}` endpoint. Use the `token` path parameter to specify the account holder group to update. Include the account holder group details to update in link:http://json.org[JSON, window="_blank"] format in the body of the request. [NOTE] While you can update account holder groups that you create, the default group is restricted and requires special permissions to update. operationId: putAccountholdergroupsToken parameters: - description: Unique identifier of the account holder group. explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: example: config: pre_kyc_controls: balance_max: 500 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: Update account holder group tags: - Account Holder Groups /authcontrols: get: description: |- List all authorization controls associated with a specific user or card product, or list all authorization controls defined in your program. Include either a `user` or a `card_product` query parameter to indicate the user or card product whose associated authorization controls you want to retrieve (do not include both). To list all authorization controls for your program, omit the `user` and `card_product` query parameters from your request. operationId: getAuthcontrols parameters: - description: |- Unique identifier of the card product whose associated authorization controls you want to retrieve. Enter the string "null" to list authorization controls that are not associated with a card product. explode: true in: query name: card_product required: false schema: type: string style: form - description: |- Unique identifier of the user whose associated authorization controls you want to retrieve. Enter the string "null" to list authorization controls that are not associated with a user. explode: true in: query name: user required: false schema: type: string style: form - description: The 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: -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 1 data: - active: true association: user_token: my_user_01 merchant_scope: mcc: '5111' name: My Auth Control token: my_authcontrol end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/AuthControlListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List authorization controls tags: - Authorization Controls post: description: |- Limit where a user can make transactions to a single merchant or group of merchants. If multiple authorization controls apply to the same user, the limits of all controls are combined. operationId: postAuthcontrols requestBody: content: application/json: example: association: user_token: my_user_01 merchant_scope: mid: '98765' name: My Auth Control token: my_authcontrol schema: $ref: '#/components/schemas/auth_control_request' description: Auth control object required: true responses: '201': content: application/json: example: active: true association: user_token: my_user_01 merchant_scope: mid: '98765' name: My Auth Control token: my_authcontrol 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: Create authorization control tags: - Authorization Controls /authcontrols/exemptmids: get: description: Retrieve a list of all merchant (MID) exemptions. operationId: getAuthcontrolsExemptmids parameters: - description: |- Unique identifier of the card product whose associated MID exemptions you want to retrieve. Enter the string "null" to list MID exemptions that are not associated with a card product. explode: true in: query name: card_product required: false schema: type: string style: form - description: |- Unique identifier of the user whose associated MID exemptions you want to retrieve. Enter the string "null" to list MID exemptions that are not associated with a user. explode: true in: query name: user required: false schema: type: string style: form - description: The number of 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 created_time: 2022-07-03T13:22:07Z last_modified_time: 2022-07-03T17:22:07Z mid: '984226812886' name: My Exempt Auth Control token: my_exempt_authcontrol - active: true association: card_product_token: my_card_product created_time: 2022-07-03T17:22:07Z last_modified_time: 2022-07-03T17:22:07Z mid: '1234567891' name: My Exempt Auth Control 2 token: my_exempt_authcontrol_2 end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/AuthControlExemptMidsListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List merchant identifier (MID) exemptions tags: - Authorization Controls post: description: |- Exempt an individual merchant from authorization controls by merchant identifier (MID). Transactions originating from this MID ignore any otherwise applicable authorization controls. [NOTE] You can create MID exemptions in your user sandbox. However, you must work with your Marqeta representative to create MID exemptions in a production environment. operationId: postAuthcontrolsExemptmids requestBody: content: application/json: example: association: card_product_token: my_card_product mid: '12345678901' name: my_exempt_mid token: my_exempt_token schema: $ref: '#/components/schemas/auth_control_exempt_mids_request' description: Auth control exempt MID object required: true responses: '201': content: application/json: example: active: true association: card_product_token: my_card_product created_time: 2022-06-19T13:22:07Z last_modified_time: 2022-06-19T13:22:07Z mid: '12345678901' name: my_exempt_mid token: my_exempt_token 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: Create a merchant identifier (MID) exemption tags: - Authorization Controls /authcontrols/exemptmids/{token}: get: description: Retrieve a merchant (MID) exemption. operationId: getAuthcontrolsExemptmidsToken parameters: - description: Unique identifier of the authorization control resource. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: active: true association: card_product_token: my_card_product created_time: 2022-06-19T13:22:07Z last_modified_time: 2022-06-19T13:22:07Z mid: '12345678901' name: my_exempt_mid token: my_exempt_token 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: Retrieve a merchant identifier (MID) exemption tags: - Authorization Controls put: description: Update a merchant identifier exemption. operationId: putAuthcontrolsExemptmidsToken parameters: - description: Unique identifier of the authorization control resource. explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: example: active: false 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: Update a merchant identifier (MID) exemption tags: - Authorization Controls /authcontrols/{token}: get: description: Retrieve a specific authorization control. operationId: getAuthcontrolsToken parameters: - description: |- Existing authorization control token. Send a `GET` request to `/authcontrols` to retrieve authorization control tokens. 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 association: user_token: my_user_01 merchant_scope: mid: '98765' name: My Auth Control token: my_authcontrol schema: $ref: '#/components/schemas/auth_control_response' description: Success '400': content: { } description: Bad request '404': content: { } description: Authorization control not found '500': content: { } description: Server error summary: Retrieve authorization control tags: - Authorization Controls put: description: Update a specific authorization control. operationId: putAuthcontrolsToken parameters: - description: |- Existing authorization control token. Send a `GET` request to `/authcontrols` to retrieve authorization control tokens. explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: example: merchant_scope: mcc: '5111' token: my_authcontrol schema: $ref: '#/components/schemas/auth_control_update_request' description: Auth control object required: true responses: '200': content: application/json: example: active: true association: user_token: my_user_01 merchant_scope: mcc: '5111' name: My Auth Control token: my_authcontrol schema: $ref: '#/components/schemas/auth_control_response' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Update authorization control tags: - Authorization Controls /autoreloads: get: description: |- Use this endpoint to list auto reloads configured for the program or for a specific card product, user, or business. This endpoint supports <> and <>. operationId: getAutoreloads parameters: - description: Unique identifier of the card product whose auto reloads you want to retrieve. explode: true in: query name: card_product required: false schema: type: string style: form - description: Unique identifier of the user whose auto reloads you want to retrieve. explode: true in: query name: user_token required: false schema: type: string style: form - description: Unique identifier of the business whose auto reloads you want to retrieve. explode: true in: query name: business_token required: false schema: type: string style: form - description: Number of resources to retrieve. explode: true in: query name: count required: false schema: default: 10 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: false association: user_token: my_user_01 created_time: 2022-11-10T22:15:20Z currency_code: USD funding_source_token: my_program_funding_source_01 last_modified_time: 2022-11-10T22:21:59Z order_scope: gpa: reload_amount: 200.0 trigger_amount: 100.0 token: my_user_01_autoreload_01 end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/AutoReloadListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List auto reloads tags: - Auto Reload post: description: Use this endpoint to create an auto reload. operationId: postAutoreloads requestBody: content: application/json: example: active: false association: user_token: my_user_01 currency_code: USD funding_source_token: my_program_funding_source_01 order_scope: gpa: reload_amount: 200.0 trigger_amount: 100.0 token: my_user_01_autoreload_01 schema: $ref: '#/components/schemas/auto_reload_model' description: Auto reload object required: true responses: '201': content: application/json: example: active: false association: user_token: my_user_01 created_time: 2022-11-10T22:15:20Z currency_code: USD funding_source_token: my_program_funding_source_01 last_modified_time: 2022-11-10T22:15:20Z order_scope: gpa: reload_amount: 200.0 trigger_amount: 100.0 token: my_user_01_autoreload_01 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: Create auto reload tags: - Auto Reload /autoreloads/{token}: get: description: Use this endpoint to retrieve a specific auto reload object. operationId: getAutoreloadsToken parameters: - description: Unique identifier of the auto reload. 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: false association: user_token: my_user_01 created_time: 2022-11-10T22:15:20Z currency_code: USD funding_source_token: my_program_funding_source_01 last_modified_time: 2022-11-10T22:21:59Z order_scope: gpa: reload_amount: 200.0 trigger_amount: 100.0 token: my_user_01_autoreload_01 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: Retrieve auto reload tags: - Auto Reload put: description: |- Use this endpoint to update an auto reload. Only values of parameters in the request are modified; all others are left unchanged. operationId: putAutoreloadsToken parameters: - description: Unique identifier of the auto reload. explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: example: order_scope: gpa: reload_amount: 500.0 trigger_amount: 250.0 schema: $ref: '#/components/schemas/auto_reload_update_model' description: Auto reload object required: true responses: '200': content: application/json: example: active: false association: user_token: my_user_01 created_time: 2022-11-10T22:15:20Z currency_code: USD funding_source_token: my_program_funding_source_01 last_modified_time: 2022-11-10T22:25:00Z order_scope: gpa: reload_amount: 500.0 trigger_amount: 250.0 token: my_user_01_autoreload_01 schema: $ref: '#/components/schemas/auto_reload_response_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Update auto reload tags: - Auto Reload /balances/{token}: get: description: |- Use this endpoint to return general purpose account (GPA) balances for a user or a business. The response object includes a link to balances of related user GPAs. operationId: getBalancesToken parameters: - description: Unique identifier of the user or business for which you want to return GPA balances. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: gpa: available_balance: 990.0 balances: USD: available_balance: 990.0 currency_code: USD ledger_balance: 1000.0 pending_credits: 0.0 currency_code: USD ledger_balance: 1000.0 pending_credits: 0.0 links: href: /v3/balances/my_user_01/gpa method: GET rel: gpa schema: $ref: '#/components/schemas/cardholder_balances' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Retrieve GPA balances tags: - Balances /banktransfers/ach: get: description: Retrieve a list of all ACH transfers. operationId: getBanktransfersAch 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: Unique identifier of the user resource. explode: true in: query name: user_token required: false schema: type: string style: form - description: Unique identifier of the business resource. explode: true in: query name: business_token required: false schema: type: string style: form - description: Unique identifier of the funding source. explode: true in: query name: funding_source_token required: false schema: type: string style: form - description: Comma-delimited list of bank transfer statuses. explode: true in: query name: statuses 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: |- Returns the full funding source object when `fundingsource` is passed. Otherwise, returns the funding source token. explode: true in: query name: expand required: false schema: type: string style: form - description: Funding source type to filter. explode: true in: query name: funding_source_type required: false schema: type: string style: form responses: '200': content: application/json: example: count: 2 created_time: 2023-03-22T18:01:00Z data: - amount: 10.49 created_time: 2023-03-20T18:32:32Z currency_code: USD funding_source_token: d331b4b2-cef5-49a3-9c41-75d8f4e15cfz last_modified_time: 2023-03-20T18:33:32Z memo: Bank transfer standard_entry_class_code: WEB statement_descriptor: ACHTRNSFR status: PENDING token: cf3b49d8-bd68-4fb1-8da5-c170cff3d788 transfer_speed: STANDARD transitions: - bank_transfer_token: cf3b49d8-bd68-4fb1-8da5-c170cff3d788 channel: API created_time: 2023-03-20T18:32:32Z last_modified_time: 2023-03-20T18:33:32Z reason: Created by `POST` call on API status: PENDING token: 0565329e-405d-45ca-9ab4-ca0cd07eca4c type: PUSH - amount: 100.0 currency_code: USD funding_source_token: bbaefe8f-f5d0-43f6-8576-16f562d23f3f standard_entry_class_code: WEB statement_descriptor: ACHTRNSFR status: PROCESSING token: f8b8245f-fc36-49f3-9f9f-f63b159501b7 transfer_speed: STANDARD transitions: - bank_transfer_token: f8b8245f-fc36-49f3-9f9f-f63b159501b7 channel: API created_time: 2023-03-22T18:01:00Z last_modified_time: 2023-03-22T18:02:00Z reason: Created by `POST` call on API status: PENDING token: 1d208bf9-8439-4b35-9c43-6d5bc74995c7 - bank_transfer_token: f8b8245f-fc36-49f3-9f9f-f63b159501b7 channel: API created_time: 2023-03-22T18:01:17Z last_modified_time: 2023-03-22T18:01:27Z reason: Created by `POST` call on API status: PROCESSING token: 55f5b1ac-39f6-484d-8284-116046a2efaa type: PUSH end_index: 1 is_more: false last_modified_time: 2023-03-22T18:02:17Z start_index: 0 schema: $ref: '#/components/schemas/BankTransferListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List ACH transfers tags: - Funding via ACH (Beta) post: description: Create an ACH transfer that pushes funds to an external account or pulls funds into your program funding account. operationId: postBanktransfersAch requestBody: content: application/json: example: amount: 10.49 currency_code: USD funding_source_token: d331b4b2-cef5-49a3-9c41-75d8f4e15cfz memo: Bank transfer standard_entry_class_code: WEB statement_descriptor: ACHTRNSFR transfer_speed: STANDARD type: PUSH schema: $ref: '#/components/schemas/bank_transfer_request_model' description: Create bank transfer request model required: true responses: '201': content: application/json: example: amount: 10.49 created_time: 2023-03-20T18:32:32Z currency_code: USD funding_source_token: d331b4b2-cef5-49a3-9c41-75d8f4e15cfz last_modified_time: 2023-03-20T18:32:32Z memo: Bank transfer standard_entry_class_code: WEB statement_descriptor: ACHTRNSFR status: PENDING token: cf3b49d8-bd68-4fb1-8da5-c170cff3d788 transfer_speed: STANDARD transitions: - bank_transfer_token: cf3b49d8-bd68-4fb1-8da5-c170cff3d788 channel: API created_time: 2023-03-20T18:32:32Z last_modified_time: 2023-03-20T18:32:32Z reason: Created by `POST` call on API status: PENDING token: 0565329e-405d-45ca-9ab4-ca0cd07eca4c type: PUSH schema: $ref: '#/components/schemas/bank_transfer_response_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Create ACH transfer tags: - Funding via ACH (Beta) /banktransfers/ach/transitions: get: description: Retrieve a list of all ACH transfer transitions for a given ACH transfer. 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: Unique identifier of the bank transfer transition. explode: true in: query name: token required: false schema: type: string style: form - description: Unique identifier of the bank transfer. explode: true in: query name: bank_transfer_token required: false schema: type: string 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 - description: Comma-delimited list of bank transfer states to display. explode: true in: query name: statuses required: false schema: type: string style: form responses: '200': content: application/json: example: count: 2 data: - bank_transfer_token: f8b8245f-fc36-49f3-9f9f-f63b159501b7 channel: API created_time: 2023-03-22T18:01:00Z last_modified_time: 2023-03-22T18:01:00Z reason: Created by `POST` call on API status: PENDING token: 1d208bf9-8439-4b35-9c43-6d5bc74995c7 - bank_transfer_token: f8b8245f-fc36-49f3-9f9f-f63b159501b7 channel: API created_time: 2023-03-22T18:01:17Z last_modified_time: 2023-03-22T18:01:17Z reason: Created by `POST` call on API status: PROCESSING token: 55f5b1ac-39f6-484d-8284-116046a2efaa end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/BankTransferTransitionListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List ACH transfer transitions tags: - Funding via ACH (Beta) post: description: |- Create an ACH transfer transition that updates the `status` of an ACH transfer. Each ACH transfer has a lifecycle of statuses, as shown in the following diagram: [#banktransfers-1-image] image::achtransfers1[alt='ACH transfer lifecycle', width=575] [NOTE] You can create ACH transfer transitions in the sandbox environment. However, Marqeta transitions ACH transfers through their lifecycle in the production environment. operationId: postBanktransfersAchTransitions requestBody: content: application/json: example: bank_transfer_token: f8b8245f-fc36-49f3-9f9f-f63b159501b7 channel: API status: CANCELLED schema: $ref: '#/components/schemas/bank_transfer_transition_request_model' description: Create bank transfer transition request model required: true responses: '201': content: application/json: example: bank_transfer_token: f8b8245f-fc36-49f3-9f9f-f63b159501b7 channel: API created_time: 2023-03-22T18:01:17Z last_modified_time: 2023-03-22T18:01:17Z status: CANCELLED token: 55f5b1ac-39f6-484d-8284-116046a2efaa schema: $ref: '#/components/schemas/bank_transfer_transition_response_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Create ACH transfer transition tags: - Funding via ACH (Beta) /banktransfers/ach/{token}: get: description: Retrieve a specific ACH transfer. operationId: getBanktransfersAchToken parameters: - description: Unique identifier of the bank transfer. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: amount: 100.0 created_time: 2023-03-22T18:01:00Z currency_code: USD funding_source_token: bbaefe8f-f5d0-43f6-8576-16f562d23f3f last_modified_time: 2023-03-22T18:01:17Z standard_entry_class_code: WEB statement_descriptor: ACHTRNSFR status: PROCESSING token: f8b8245f-fc36-49f3-9f9f-f63b159501b7 transfer_speed: STANDARD transitions: - bank_transfer_token: f8b8245f-fc36-49f3-9f9f-f63b159501b7 channel: API created_time: 2023-03-22T18:01:00Z last_modified_time: 2023-03-22T18:01:00Z reason: Created by `POST` call on API status: PENDING token: 1d208bf9-8439-4b35-9c43-6d5bc74995c7 - bank_transfer_token: f8b8245f-fc36-49f3-9f9f-f63b159501b7 channel: API created_time: 2023-03-22T18:01:17Z last_modified_time: 2023-03-22T18:01:17Z reason: Created by `POST` call on API status: PROCESSING token: 55f5b1ac-39f6-484d-8284-116046a2efaa type: PUSH schema: $ref: '#/components/schemas/bank_transfer_response_model' description: Success '404': content: { } description: Bank transfer entry not found '500': content: { } description: Server error summary: Retrieve ACH transfer tags: - Funding via ACH (Beta) /bulkissuances: get: description: |- Use this endpoint to list existing bulk card orders. This endpoint supports <>. operationId: getBulkissuances parameters: - description: Number of bulk card orders 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: 1 data[]: api: bulkissuances bc_id: 1 cp_id: 1 endpoint: /bulkissuances expedite: false fulfillment: shipping: card_allocation: 3 card_fulfillment_time: 2022-08-07T23:59:44Z card_personalization: carrier: message_line: my message name: my_carrier_logo.png images: card: name: my_card_logo.png thermal_color: Black carrier_return_window: name: my_return_address_image.png signature: name: my_signature.png text: name_line_1: value: Saki Dogger name_line_2: value: Aegis Fleet Services card_product_token: my_card_product_02 created_time: 2020-08-06T00:06:34Z expiration_offset: unit: YEARS value: 10 method: UPS_REGULAR name_line1_end_index: 3 name_line1_start_index: 1 name_line_1_numeric_postfix: true provider_ship_date: 2022-08-08T00:00:00Z provider_shipping_method: United_Parcel_Service provider_tracking_number: '982247' recipient_address: address1: 1255 Lake Street city: Oakland country: USA first_name: Saki last_name: Dogger phone: '5103333333' postal_code: '94611' state: CA return_address: address1: 1222 Blake Street city: Berkeley country: USA first_name: Shipping last_name: R_US phone: '5102222222' postal_code: '94702' state: CA user_association: single_inventory_user: false method: get token: bulk_06_token end_index: 0 is_more: true start_index: 0 schema: $ref: '#/components/schemas/BulkCardOrderListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List bulk card orders tags: - Bulk Card Orders post: description: |- Use this endpoint to order physical cards in bulk. A new bulk card order creates new cards or users, generally within about a day. Before creating a bulk card order, set the `config.fulfillment.bulk_ship` field of the associated card product to `true`. *To associate all cards with the same user:* * Set `user_association.single_inventory_user=true` * Set `user_association.single_inventory_user_token` equal to the token of an existing user. The bulk card order automatically populates the database with the specified card objects. Values for the card `token` fields are generated in the format `card-numericPostfix`, where `numericPostfix` is a randomly generated number that is added for each new card that is generated. *To associate each card with a unique user:* Set `user_association.single_inventory_user=false`. Both the cards and their associated users are automatically generated. Values for the user `token` fields are generated in the format `user-numericPostfix`. The `numericPostfix` values for cards and their associated users match. This value is also printed on the physical cards if the `name_line_1_numeric_postfix` field is set to `true`. operationId: postBulkissuances requestBody: content: application/json: example: card_allocation: 3 card_product_token: my_card_product_02 fulfillment: card_personalization: carrier: message_line: my message name: my_carrier_logo.png images: card: name: my_card_logo.png thermal_color: Black carrier_return_window: name: my_return_address_image.png signature: name: my_signature.png text: name_line_1: value: Saki Dogger name_line_2: value: Aegis Fleet Services shipping: method: UPS_REGULAR recipient_address: address1: 1255 Lake Street city: Oakland country: USA first_name: Saki last_name: Dogger phone: '5103333333' postal_code: '94611' state: CA return_address: address1: 1222 Blake Street city: Berkeley country: USA first_name: Shipping last_name: R_US phone: '5102222222' postal_code: '94702' state: CA name_line_1_numeric_postfix: true token: bulk_06_token user_association: single_inventory_user: false schema: $ref: '#/components/schemas/bulk_issuance_request' required: false responses: '201': content: application/json: example: api: bulkissuances bc_id: 1 card_allocation: 3 card_product_token: my_card_product_02 cp_id: 1 created_time: 2022-08-06T00:06:34Z endpoint: /bulkissuances expedite: false fulfillment: card_personalization: carrier: message_line: my message name: my_carrier_logo.png carrier_return_window: name: my_return_address_image.png images: card: name: my_card_logo.png thermal_color: Black signature: name: my_signature.png text: name_line_1: value: Saki Dogger name_line_2: value: Aegis Fleet Services shipping: method: UPS_REGULAR recipient_address: address1: 1255 Lake Street city: Oakland country: USA first_name: Saki last_name: Dogger phone: '5103333333' postal_code: '94611' state: CA return_address: address1: 1222 Blake Street city: Berkeley country: USA first_name: Shipping last_name: R_US phone: '5102222222' postal_code: '94702' state: CA method: post token: bulk_06_token user_association: expiration_offset: unit: YEARS value: 10 name_line_1_numeric_postfix: true single_inventory_user: false 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: Create bulk card order tags: - Bulk Card Orders /bulkissuances/{token}: get: description: Use this endpoint to retrieve a specific bulk card order. operationId: getBulkissuancesToken parameters: - description: The unique identifier of the bulk card order to retrieve. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: api: bulkissuances bc_id: 1 card_allocation: 3 card_fulfillment_time: 2022-03-07T23:59:44Z card_product_token: my_card_product_02 cp_id: 1 created_time: 2022-03-06T00:06:34Z endpoint: /bulkissuances/{token} expedite: false expiration_offset: unit: YEARS value: 10 fulfillment: card_personalization: carrier: message_line: my message name: my_carrier_logo.png images: card: name: my_card_logo.png thermal_color: Black carrier_return_window: name: my_return_address_image.png signature: name: my_signature.png text: name_line_1: value: Saki Dogger name_line_2: value: Aegis Fleet Services shipping: method: UPS_REGULAR recipient_address: address1: 1255 Lake Street city: Oakland country: USA first_name: Saki last_name: Dogger phone: 510-333-3333 postal_code: '94611' state: CA return_address: address1: 1222 Blake Street city: Berkeley country: USA first_name: Shipping last_name: R_US phone: '5102222222' postal_code: '94702' state: CA method: get name_line1_end_index: 3 name_line1_start_index: 1 name_line_1_numeric_postfix: true provider_ship_date: 2022-03-08T00:00:00Z provider_shipping_method: United_Parcel_Service provider_tracking_number: '982247' token: bulk_06_token user_association: single_inventory_user: false 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: Retrieve bulk card order tags: - Bulk Card Orders /businesses: get: description: |- To return an array of all businesses, send a `GET` request to the `/businesses` endpoint. To narrow your result set to businesses that match a particular legal or fictitious name, include the appropriate parameters from the following query parameters table. This endpoint also supports <> and <>. operationId: getBusinesses parameters: - description: Number of business 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: Fictitious or "doing business as (DBA)" name of the business. explode: true in: query name: business_name_dba required: false schema: type: string style: form - description: Legal name of the business. explode: true in: query name: business_name_legal required: false schema: type: string style: form - description: Specifies the search type for the query. 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: 1 data: - active: true business_name_dba: My_fictitious_business_name business_name_legal: My_legal_business_name business_type: My_business_type created_time: 2022-10-18T21:17:03Z date_established: 2010-04-15T00:01:00Z duns_number: '123456789' general_business_description: My_business_description history: My_business_history identifications: - type: BUSINESS_TAX_ID value: '123456789' in_current_location_since: 2010-04-15T00:01:00Z incorporation: address_registered_under: address1: 123 B Street city: Oakland country: US postal_code: '94610' state: CA incorporation_type: LLC is_public: true name_registered_under: First Middle Last state_of_incorporation: CA stock_symbol: MB international_office_locations: Athens, Greece; Buenos Aires, Argentina ip_address: 67.120.28.118 last_modified_time: 2022-10-19T22:48:02Z notes: My notes office_location: address1: 123 A Street address2: Suite 123 city: Oakland country: US postal_code: '94610' state: CA password: My_passw0rd phone: '5105551215' primary_contact: department: My_department email: dr_me@my_business.com extension: '11' fax: '5105551216' full_name: First Middle Last mobile: '5105551217' phone: '5105551215' title: Dr proprietor_or_officer: alternative_names: My Alternative Name dob: 1985-01-08T00:00:00Z email: mr.myself@my.business.com first_name: First home: address1: 123 B Street address2: Apt A city: Oakland country: US postal_code: '94610' state: CA last_name: Last middle_name: Middle phone: '5105551211' ssn: '5555' title: Mr status: ACTIVE token: my_business_01 website: https://my_business.com end_index: 0 is_more: true start_index: 0 schema: $ref: '#/components/schemas/BusinessCardHolderListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List businesses tags: - Businesses post: description: |- Create a business. The initial status of a newly created business depends on the <> of the program or associated <>. [cols="1,1,1,2"] |=== | KYC Required | Initial Business State | Business Active on Creation | Business Limitations | Always | `UNVERIFIED` | No | Cannot load funds. | Conditionally | `LIMITED` | No | Restricted by rules in `accountholdergroups.pre_kyc_controls`. | Never | `ACTIVE` | Required | None. |=== To change or track the history of a business' status, use the `/businesstransitions` endpoint. For more information on status changes, see <>. For information about configuring the required fields for KYC verification, see <>. operationId: postBusinesses requestBody: content: application/json: example: attestation_date: 2022-03-03T00:01:00Z attester_name: Jane Smith attester_title: Chief Executive Officer beneficial_owner1: dob: 1982-07-23T05:36:00Z first_name: First home: address1: 123 B Street address2: Apt A city: Oakland country: US postal_code: '94610' state: CA last_name: Last middle_name: Middle phone: '5105551212' ssn: '123456789' title: Ms beneficial_owner2: dob: 1973-11-11T11:11:11Z first_name: First home: address1: 4321 Grove Street address2: Suite 123 city: Oakland country: US postal_code: '94610' state: CA last_name: Last middle_name: Middle phone: '5105551213' ssn: '234567891' title: Ms beneficial_owner3: dob: 1981-02-14T15:16:17Z first_name: First home: address1: 789 Pulgas Ave city: Oakland country: US postal_code: '94610' state: CA last_name: Last middle_name: Middle phone: '5105551214' ssn: '345678912' title: Ms beneficial_owner4: dob: 1954-03-07T15:16:17Z first_name: First home: address1: 16 Poplar Street city: Oakland country: US postal_code: '94610' state: CA last_name: Last middle_name: Middle phone: '5105551215' ssn: '456789123' title: Dr business_name_dba: My_fictitious_business_name business_name_legal: My_legal_business_name business_type: My_business_type date_established: 2010-04-15T00:01:00Z duns_number: '987654321' general_business_description: My_business_description history: My_business_history identifications: - type: BUSINESS_TAX_ID value: '123456789' in_current_location_since: 2010-04-15T00:01:00Z incorporation: address_registered_under: address1: 123 B Street city: Oakland country: US postal_code: '94610' state: CA incorporation_type: LLC is_public: true name_registered_under: First Middle Last state_of_incorporation: CA stock_symbol: MB international_office_locations: Athens, Greece; Buenos Aires, Argentina, ip_address: 67.120.28.118, metadata: my_name_1: my_value_1 my_name_2: my_value_2 notes: My notes office_location: address1: 123 A street address2: Suite 123 city: Oakland country: US postal_code: '94610' state: CA password: My_passw0rd phone: '5105551212' primary_contact: department: My_department email: dr.me@my.business.com extension: '11' fax: '5105551222' full_name: First Middle Last mobile: '5105551213' phone: '5105551212' title: Dr proprietor_or_officer: alternative_names: My Alternative Name dob: 1985-01-08T00:00:00Z email: mr.myself@my.business.com first_name: First home: address1: 123 B Street address2: Apt A city: Oakland country: US postal_code: '94610' state: CA last_name: Last middle_name: Middle phone: '5105551211' ssn: '5555' title: Mr token: my_business_02 website: https://my_business_02.com schema: $ref: '#/components/schemas/business_cardholder' required: false responses: '201': content: application/json: example: active: true business_name_dba: My_fictitious_business_name business_name_legal: My_legal_business_name business_type: My_business_type created_time: 2022-01-13T23:29:10Z date_established: 2010-04-15T00:01:00Z deposit_account: account_number: '12342126720827265' routing_number: '293748000' token: 420df02a-6aef-42bf-be7b-0d080ebf7573 x-mq-internal: true duns_number: '987654321' general_business_description: My_business_description history: My_business_history identifications: - type: BUSINESS_TAX_ID value: '123456789' in_current_location_since: 2010-04-15T00:01:00Z incorporation: address_registered_under: address1: 123 B Street city: Oakland country: US postal_code: '94610' state: CA incorporation_type: LLC is_public: true name_registered_under: First Middle Last state_of_incorporation: CA stock_symbol: MB international_office_locations: Athens, Greece; Buenos Aires, Argentina ip_address: 67.120.28.118 last_modified_time: 2022-01-13T23:29:10Z metadata: my_name_1: my_value_1 my_name_2: my_value_2 notes: My notes office_location: address1: 123 A Street address2: Suite 123 city: Oakland country: US postal_code: '94610' state: CA password: My_passw0rd phone: '5105551212' primary_contact: department: My_department email: dr.me@my.business.com extension: '11' fax: '5105551222' full_name: First Middle Last mobile: '5105551213' phone: '5105551212' title: Dr proprietor_or_officer: alternative_names: My Alternative Name dob: 1985-01-08T00:00:00Z email: mr.myself@my.business.com first_name: First home: address1: 123 B Street address2: Apt A city: Oakland country: US postal_code: '94610' state: CA last_name: Last middle_name: Middle phone: '5105551211' ssn: '5555' title: Mr status: ACTIVE token: my_business_02 website: https://my_business_02.com 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: Create business tags: - Businesses /businesses/lookup: post: description: |- To search for one or more businesses, send a `POST` request to the `/businesses/lookup` endpoint. Include in the message body any parameters by which you want to query. This endpoint supports <> and <>. operationId: postBusinessesLookup requestBody: content: application/json: example: dda: '2129923205648' schema: $ref: '#/components/schemas/DDARequest' required: false responses: '200': content: application/json: example: account_holder_group_token: DEFAULT_AHG active: true business_name_dba: My_fictitious_business_name business_name_legal: My_legal_business_name business_type: other created_time: 2022-06-20T00:17:48Z date_established: 2010-01-01T00:01:00Z duns_number: '22344566' identifications: - type: BUSINESS_TAX_ID value: 11-1111111 incorporation: incorporation_type: CORPORATION state_of_incorporation: CA, last_modified_time: 2022-06-20T00:17:48Z metadata: my_name_1: my_value_1 my_name_2: my_value_2 office_location: address1: 111 Main St address2: Suite B city: Berkeley country: USA postal_code: '94702' state: CA phone: '5105551218' primary_contact: department: Accounts Payable email: me@my.company.com extension: '234' fax: '5105551219' full_name: First Middle Last mobile: '5105551220' phone: '5105551218' title: Mr. token: 297aa1a7-f3c9-46eb-9e0a-54f8bce0c189 schema: $ref: '#/components/schemas/business_cardholder' description: Success '404': content: { } description: Business not found '500': content: { } description: Server error summary: Search businesses tags: - Businesses /businesses/{parent_token}/children: get: description: |- To return an array of all child cardholders of a particular business, send a `GET` request to the `/businesses/{parent_token}/children` endpoint. Include the `parent_token` as a URL path parameter. This endpoint supports <>. operationId: getBusinessesParenttokenChildren parameters: - description: Number of child cardholders 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 business. 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: - active: true address1: 1234 Lake Street birth_date: 1990-01-01 business_token: my_business_01 city: Berkeley country: US created_time: 2022-10-20T17:50:36Z email: my_child_user_01@gmail.com first_name: First gender: F identifications: - type: SSN value: '123456789' last_modified_time: 2022-10-20T17:50:36Z last_name: Last metadata: my_name_1: my_value_1 my_name_2: my_value_2 parent_token: my_business_01 password: My_passw0rd phone: 510-555-1111 postal_code: '94702' state: CA status: ACTIVE token: my_child_user_01 uses_parent_account: true end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/BusinessUserCardHolderListResponse' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: List business children tags: - Businesses /businesses/{token}: get: description: |- To retrieve a specific business, send a `GET` request to the `/businesses/{token}` endpoint. Include the business `token` path parameter to specify the business to return. This endpoint supports <> and <>. operationId: getBusinessesToken parameters: - description: Unique identifier of the business 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 business_name_dba: My_fictitious_business_name business_name_legal: My_legal_business_name business_type: My_business_type created_time: 2022-01-13T23:29:10Z date_established: 2010-04-15T00:01:00Z deposit_account: account_number: '12342126720827265' routing_number: '293748000' token: 420df02a-6aef-42bf-be7b-0d080ebf7573 x-mq-internal: true duns_number: '123456789' general_business_description: My_business_description history: My_business_history identifications: - type: BUSINESS_TAX_ID value: '123456789' in_current_location_since: 2010-04-15T00:01:00Z incorporation: address_registered_under: address1: 123 B Street city: Oakland country: US postal_code: '94610' state: CA incorporation_type: LLC is_public: true name_registered_under: First Middle Last state_of_incorporation: CA stock_symbol: MB international_office_locations: Athens, Greece; Buenos Aires, Argentina ip_address: 67.120.28.118 last_modified_time: 2022-01-13T23:29:10Z metadata: my_name_1: my_value_1 my_name_2: my_value_2 notes: My notes office_location: address1: 123 A street address2: Suite 123 city: Oakland country: US postal_code: '94610' state: CA password: My_passw0rd phone: '5105551212' primary_contact: department: My_department email: dr.me@my.business.com extension: '11' fax: '5105551222' full_name: First Middle Last mobile: '5105551213' phone: '5105551212' title: Dr proprietor_or_officer: alternative_names: My Alternative Name dob: 1985-01-08T00:00:00Z email: mr.myself@my.business.com first_name: First home: address1: 123 B Street address2: Apt A city: Oakland country: US postal_code: '94610' state: CA last_name: Last middle_name: Middle phone: '5105551211' ssn: '5555' title: Mr status: ACTIVE token: my_business_02 website: https://my_business_02.com 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: Retrieve business tags: - Businesses put: description: |- To update a business, send a `PUT` request to `/businesses/{token}`. Use the `token` path parameter to specify the business to update. Include the business details to update in link:http://www.json.org/[JSON, window="_blank"] format in the body of the request. Only values of parameters in the request are modified; all others are left unchanged. operationId: putBusinessesToken parameters: - description: Unique identifier of the business resource 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: Update business tags: - Businesses /businesses/{token}/ssn: get: description: |- To retrieve the government-issued identification number of a business' proprietor, send a `GET` request to the `/businesses/{token}/ssn` endpoint. Include the `token` path parameter to specify the business whose identification number (SSN, TIN, NIN, SIN) you want to return. You can indicate whether to return the full number or the last four digits only. operationId: getBusinessesTokenSsn parameters: - description: Unique identifier of the business 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 `proprietor_or_officer.identifications` array contains only the last four digits of the identification number, the `/businesses/{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 business identification number tags: - Businesses /businesstransitions: post: description: |- This endpoint enables you to change a business' status, depending on your role and the previous status change. By changing a business' status, you can control the business' capabilities and the setting of the `business.active` field. The `business.active` field is `true` if your business is in the `LIMITED` or `ACTIVE` state, and `false` if your business is in the `UNVERIFIED` state. You cannot control the value of the `business.active` field directly. [cols=",2a,2a"] |=== | The business.status field | Description | Business limitations | Unverified | Initial status of a newly created business belonging to an `accountholdergroup` where KYC is always required. | Cannot load funds. *The business.active field:* + `false` *Allowable transitions:* + `ACTIVE`, `SUSPENDED`, `CLOSED` | Limited | Initial status of a newly created business belonging to an `accountholdergroup` where KYC is conditionally required. | Restricted by rules in `accountholdergroups.pre_kyc_controls`. *The business.active field:* + `true` *Allowable transitions:* + `ACTIVE`, `SUSPENDED`, `CLOSED` | Active | Status of a business that has passed KYC; initial status of a newly created business belonging to an `accountholdergroup` where KYC is never required. | None. *The business.active field:* + `true` *Allowable transitions:* + `SUSPENDED`, `CLOSED` | Suspended | The business is temporarily inactive. *NOTE:* Transitioning a suspended business to the `ACTIVE` status is restricted, based on your role and the details of the previous status change. | Cannot load funds or activate cards. *The business.active field:* + `false` *Allowable transitions:* + `ACTIVE`, `LIMITED`, `UNVERIFIED`, `CLOSED` | Closed | The business is permanently inactive. *NOTE:* `CLOSED` is a terminal status. In exceptional cases, you can transition a business from `CLOSED` to another status, depending on your role and the details of the previous status change. Contact your Marqeta representative for more information. | Cannot load funds. *The business.active field:* + `false` *Allowable transitions:* + `ACTIVE`, `LIMITED`, `UNVERIFIED`, `SUSPENDED` |=== [NOTE] The Marqeta platform transitions a business' status in response to certain events. For example, a business with an `UNVERIFIED` status transitions to `ACTIVE` when the business passes KYC. operationId: postBusinesstransitions requestBody: content: application/json: example: business_token: my_business_01 channel: API reason: Activating business reason_code: '00' status: ACTIVE token: activate_05 schema: $ref: '#/components/schemas/BusinessTransitionRequest' required: false responses: '201': content: application/json: example: business_token: my_business_01 channel: API created_time: 2022-09-23T23:28:39Z reason: Activating business reason_code: '00' status: ACTIVE token: activate_05 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: Create business transition tags: - Business Transitions /businesstransitions/business/{business_token}: get: description: List all transitions for a given business. operationId: getBusinesstransitionsBusinessBusinesstoken parameters: - description: Unique identifier of the business resource associated with the transitions to retrieve. 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: 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: - business_token: my_business_01 channel: API created_time: 2022-11-23T23:28:39Z reason: Activating business reason_code: '00' status: ACTIVE token: activate_05 end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/BusinessTransitionListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List business transitions tags: - Business Transitions /businesstransitions/{token}: get: description: Use this endpoint to retrieve a business transition. operationId: getBusinesstransitionsToken parameters: - description: The unique identifier of the business transition you want to retrieve. explode: false in: path name: token required: true schema: type: string style: simple - 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: fields required: false schema: type: string style: form responses: '200': content: application/json: example: business_token: my_business_01 channel: API created_time: 2022-11-23T23:28:39Z reason: Activating business reason_code: '00' status: ACTIVE token: activate_05 schema: $ref: '#/components/schemas/BusinessTransitionResponse' description: Success '400': content: { } description: Bad request '404': content: { } description: Cardholder not found '500': content: { } description: Server error summary: Retrieve business transition tags: - Business Transitions /cardproducts: get: description: |- Use this endpoint to list existing card products. This endpoint supports <>. operationId: getCardproducts parameters: - description: |- Number of resources 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: 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: |- 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 card_life_cycle: activate_upon_issue: true card_service_code: 101 expiration_offset: min_offset: unit: YEARS value: 4 unit: YEARS value: 10 update_expiration_upon_activation: false clearing_and_settlement: overdraft_destination: GPA config: all_zero_card_security_code: false allow_card_creation: true bin_prefix: '111111' bulk_ship: false fulfillment: card_personalization: carrier: message_line: my message name: my_carrier_logo.png carrier_return_window: name: my_return_address_image.png images: card: name: my_card_logo.png thermal_color: Black signature: name: my_signature.png text: name_line_1: null name_line_2: value: Aegis Fleet Services value: Saki Dogger shipping: method: OVERNIGHT recipient_address: address1: 1234 Grove Street city: Berkeley country: USA first_name: Jane last_name: Doe phone: '5105551212' postal_code: 94702 state: CA return_address: address1: 123 Henry St address2: Suite 101 city: Porterville country: USA first_name: Saki last_name: Dogger middle_name: R phone: '8315555555' postal_code: '93257' state: CA fulfillment_provider: PERFECTPLASTIC package_id: '0' pan_length: '16' payment_instrument: PHYSICAL_MSR poi: atm: false ecommerce: false other: allow: true, card_presence_required: false, cardholder_presence_required: false transaction_controls: accepted_countries_token: accept_us_only address_verification: auth_messages: decline_on_address_number_mismatch: false decline_on_postal_code_mismatch: false validate: true av_messages: decline_on_address_number_mismatch: false decline_on_postal_code_mismatch: true validate: true allow_gpa_auth: true allow_mcc_group_authorization_controls: true allow_network_load: false allow_network_load_card_activation: false allow_quasi_cash: false always_require_icc: false always_require_pin: false enable_partial_auth_approval: true ignore_card_suspended_state: false notification_language: fra require_card_not_present_card_security_code: false uppercase_name_lines: true created_time: 2022-04-27T19:25:55Z digital_wallet_tokenization: provisioning_controls: dwt_use_card_status_during_auth: false in_app_provisioning: address_verification: validate: true enabled: false manual_entry: address_verification: validate: true enabled: false wallet_provider_card_on_file: address_verification: validate: true enabled: false jit_funding: paymentcard_funding_source: enabled: true refunds_destination: '' program_funding_source: enabled: false funding_source_token: '' refunds_destination: PROGRAM_FUNDING_SOURCE programgateway_funding_source: enabled: false funding_source_token: '' refunds_destination: GATEWAY last_modified_time: 2022-04-27T21:29:12Z name: My Card Product 01 selective_auth: dmd_location_sensitivity: 0 enable_regex_search_chain: false sa_mode: 1 start_date: 2022-04-27 token: my_cardproduct_01 end_index: 0 is_more: true start_index: 0 schema: $ref: '#/components/schemas/CardProductListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List card products tags: - Card Products post: description: |- Use this endpoint to create a card product. The card product request contains a set of fields that provide basic information about the card product, such as name, active status, and start and end dates. Configuration information is contained in the `config` object, which contains sub-elements whose fields control the features and behavior of the card product. The elements are referred to collectively as the card product "configuration," and as such are contained in a `config` object. operationId: postCardproducts requestBody: content: application/json: example: config: card_life_cycle: activate_upon_issue: true card_service_code: 101 expiration_offset: unit: YEARS value: 10 update_expiration_upon_activation: false fulfillment: all_zero_card_security_code: false bin_prefix: '111111' bulk_ship: false card_personalization: carrier: message_line: my message name: my_carrier_logo.png carrier_return_window: name: my_return_address_image.png images: card: name: my_card_logo.png thermal_color: Black signature: name: my_signature.png text: name_line_1: value: Saki Dogger name_line_2: value: Aegis Fleet Services fulfillment_provider: PERFECTPLASTIC package_id: '0' pan_length: '16' payment_instrument: PHYSICAL_MSR shipping: method: OVERNIGHT recipient_address: address1: 1234 Grove Street city: Berkeley country: USA first_name: Jane last_name: Doe phone: '5105551212' postal_code: '94702' state: CA return_address: address1: 123 Henry St address2: Suite 101 city: Porterville country: USA first_name: Saki last_name: Dogger middle_name: R phone: '8315551212' postal_code: '93257' state: CA jit_funding: paymentcard_funding_source: enabled: true poi: atm: false ecommerce: false other: allow: true card_presence_required: false cardholder_presence_required: false selective_auth: dmd_location_sensitivity: 0 enable_regex_search_chain: false sa_mode: 1 transaction_controls: accepted_countries_token: accept_us_only allow_gpa_auth: true allow_mcc_group_authorization_controls: true allow_network_load: false allow_network_load_card_activation: false allow_quasi_cash: false always_require_icc: false always_require_pin: false enable_partial_auth_approval: true ignore_card_suspended_state: false notification_language: fra require_card_not_present_card_security_code: false name: My Card Product 01 start_date: 2021-04-27 token: my_cardproduct_01 schema: $ref: '#/components/schemas/card_product_request' description: Card product object required: true responses: '201': content: application/json: example: active: true config: all_zero_card_security_code: false allow_card_creation: true bin_prefix: '111111' bulk_ship: false card_life_cycle: activate_upon_issue: true card_service_code: 101 expiration_offset: unit: YEARS value: 10 update_expiration_upon_activation: false clearing_and_settlement: overdraft_destination: GPA digital_wallet_tokenization: card_art_id: myCardArt01 provisioning_controls: dwt_use_card_status_during_auth: false in_app_provisioning: address_verification: validate: true enabled: false manual_entry: address_verification: validate: true enabled: false wallet_provider_card_on_file: address_verification: validate: true enabled: false enable_offline_pin: false fulfillment: card_personalization: carrier: message_line: my message name: my_carrier_logo.png carrier_return_window: name: my_return_address_image.png images: card: name: my_card_logo.png thermal_color: Black signature: name: my_signature.png text: name_line_1: value: Saki Dogger name_line_2: value: Aegis Fleet Services shipping: method: OVERNIGHT recipient_address: address1: 1234 Grove Street city: Berkeley country: USA first_name: Jane last_name: Doe phone: '5105551212' postal_code: '94702' state: CA return_address: address1: 123 Henry St address2: Suite 101 city: Porterville country: USA first_name: Saki last_name: Dogger middle_name: R phone: '8315551212' postal_code: '93257' state: CA fulfillment_provider: PERFECTPLASTIC jit_funding: paymentcard_funding_source: enabled: true refunds_destination: GPA program_funding_source: enabled: false funding_source_token: '' refunds_destination: PROGRAM_FUNDING_SOURCE programgateway_funding_source: always_fund: true enabled: false funding_source_token: '' refunds_destination: GATEWAY package_id: '0' pan_length: '16' payment_instrument: PHYSICAL_MSR poi: atm: false ecommerce: false other: allow: true card_presence_required: false cardholder_presence_required: false selective_auth: dmd_location_sensitivity: 0 enable_regex_search_chain: false sa_mode: 1 transaction_controls: accepted_countries_token: accept_us_only address_verification: auth_messages: decline_on_address_number_mismatch: false decline_on_postal_code_mismatch: false validate: true av_messages: decline_on_address_number_mismatch: false decline_on_postal_code_mismatch: true validate: true allow_chip_fallback: true allow_gpa_auth: true allow_mcc_group_authorization_controls: true allow_network_load: false allow_network_load_card_activation: false allow_quasi_cash: false always_require_icc: false always_require_pin: false enable_partial_auth_approval: true ignore_card_suspended_state: false notification_language: fra quasi_cash_exempt_mids: 984226812886,000984226812886 require_card_not_present_card_security_code: false strong_customer_authentication_limits: sca_contactless_cumulative_amount_limit: 150.0 sca_contactless_transaction_limit: 30.0 sca_contactless_transactions_count_limit: 5 sca_contactless_transactions_currency: EUR uppercase_name_lines: true created_time: 2022-03-26T20:25:52Z last_modified_time: 2022-03-26T20:25:52Z name: My Card Product 01 start_date: 2021-04-27 token: my_cardproduct_01 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: Create card product tags: - Card Products /cardproducts/{token}: get: description: Use this endpoint to retrieve a specific card product. operationId: getCardproductsToken parameters: - description: Unique identifier of the card product to retrieve. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: active: true config: all_zero_card_security_code: false allow_card_creation: true bin_prefix: '111111' bulk_ship: false card_life_cycle: activate_upon_issue: true card_service_code: 101 expiration_offset: unit: YEARS value: 10 update_expiration_upon_activation: false clearing_and_settlement: overdraft_destination: GPA digital_wallet_tokenization: card_art_id: myCardArt01 provisioning_controls: dwt_use_card_status_during_auth: false in_app_provisioning: address_verification: validate: true enabled: false manual_entry: address_verification: validate: true enabled: false wallet_provider_card_on_file: address_verification: validate: true enabled: false enable_offline_pin: false fulfillment: card_personalization: carrier: message_line: my message name: my_carrier_logo.png carrier_return_window: name: my_return_address_image.png images: card: name: my_card_logo.png thermal_color: Black signature: name: my_signature.png text: name_line_1: value: Saki Dogger name_line_2: value: Aegis Fleet Services shipping: method: OVERNIGHT recipient_address: address1: 1234 Grove Street city: Berkeley country: USA first_name: Jane last_name: Doe phone: '5105551212' postal_code: '94702' state: CA return_address: address1: 123 Henry St address2: Suite 101 city: Porterville country: USA first_name: Saki last_name: Dogger middle_name: R phone: '8315551212' postal_code: '93257' state: CA fulfillment_provider: PERFECTPLASTIC jit_funding: paymentcard_funding_source: enabled: true refunds_destination: GPA program_funding_source: enabled: false funding_source_token: '' refunds_destination: PROGRAM_FUNDING_SOURCE programgateway_funding_source: always_fund: true enabled: false funding_source_token: '' refunds_destination: GATEWAY package_id: '0' pan_length: '16' payment_instrument: PHYSICAL_MSR poi: atm: false ecommerce: false other: allow: true card_presence_required: false cardholder_presence_required: false selective_auth: dmd_location_sensitivity: 0 enable_regex_search_chain: false sa_mode: 1 transaction_controls: accepted_countries_token: accept_us_only address_verification: auth_messages: decline_on_address_number_mismatch: false decline_on_postal_code_mismatch: false validate: true av_messages: decline_on_address_number_mismatch: false decline_on_postal_code_mismatch: true validate: true allow_chip_fallback: true allow_gpa_auth: true allow_mcc_group_authorization_controls: true allow_network_load: false allow_network_load_card_activation: false allow_quasi_cash: false always_require_icc: false always_require_pin: false enable_partial_auth_approval: true ignore_card_suspended_state: false notification_language: fra quasi_cash_exempt_mids: 984226812886,000984226812886 require_card_not_present_card_security_code: false strong_customer_authentication_limits: sca_contactless_cumulative_amount_limit: 150.0 sca_contactless_transaction_limit: 30.0 sca_contactless_transactions_count_limit: 5 sca_contactless_transactions_currency: EUR uppercase_name_lines: true created_time: 2022-03-26T20:25:52Z last_modified_time: 2022-03-26T20:25:52Z name: My Card Product 01 start_date: 2022-03-26 token: my_cardproduct_01 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: Retrieve card product tags: - Card Products put: description: |- Use this endpoint to update a card product. Only values of fields in the request are modified; all others are left unchanged. operationId: putCardproductsToken parameters: - description: Unique identifier of the card product to update. explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: example: active: false schema: $ref: '#/components/schemas/card_product_update_model' description: Card product object required: true responses: '200': content: application/json: example: active: false card_life_cycle: activate_upon_issue: true card_service_code: 101 expiration_offset: unit: YEARS value: 10 update_expiration_upon_activation: false config: all_zero_card_security_code: false bin_prefix: '111111' bulk_ship: false fulfillment: card_personalization: carrier: message_line: my message name: my_carrier_logo.png carrier_return_window: name: my_return_address_image.png images: card: name: my_card_logo.png thermal_color: Black signature: name: my_signature.png text: name_line_1: value: Saki Dogger name_line_2: value: Aegis Fleet Services shipping: method: OVERNIGHT recipient_address: address1: 1234 Grove Street city: Berkeley country: USA first_name: Jane last_name: Doe phone: '5105551212' postal_code: '94702' state: CA return_address: address1: 123 Henry St address2: Suite 101 city: Porterville country: USA first_name: Saki last_name: Dogger middle_name: R phone: '8315551212' postal_code: '93257' state: CA fulfillment_provider: PERFECTPLASTIC package_id: '0' pan_length: '16' payment_instrument: PHYSICAL_MSR poi: atm: false ecommerce: false other: allow: true card_presence_required: false cardholder_presence_required: false transaction_controls: accepted_countries_token: accept_us_only allow_gpa_auth: true allow_mcc_group_authorization_controls: true allow_network_load: false allow_network_load_card_activation: false allow_quasi_cash: false always_require_icc: false always_require_pin: false enable_partial_auth_approval: true ignore_card_suspended_state: false notification_language: fra require_card_not_present_card_security_code: false created_time: 2022-04-27T19:25:55Z jit_funding: paymentcard_funding_source: enabled: true last_modified_time: 2022-04-27T21:29:12Z name: My Card Product 01 selective_auth: dmd_location_sensitivity: 0 enable_regex_search_chain: false sa_mode: 1 start_date: 2022-04-27 token: my_cardproduct_01 schema: $ref: '#/components/schemas/card_product_response' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Update card product tags: - Card Products /cards: get: description: |- Retrieves an array of cards whose primary account numbers (PANs) end in the four digits specified by the `last_four` query parameter. This endpoint supports <>, <>, <>. operationId: getCards 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: Last four digits of the primary account number (PAN) of the card you want to locate. explode: true in: query name: last_four required: true 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: |- 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: - barcode: '25815105237561780909' card_product_token: my_cardproduct_01 created_time: 2022-02-08T18:31:23Z expedite: false expiration: '1225' expiration_time: 2027-12-31T23:59:59Z fulfillment: card_personalization: images: card: name: my_card_logo.png thermal_color: Black carrier_return_window: name: my_return_address_image.png signature: name: my_signature.png text: name_line_1: value: My card personalization line 1 name_line_2: value: My card personalization line 2 shipping: care_of_line: my_care_of_value method: FEDEX_REGULAR fulfillment_status: DIGITALLY_PRESENTED instrument_type: PHYSICAL_MSR last_four: '1865' last_modified_time: 2022-02-14T19:32:38Z pan: '1111111824981865' pin_is_set: false state: UNACTIVATED state_reason: New card token: my_user_01_card_02 user_token: my_user_01 end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/CardListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List cards by last 4 digits of PAN tags: - Cards post: description: |- Creates a card. Create the user and card product before you create the card. You create a card using the `user_token` of the user who will own the card and the `card_product_token` of the card product that will control the card. [TIP] By default, newly created cards are inactive and must be explicitly activated (see <> for information on activating cards). To create cards that are activated upon issue, configure your card product's `config.card_life_cycle.activate_upon_issue` field (see <>). Send a `POST` request to `/pins/controltoken` to set the card's personal identification number (PIN) if your program requires PIN numbers (for example, for Europay Mastercard and Visa cards); this action updates the `pin_is_set` field to `true`. See <> for details. You can use optional query parameters to show the primary account number (PAN) and card verification value (CVV2) number in the response. If `show_pan` and `show_cvv_number` are set to `true`, the fulfillment state of the card is `DIGITALLY_PRESENTED` instead of the typical initial state of `ISSUED`. This fulfillment state does not affect the delivery of physical cards. This endpoint requires PCI DSS compliance if `show_pan` and `show_cvv_number` are set to `true`. You must comply with PCI DSS data security requirements if you store, transmit, or process sensitive card data. operationId: postCards parameters: - description: Set to `true` to show the CVV2 number in the response. explode: true in: query name: show_cvv_number required: false schema: default: false type: boolean style: form - description: Set to `true` to show the full primary account number (PAN) in the response. explode: true in: query name: show_pan required: false schema: default: false type: boolean style: form requestBody: content: application/json: example: card_product_token: my_cardproduct_01 fulfillment: card_personalization: images: card: name: my_card_logo.png thermal_color: Black carrier_return_window: name: my_return_address_image.png signature: name: my_signature.png text: name_line_1: value: Jane Doe name_line_2: value: My card personalization line 2 metadata: my_name_1: my_value_1 my_name_2: my_value_2 token: my_test_card_01 user_token: my_user_01 schema: $ref: '#/components/schemas/card_request' required: false responses: '201': content: application/json: example: barcode: '51554698491331520446' card_product_token: my_cardproduct_01 created_time: 2022-02-26T20:40:04Z expedite: false expiration: '0331' expiration_time: 2027-03-31T23:59:59Z fulfillment: card_personalization: images: card: name: my_card_logo.png thermal_color: Black carrier_return_window: name: my_return_address_image.png signature: name: my_signature.png text: name_line_1: value: Jane Doe name_line_2: value: My card personalization line 2 fulfillment_status: ISSUED instrument_type: PHYSICAL_MSR last_four: '6270' last_modified_time: 2022-02-26T20:40:04Z metadata: my_name_1: my_value_1 my_name_2: my_value_2 pan: '1111111824986720' pin_is_set: false state: ACTIVE state_reason: New card activated token: my_test_card_01 user_token: my_user_01 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: Create card tags: - Cards /cards/barcode/{barcode}: get: description: |- Retrieves a card by its barcode. This endpoint supports <> and <>. operationId: getCardsBarcodeBarcode parameters: - description: Barcode of the card to retrieve. explode: false in: path name: barcode 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: barcode: '780672318863' card_product_token: my_cardproduct_01 created_time: 2022-02-28T18:31:23Z expedite: false expiration: '0216' expiration_time: 2027-02-28T23:59:59Z fulfillment_status: SHIPPED instrument_type: PHYSICAL_MSR last_four: '5454' last_modified_time: 2022-02-28T18:41:00Z pan: '5454545454545454' pin_is_set: false state: ACTIVE state_reason: New card activated token: my_card user_token: my_user_01 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: Retrieve card by barcode tags: - Cards /cards/getbypan: post: description: |- Retrieves the `user_token` and `card_token` for a primary account number (PAN). In the case of a reissued card, where multiple cards share the same PAN, the information for the most recently issued card is returned. This request is useful in IVR scenarios where a user has telephoned and identifies the card by the PAN. The retrieval of these tokens is implemented as a `POST` request because supplying the PAN in the request body is more secure than supplying it in the URL (as would be required with a `GET`). [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: postCardsGetbypan requestBody: content: application/json: example: pan: '5454545454545454' schema: $ref: '#/components/schemas/pan_request' required: false responses: '200': content: application/json: example: card_token: my_card1 created_time: 2022-02-26T20:03:15Z last_modified_time: 2022-02-26T20:05:20Z user_token: my_user schema: $ref: '#/components/schemas/pan_response' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Retrieve card by PAN tags: - Cards /cards/user/{token}: get: description: |- Retrieves a list of the cards associated with a specific user. This endpoint supports <> <>, and <>. operationId: getCardsUserToken parameters: - description: |- Unique identifier of the user whose cards you want to list. Send a `GET` request to `/users` to retrieve user tokens. explode: false in: path name: token required: true schema: type: string style: simple - 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: |- 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: 3 data: - barcode: '11379418395311581864' card_product_token: my_cardproduct_01 created_time: 2022-02-24T21:23:31Z expedite: false expiration: '1026' expiration_time: 2027-10-31T23:59:59Z fulfillment_status: ISSUED instrument_type: PHYSICAL_MSR last_four: '2160' last_modified_time: 2022-02-26T19:55:09Z pan: '1111115454542160' pin_is_set: false state: SUSPENDED state_reason: I do not want to use this card, so suspend it. token: my_user_01_card_01 user_token: my_user_01 - barcode: '25815105237561780909' card_product_token: my_cardproduct_01 created_time: 2021-12-28T18:31:23Z expedite: false expiration: '1220' expiration_time: 2026-12-31T23:59:59Z fulfillment: card_personalization: images: card: name: my_card_logo.png thermal_color: Black carrier_return_window: name: my_return_address_image.png signature: name: my_signature.png text: name_line_1: value: My card personalization line 1 name_line_2: value: My card personalization line 2 shipping: care_of_line: my_care_of_value method: FEDEX_REGULAR fulfillment_status: ISSUED instrument_type: PHYSICAL_MSR last_four: '1865' last_modified_time: 2021-12-28T18:36:23Z pan: '1111111824981865' pin_is_set: false state: UNACTIVATED state_reason: New card token: my_user_01_card_02 user_token: my_user_01 - barcode: '63143403984499099324' card_product_token: my_cardproduct_01 created_time: 2021-11-03T21:55:08Z expedite: false expiration: '1126' expiration_time: 2026-11-30T23:59:59Z fulfillment_status: ISSUED instrument_type: PHYSICAL_MSR last_four: '2810' last_modified_time: 2021-11-03T21:55:08Z pan: '1111115454542810' pin_is_set: false state: UNACTIVATED state_reason: New card token: my_user-01-child_01_card_01 user_token: my_user-01-child_01 end_index: 2 is_more: false start_index: 0 schema: $ref: '#/components/schemas/CardListResponse' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: List cards for user tags: - Cards /cards/{token}: get: description: |- Retrieves a specific card. This endpoint supports <> and <>. operationId: getCardsToken parameters: - description: Unique identifier of the card 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 - description: Embeds the associated object of the specified type into the response, for all `GET /cards` endpoints. explode: true in: query name: expand required: false schema: type: string style: form responses: '200': content: application/json: example: barcode: '17469201908992951865' card_product_token: my_cardproduct_01 created_time: 2022-02-14T18:48:10Z expedite: false expiration: '0221' expiration_time: 2027-02-28T23:59:59Z fulfillment: card_personalization: images: card: name: my_card_logo.png thermal_color: Black carrier_return_window: name: my_return_address_image.png signature: name: my_signature.png text: name_line_1: value: My card personalization line 1 name_line_2: value: My card personalization line 2 fulfillment_status: ISSUED instrument_type: PHYSICAL_MSR last_four: '8949' last_modified_time: 2022-02-14T18:58:10Z metadata: my_name_1: my_value_1 my_name_2: my_value_2 pan: '1111115454548949' pin_is_set: false state: UNACTIVATED state_reason: New card token: mytestcard01 user_token: my_user_01 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: Retrieve card tags: - Cards put: description: Updates the details of an existing card. operationId: putCardsToken parameters: - description: Unique identifier of the card you want to update. explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: example: token: my_card_token_03 user_token: my_user_03 schema: $ref: '#/components/schemas/card_update_request' required: false responses: '200': content: application/json: example: barcode: '17469201908992951865' card_product_token: my_cardproduct_01 created_time: 2022-02-14T18:48:10Z expedite: false expiration: '0221' expiration_time: 2027-02-28T23:59:59Z fulfillment: card_personalization: images: card: name: my_card_logo.png thermal_color: Black carrier_return_window: name: my_return_address_image.png signature: name: my_signature.png text: name_line_1: value: My card personalization line 1 name_line_2: value: My card personalization line 2 shipping: method: UPS_REGULAR recipient_address: address1: 1234 Grove St city: Berkeley country: US first_name: Jane last_name: Doe phone: '5105551212' postal_code: '94702' state: CA return_address: address1: 123 Henry St address2: Suite 101 city: Porterville country: US first_name: Saki last_name: Dogger middle_name: R phone: '8315555555' postal_code: '93257' state: CA fulfillment_status: ISSUED instrument_type: PHYSICAL_MSR last_four: '8949' last_modified_time: 2022-02-14T18:58:10Z metadata: my_name_1: my_value_1 pan: '1111115454548949' pin_is_set: false state: UNACTIVATED state_reason: New card token: mytestcard01 user_token: my_user_01 schema: $ref: '#/components/schemas/card_response' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Update card tags: - Cards /cards/{token}/showpan: get: description: |- Retrieves a primary account number (PAN). For security reasons, the PAN is not fully visible on the card resource returned by `GET` `/cards/{token}`. This endpoint supports <> and <>. operationId: getCardsTokenShowpan parameters: - description: |- Unique identifier of the card whose primary account number (PAN) you want to retrieve. Send a `GET` request to `/cards` to retrieve card tokens. 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: Set to `true` to show the CVV2 number in the response. explode: true in: query name: show_cvv_number required: false schema: type: boolean style: form responses: '200': content: application/json: example: barcode: '25815105237561780909' card_product_token: my_cardproduct_01 created_time: 2021-12-28T18:31:23Z cvv_number: '137' expedite: false expiration: '1220' expiration_time: 2026-12-31T23:59:59Z fulfillment: card_personalization: images: card: name: my_card_logo.png thermal_color: Black carrier_return_window: name: my_return_address_image.png signature: name: my_signature.png text: name_line_1: value: My card personalization line 1 name_line_2: value: My card personalization line 2 shipping: care_of_line: my_care_of_value method: FEDEX_REGULAR fulfillment_status: DIGITALLY_PRESENTED instrument_type: PHYSICAL_MSR last_four: '1865' last_modified_time: 2022-02-14T19:32:38Z pan: '1111111824981865' pin_is_set: false state: UNACTIVATED state_reason: New card token: my_user_01_card_02 user_token: my_user_01 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: Show card PAN tags: - Cards /cardtransitions: post: description: |- Creates a card state transition to set the state of an existing card. If your system uses IVR, you can send a `POST` request to `/cards/getbypan` to retrieve a card token, which you can then use in your `POST` request to `/cardtransitions`. It may not be possible to move a card from one user to another once the card has been activated. operationId: postCardtransitions requestBody: content: application/json: example: card_token: my_user_01_card_01 channel: API reason: I want to use this card, so activate it. reason_code: '00' state: ACTIVE token: activate_05 validations: user: birth_date: 1990-01-31T00:00:00Z schema: $ref: '#/components/schemas/card_transition_request' required: false responses: '201': content: application/json: example: barcode: '11379418395311581864' card_product_token: my_cardproduct_01 card_token: my_user_01_card_01 channel: API created_time: 2022-11-23T23:28:39Z expedite: false expiration: '1026' expiration_time: 2026-10-31T23:59:59Z fulfillment_status: ISSUED last_four: '2160' pan: '1111115454542160' pin_is_set: false reason: I want to use this card, so activate it. reason_code: '00' state: ACTIVE token: activate_05 type: state.activated user: metadata: my_name_1: my_value_1 my_name_2: my_value_2 user_token: my_user_01 validations: user: birth_date: true phone: false random_name_line1_postfix: false ssn: false 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: Create card transition tags: - Card Transitions /cardtransitions/card/{token}: get: description: |- Retrieves a list of the transitions for a specific card. This endpoint supports <> and <>. operationId: getCardtransitionsCardToken parameters: - description: Unique identifier of the card. 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 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: 2 data: - barcode: '11379418395311581864' card_product_token: my_cardproduct_01 card_token: my_user_01_card_01 channel: API created_time: 2021-01-12T19:54:12Z expedite: false expiration: '1026' expiration_time: 2026-10-31T23:59:59Z fulfillment_status: ISSUED last_four: '2160' pan: '1111115454542160' pin_is_set: false reason: I do not want to use this card, so suspend it. reason_code: '01' state: SUSPENDED token: suspend_01 type: state.suspended user: metadata: my_name_1: my_value_1 my_name_2: my_value_2 user_token: my_user_01 validations: user: birth_date: true phone: false random_name_line1_postfix: false ssn: false - barcode: '11379418395311581864' card_product_token: my_cardproduct_01 card_token: my_user_01_card_01 channel: API created_time: 2022-02-23T23:28:39Z expedite: false expiration: '1026' expiration_time: 2027-10-31T23:59:59Z fulfillment_status: ISSUED last_four: '2160' pan: '1111115454542160' pin_is_set: false reason: I want to use this card, so activate it. reason_code: '00' state: ACTIVE token: activate_05 type: state.activated user: metadata: my_name_1: my_value_1 my_name_2: my_value_2 user_token: my_user_01 validations: user: birth_date: true phone: false random_name_line1_postfix: false ssn: false end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/CardTransitionListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List transitions for card tags: - Card Transitions /cardtransitions/{token}: get: description: |- Retrieves a specific card transition. This endpoint supports <>. operationId: getCardtransitionsToken parameters: - description: |- Unique identifier of the card transition. Send a `GET` request to `/cardtransitions/card/{token}` to retrieve card transition tokens for a specific card. 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: barcode: '11379418395311581864' card_product_token: my_cardproduct_01 card_token: my_user_01_card_01 channel: API created_time: 2022-02-23T23:28:39Z expedite: false expiration: '1026' expiration_time: 2027-10-31T23:59:59Z fulfillment_status: ISSUED last_four: '2160' pan: '1111115454542160' pin_is_set: false reason: I want to use this card, so activate it. reason_code: '00' state: ACTIVE token: activate_05 type: state.activated user: metadata: my_name_1: my_value_1 my_name_2: my_value_2 user_token: my_user_01 validations: user: birth_date: true phone: false random_name_line1_postfix: false ssn: false 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: Retrieve card transition tags: - Card Transitions /commandomodes: get: description: |- Retrieve a list of Commando Mode control sets. This endpoint supports <> and <>. operationId: getCommandomodes parameters: - description: Number of Commando Mode control sets 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: -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 1 data: - commando_mode_enables: program_funding_source: pgm_funding_src_1 velocity_controls: - vel_control_1 created_time: 2023-02-14T18:48:10Z current_state: channel: SYSTEM commando_enabled: false reason: New Commando Mode created last_modified_time: 2023-02-14T18:48:10Z program_gateway_funding_source_token: pgm_gateway_src_1 token: commando_mode_1 end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/CommandoModeListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List Commando Mode control sets tags: - Commando Mode /commandomodes/transitions/{token}: get: description: Retrieve a specific Commando Mode control set transition. operationId: getCommandomodesTransitionsToken parameters: - description: Unique identifier of the Commando Mode control set transition. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: commando_mode_token: commando_mode_1 created_time: 2023-02-14T18:48:10Z token: commando_mode_1_transition transition: channel: API commando_enabled: true reason: Lost connection user_name: rhowse 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: Retrieve Commando Mode transition tags: - Commando Mode /commandomodes/{commandomode_token}/transitions: get: description: |- Retrieve a list of Commando Mode transitions for a specific control set. This endpoint supports <> and <>. operationId: getCommandomodesCommandomodetokenTransitions parameters: - description: Number of Commando Mode control set 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: |- 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 - description: Unique identifier of the Commando Mode control set. explode: false in: path name: commandomode_token required: true schema: type: string style: simple responses: '200': content: application/json: example: count: 1 data: - commando_mode_token: commando_mode_1 created_time: 2023-02-14T18:48:10Z token: commando_mode_1_transition transition: channel: API commando_enabled: true reason: Lost connection user_name: rhowse end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/CommandoModeTransitionListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List Commando Mode transitions set tags: - Commando Mode /commandomodes/{token}: get: description: Retrieve a specific Commando Mode control set. operationId: getCommandomodesToken parameters: - description: Unique identifier of the Commando Mode control set you want to retrieve. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: commando_mode_enables: program_funding_source: pgm_funding_src_1 velocity_controls: - vel_control_1 created_time: 2023-02-14T18:48:10Z current_state: channel: SYSTEM commando_enabled: false reason: New Commando Mode created last_modified_time: 2023-02-14T18:48:10Z program_gateway_funding_source_token: pgm_gateway_src_1 token: commando_mode_1 schema: $ref: '#/components/schemas/commando_mode_response' description: Success '404': content: { } description: Commando Mode not found '500': content: { } description: Server error summary: Retrieve Commando Mode control set tags: - Commando Mode /credit/accounts: get: description: |- Retrieve an array of credit accounts. This endpoint supports <>. operationId: listAccounts parameters: - description: The 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: 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. *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: 1 data: - activation_time: 2021-08-26T22:55:52.302Z available_credit: 3232 config: billing_cycle_day: 1 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 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 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 summary: List accounts tags: - Credit Accounts post: description: Create a new credit account. operationId: createCreditAccount parameters: [ ] requestBody: content: application/json: example: config: billing_cycle_day: 1 fees: - schedule: - method: FLAT value: 6 type: LATE_PAYMENT_FEE payment_due_day: 31 credit_limit: 1500 credit_product_token: my_credit_product1234 description: Consumer credit account for Jack Smith external_offer_id: my_ext_offer_12 name: Jack Smith's account token: my_account_token_12 usages: - aprs: - schedule: - value: 12 type: GO_TO type: PURCHASE user_token: user1234 schema: $ref: '#/components/schemas/AccountCreateReq' required: true responses: '201': content: application/json: example: activation_time: 2021-08-26T22:55:52.302Z available_credit: 1500 config: billing_cycle_day: 1 fees: - active: true created_date: 2021-09-03T19:06:27.946Z schedule: - effective_date: 2021-09-03T19:06:27.946Z method: FLAT value: 6 type: LATE_PAYMENT_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-09-03T19:06:27.915Z credit_limit: 1500 credit_product_token: my_credit_product1234 currency_code: USD current_balance: 0 description: Consumer credit account for Jack Smith external_offer_id: my_ext_offer_12 latest_statement_cycle_type: TRANSACTING name: Jack Smith's account remaining_min_payment_due: 0 remaining_statement_balance: 0 status: UNACTIVATED token: my_account_token_12 type: CONSUMER updated_time: 2021-09-03T19:06:27.915Z usages: - aprs: - active: true created_date: 2021-09-03T19:06:27.927Z schedule: - effective_date: 2021-09-03T19:06:27.927Z value: 12 type: GO_TO updated_date: 2021-09-03T19:06:27.927Z fees: [ ] type: PURCHASE user_token: user1234 schema: $ref: '#/components/schemas/AccountResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Create account tags: - Credit Accounts /credit/accounts/{account_token}: get: description: Retrieve a credit account. operationId: retrieveAccount parameters: - description: |- The 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 responses: '200': content: application/json: example: activation_time: 2021-08-26T22:55:52.302Z available_credit: 3232 config: billing_cycle_day: 1 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 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 summary: Retrieve account tags: - Credit Accounts put: description: Update a credit account. operationId: updateAccount parameters: - description: |- The 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 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 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 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 summary: Update account tags: - Credit Accounts /credit/accounts/{account_token}/accounttransitions: get: description: |- Retrieve an array of transitions on a credit account. This endpoint supports <>. operationId: listAccountTransitions parameters: - description: |- The 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: 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. *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: 2021-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 summary: List account transitions tags: - Account Transitions post: description: Transition a credit account to a new status. operationId: transitionAccount parameters: - description: |- The 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 summary: Transition account status tags: - Account Transitions /credit/accounts/{account_token}/accounttransitions/{token}: get: description: Retrieve a transition for a credit account. operationId: getAccountTransition parameters: - description: |- The 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: |- The 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 summary: Retrieve account transition tags: - Account Transitions /credit/accounts/{account_token}/adjustments: get: description: |- Retrieve an array of adjustments for a credit account. This endpoint supports <>. operationId: getAdjustmentsByAccount parameters: - description: |- The 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: 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 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 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: 2021-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: 2021-08-01T03:59:59.999Z statement_opening_date: 2021-07-01T04:00:00 statement_token: statement_token_75b token: interest_detail_token1234 updated_date: 2021-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: 2021-07-01T00:27:09Z ledger_entry_token: journal_entry_token1222 notes: string resolved_at: 2021-07-01T00:27:09Z status: ACTIVE token: dispute_token_1234 updated_time: 2021-07-01T00:27:09Z related_detail_token: dispute_token1234 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 summary: List account adjustments tags: - Adjustments post: description: Create an adjustment for an existing credit account. operationId: createAdjustmentForAccount parameters: - description: |- The 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 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: 2022-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 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 /credit/accounts/{account_token}/adjustments/{adjustment_token}: get: description: Retrieve an adjustment for a credit account. operationId: retrieveAdjustment parameters: - description: |- The 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: |- The 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 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 /credit/accounts/{account_token}/cards: get: description: |- Retrieve an array of cards for a credit account. This endpoint supports <>. operationId: getCardsByAccount parameters: - description: |- The 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: The status of the credit cards to return. explode: true in: query name: status required: false schema: type: string x-allowableValues: Valid credit card status 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. *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: 2021-09-03T19:39:53.719Z token: credit_card_token1234 updated_time: 2021-09-03T19:39:53.719Z user_token: user1234 - account_token: my_account_token_13 created_time: 2021-09-13T19:19:51.412Z token: credit_card_token5678 updated_time: 2021-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 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: |- The 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: $ref: '#/components/schemas/CardCreateReq' required: true responses: '201': content: application/json: example: account_token: my_account_token_12 created_time: 2021-09-03T19:39:53.719Z token: my_credit_card_token1234 updated_time: 2021-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 summary: Create account card tags: - Account Cards /credit/accounts/{account_token}/cards/{card_token}: get: description: Retrieve a credit card for a credit account. operationId: getCardByAccount parameters: - description: |- The 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: |- The 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: 2021-09-03T19:39:53.719Z token: my_credit_card_token1234 updated_time: 2021-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 summary: Retrieve account card tags: - Account Cards /credit/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: |- The 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: 2021-07-14T20:17:28Z description: credit balance refund method: CHECK status: COMPLETED token: credit_balance_refund_token1234 updated_time: 2021-07-14T20:17:28Z schema: $ref: '#/components/schemas/AccountCreditBalanceRefundResponse' description: Expected response default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Create balance refund tags: - Balance Refunds /credit/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: 2022-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: 2022-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: 2022-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: 2022-03-01T04:59:59.999Z total_due: 20 current_due: 40 date_account_current: null date_account_delinquent: 2022-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 summary: Retrieve delinquency state tags: - Delinquency /credit/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: The 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: 2022-12-02T23:13:48.281Z is_rolled_back: false oldest_payment_due_date: 2023-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: 2022-12-02T23:13:48.284Z updated_time: 2023-03-28T00:52:17.566Z - account_token: account_token_1 bucket_count: 1 created_time: 2023-03-28T00:52:17.398Z current_due: 231.35 impact_time: 2022-12-01T04:59:59.999Z is_rolled_back: false oldest_payment_due_date: 2022-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: 2023-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 summary: List delinquency state transitions tags: - Delinquency /credit/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 summary: Retrieve delinquency state transition tags: - Delinquency /credit/accounts/{account_token}/disputes: get: description: |- Retrieve an array of disputes on a credit account. This endpoint supports <>. operationId: getDisputesByAccount parameters: - description: |- The 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: 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. *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: 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 summary: List account disputes tags: - Credit Disputes post: description: Create a dispute of a journal entry on a credit account. operationId: createDisputeForAccount parameters: - description: |- The 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: 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 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 Disputes /credit/accounts/{account_token}/disputes/{dispute_token}: get: description: Retrieve a dispute from a credit account. operationId: retrieveDispute parameters: - description: |- The 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: |- The 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: 2021-07-01T00:27:09Z ledger_entry_token: journal_entry_token1222 notes: string resolved_at: 2021-07-01T00:27:09Z status: ACTIVE token: dispute_token_1234 updated_time: 2021-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 summary: Retrieve account dispute tags: - Credit Disputes /credit/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: |- The 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: |- The 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: 2021-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 summary: Update account dispute tags: - Credit Disputes /credit/accounts/{account_token}/documents: get: description: Retrieve an array of documents on a credit account. operationId: getAccountDocuments parameters: - description: |- The 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 summary: List documents tags: - Account Documents /credit/accounts/{account_token}/documents/{document_type}: get: description: Retrieve a specific type of document on a credit account. operationId: getDocumentByAccountAndType parameters: - description: |- The 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 summary: Retrieve document tags: - Account Documents /credit/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: |- The 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: 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. *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 summary: Retrieve document history tags: - Account Documents /credit/accounts/{account_token}/journalentries: get: description: |- Retrieve an array of journal entries on a credit account. This endpoint supports <> and <>. operationId: ListAccountJournalEntries parameters: - description: |- The 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: 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: The 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: The 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: The 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: The 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: The 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: The 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: An 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: |- An 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: enum: - detailObject type: string 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: |- An 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: |- An 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: |- An 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: 2021-08-01T07:00:19.756Z currency_code: USD detail_object: account_token: my_account_token_12 average_daily_balance: 181.67 created_date: 2021-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: 2021-08-01T03:59:59.999Z statement_opening_date: 2021-07-01T04:00:00 statement_token: statement_token_75b token: detail_token_96749 updated_date: 2021-08-01T07:00:19.755Z detail_token: detail_token_96749 group: INTEREST id: '11112222' impact_time: 2021-08-01T03:59:59.999Z memo: Interest charge on purchases request_time: 2021-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: 2021-07-01T07:00:24.240Z currency_code: USD detail_object: account_token: my_account_token_12 amount: 15 created: 2021-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: 2021-07-01T03:59:59.999Z memo: Late payment fee request_time: 2021-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: 2021-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: 2021-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: 2021-09-25T20:59:43Z currency_code: USD funding: amount: 9.11 source: active: true created_time: 2021-06-22T18:41:14Z is_default_account: false last_modified_time: 2021-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: 2021-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: 2021-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: 2021-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: 2021-09-25T20:59:43Z detail_token: detail_token_645736 group: PURCHASE id: '12345678' impact_time: 2021-09-26T11:53:48.228Z memo: SWEET TREATS 0484 related_token: journal_entry_token2460 request_time: 2021-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 summary: List account journal entries tags: - Journal Entries /credit/accounts/{account_token}/journalentries/{journal_entry_token}: get: description: Retrieve a journal entry for a credit account. operationId: getAccountJournalEntry parameters: - description: |- The 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: |- The 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: 2021-07-01T07:00:24.240Z currency_code: USD detail_object: account_token: my_account_token_12 amount: 15 created: 2021-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: 2021-07-01T03:59:59.999Z memo: Late payment fee request_time: 2021-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: 2021-08-01T07:00:19.756Z currency_code: USD detail_object: account_token: my_account_token_12 average_daily_balance: 181.67 created_date: 2021-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: 2021-08-01T03:59:59.999Z statement_opening_date: 2021-07-01T04:00:00 statement_token: statement_token_75b token: detail_token_96749 updated_date: 2021-08-01T07:00:19.755Z detail_token: detail_token_96749 group: INTEREST id: '11112222' impact_time: 2021-08-01T03:59:59.999Z memo: Interest charge on purchases request_time: 2021-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: 2021-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: 2021-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: 2021-09-25T20:59:43Z currency_code: USD funding: amount: 9.11 source: active: true created_time: 2021-06-22T18:41:14Z is_default_account: false last_modified_time: 2021-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: 2021-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: 2021-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: 2021-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: 2021-09-25T20:59:43Z detail_token: detail_token_645736 group: PURCHASE id: '12345678' impact_time: 2021-09-26T11:53:48.228Z memo: SWEET TREATS 0484 related_token: journal_entry_token2460 request_time: 2021-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 summary: Retrieve account journal entry tags: - Journal Entries /credit/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: |- The 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: 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: The starting date of the date range from which to return ledger entries. explode: true in: query name: start_date required: false schema: example: 2019-01-01 format: date type: string x-allowableValues: 'Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ' style: form - description: The ending date of the date range from which to return ledger entries. explode: true in: query name: end_date required: false schema: example: 2019-01-01 format: date type: string x-allowableValues: 'Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ' style: form - description: An 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: A valid ledger entry status style: form - description: The 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: |- An 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: A valid ledger entry group style: form - description: The 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: enum: - detailObject type: string 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: 2021-08-01T07:00:19.756Z currency_code: USD detail_object: account_token: my_account_token_12 average_daily_balance: 181.67 created_date: 2021-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: 2021-08-01T03:59:59.999Z statement_opening_date: 2021-07-01T04:00:00 statement_token: statement_token_75b token: detail_token_96749 updated_date: 2021-08-01T07:00:19.755Z detail_token: detail_token_96749 group: INTEREST id: '11112222' impact_time: 2021-08-01T03:59:59.999Z memo: Interest charge on purchases request_time: 2021-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: 2021-07-01T07:00:24.240Z currency_code: USD detail_object: account_token: my_account_token_12 amount: 15 created: 2021-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: 2021-07-01T03:59:59.999Z memo: Late payment fee request_time: 2021-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: 2021-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: 2021-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: 2021-09-25T20:59:43Z currency_code: USD funding: amount: 9.11 source: active: true created_time: 2021-06-22T18:41:14Z is_default_account: false last_modified_time: 2021-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: 2021-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: 2021-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: 2021-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: 2021-09-25T20:59:43Z detail_token: detail_token_645736 group: PURCHASE id: '12345678' impact_time: 2021-09-26T11:53:48.228Z memo: SWEET TREATS 0484 related_token: ledger_entry_token2460 request_time: 2021-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 summary: List account ledger entries tags: - Ledger Entries /credit/accounts/{account_token}/ledgerentries/{ledger_entry_token}: get: description: Retrieve a ledger entry for a credit account. operationId: getAccountLedgerEntry parameters: - description: |- The 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: |- The 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: 2021-07-01T07:00:24.240Z currency_code: USD detail_object: account_token: my_account_token_12 amount: 15 created: 2021-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: 2021-07-01T03:59:59.999Z memo: Late payment fee request_time: 2021-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: 2021-08-01T07:00:19.756Z currency_code: USD detail_object: account_token: my_account_token_12 average_daily_balance: 181.67 created_date: 2021-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: 2021-08-01T03:59:59.999Z statement_opening_date: 2021-07-01T04:00:00 statement_token: statement_token_75b token: detail_token_96749 updated_date: 2021-08-01T07:00:19.755Z detail_token: detail_token_96749 group: INTEREST id: '11112222' impact_time: 2021-08-01T03:59:59.999Z memo: Interest charge on purchases request_time: 2021-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: 2021-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: 2021-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: 2021-09-25T20:59:43Z currency_code: USD funding: amount: 9.11 source: active: true created_time: 2021-06-22T18:41:14Z is_default_account: false last_modified_time: 2021-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: 2021-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: 2021-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: 2021-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: 2021-09-25T20:59:43Z detail_token: detail_token_645736 group: PURCHASE id: '12345678' impact_time: 2021-09-26T11:53:48.228Z memo: SWEET TREATS 0484 related_token: ledger_entry_token2460 request_time: 2021-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 summary: Retrieve account ledger entry tags: - Ledger Entries /credit/accounts/{account_token}/payments: get: description: |- Retrieve an array of payments on a credit account. This endpoint supports <>. operationId: listPayments parameters: - description: |- The 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: 2019-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: 2019-01-01 format: date type: string 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. *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: An 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: 2022-01-31T15:03:09.717Z currency_code: USD description: Account statement payment hold_days: 1 hold_end_time: 2022-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: 2022-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: 2022-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: 2022-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: 2022-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: 2022-01-31T15:03:09.723Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: INITIATED token: 64ca6c83-937c-4d37-86ae-14766bf87540 updated_time: 2022-02-03T12:00:30.072Z - account_token: my_account_token_12 amount: 25 created_time: 2021-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: 2021-09-03T23:03:05.683Z payment_token: my_payment_25 status: COMPLETED token: my_transition_token1234 updated_time: 2021-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 summary: List account payments tags: - Payments post: description: Create a new payment to apply toward a credit account's balance. operationId: createPayment parameters: - description: |- The 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: 2022-01-31T15:03:09.717Z currency_code: USD description: Account statement payment hold_days: 1 hold_end_time: 2022-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: 2022-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: 2022-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: 2022-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: 2022-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: 2022-01-31T15:03:09.723Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: INITIATED token: 64ca6c83-937c-4d37-86ae-14766bf87540 updated_time: 2022-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 summary: Create account payment tags: - Payments /credit/accounts/{account_token}/payments/{payment_token}: get: description: Retrieve a payment for a credit account. operationId: retrievePayment parameters: - description: |- The 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: |- The 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: 2022-01-31T15:03:09.717Z currency_code: USD description: Account statement payment hold_days: 1 hold_end_time: 2022-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: 2022-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: 2022-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: 2022-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: 2022-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: 2022-01-31T15:03:09.723Z payment_token: 4749ab00-fec1-471c-ac5b-b8d31d06d7e4 status: INITIATED token: 64ca6c83-937c-4d37-86ae-14766bf87540 updated_time: 2022-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 summary: Retrieve account payment tags: - Payments /credit/accounts/{account_token}/payments/{payment_token}/releasehold: post: description: Manually release a payment hold on a credit account. operationId: releasePaymentHold parameters: - description: |- The 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: |- The 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: 2021-09-09T22:42:35.065Z currency_code: USD description: minimum payment hold_days: 5 hold_end_time: 2021-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: 2021-09-09T22:42:35.068Z payment_token: my_payment_25 status: COMPLETED token: my_transition_token1234 updated_time: 2021-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 summary: Release payment hold tags: - Payments /credit/accounts/{account_token}/payments/{payment_token}/transitions: post: description: Transition a credit account payment's status to a new status. operationId: transitionPayment parameters: - description: |- The 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: |- The 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 summary: Transition account payment status tags: - Payments /credit/accounts/{account_token}/paymentschedules: get: description: |- Retrieve an array of payment schedules on a specific credit account. This endpoint supports <>. operationId: retrievePaymentSchedules parameters: - description: |- The 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: The 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 `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: 2022-08-22T22:17:11.407Z currency_code: USD description: Sample payoff frequency: MONTHLY next_payment_impact_date: 2022-08-31 payment_day: PAYMENT_DUE_DAY payment_source_token: source1 status: ACTIVE token: mytoken updated_time: 2022-08-22T22:17:11.407Z - account_token: account1 amount: 100 amount_category: FIXED created_time: 2022-07-22T22:13:31.426Z currency_code: USD description: Sample payment frequency: ONCE next_payment_impact_date: 2022-08-10 payment_day: PAYMENT_DUE_DAY payment_source_token: source1 status: COMPLETED token: mytoken1 updated_time: 2022-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 summary: List payment schedules tags: - Payment Schedules post: description: Create a new payment schedule, either one-time or recurring. operationId: createPaymentSchedule parameters: - description: |- The 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: 2022-01-12T15:03:09.717Z currency_code: USD description: Scheduled account payment frequency: ONCE next_payment_impact_date: 2022-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 summary: Create payment schedule tags: - Payment Schedules /credit/accounts/{account_token}/paymentschedules/{payment_schedule_token}: get: description: Retrieve a single payment schedule on a specific credit account. operationId: retrievePaymentSchedule parameters: - description: |- The 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: |- The 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: 2022-01-12T15:03:09.717Z currency_code: USD description: Scheduled account payment frequency: ONCE next_payment_impact_date: 2022-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 summary: Retrieve payment schedule tags: - Payment Schedules /credit/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: |- The 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: |- The 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: The 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 `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: 2022-08-23T11:25:34.342Z payment_schedule_token: payment1 status: TERMINATED token: transition1 updated_time: 2022-08-23T11:25:34.342Z - account_token: account2 created_time: 2022-08-22T22:17:11.407Z payment_schedule_token: payment2 status: ACTIVE token: transition2 updated_time: 2022-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 summary: Retrieve payment schedule transitions tags: - Payment Schedules post: description: Transition a payment schedule to a new status. operationId: createPaymentScheduleTransition parameters: - description: |- The 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: |- The 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: 2022-01-12T15:03:09.717Z payment_schedule_token: payment_schedule_token_1232 status: TERMINATED token: payment_schedule_transition_token_111 updated_time: 2022-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 summary: Create payment schedule transition tags: - Payment Schedules /credit/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: |- The 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: |- The 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: |- The 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: 2022-08-22T22:17:11.407Z payment_schedule_token: payment1 status: ACTIVE token: transition2 updated_time: 2022-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 summary: Retrieve payment schedule transition tags: - Payment Schedules /credit/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: 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 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 summary: Get all active and upcoming periodic fee schedules of an account tags: - Account /credit/accounts/{account_token}/rewards: post: description: Create a reward for an existing credit account. operationId: createReward parameters: - description: |- The 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: 2021-09-03T22:53:57.895Z currency_code: USD description: $20 reward token: my_rewards_token1234 type: CASH_BACK updated_time: 2021-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: 2021-09-03T22:53:57.895Z currency_code: USD description: $20 reward token: my_rewards_token1234 type: CASH_BACK updated_time: 2021-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 summary: Create account reward tags: - Account Rewards /credit/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: |- The 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: 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. *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: 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 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 summary: List account statement summaries tags: - Statements /credit/accounts/{account_token}/statements/files: get: description: Retrieve an array of statement files for a specific credit account. operationId: getStatementFilesByAccount parameters: - description: |- The 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: The start date of the statement files to return. explode: true in: query name: start_date required: false schema: example: 2020-01-01T00:00:00Z format: date-time type: string style: form - description: The end date of the statement files to return. explode: true in: query name: end_date required: false schema: example: 2020-03-01T03:59:59Z format: date-time type: string 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. *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: 2021-07-31T00:27:09 opening_date: 2021-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: 2021-06-30T00:27:09 opening_date: 2021-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 summary: List files for an account tags: - Statements /credit/accounts/{account_token}/statements/{statement_summary_token}: get: description: Retrieve a statement summary for a credit account. operationId: retrieveStatementSummary parameters: - description: |- The 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: |- The 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 summary: Retrieve account statement summary tags: - Statements /credit/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: |- The 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: |- The 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: The 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: 2021-07-31T00:27:09 opening_date: 2021-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 summary: List files for a statement summary tags: - Statements /credit/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: |- The 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: |- The 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 summary: Retrieve account statement interest charges tags: - Statements /credit/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: |- The 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: |- The 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: Specifies the number of journal entries to return. explode: true in: query name: count required: false schema: default: 5 maximum: 100 minimum: 1 type: integer style: form - description: Specifies the sort order index from which to begin returning journal entries. 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: enum: - detailObject type: string 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: 2021-08-01T07:00:19.756Z currency_code: USD detail_object: account_token: my_account_token_12 average_daily_balance: 181.67 created_date: 2021-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: 2021-08-01T03:59:59.999Z statement_opening_date: 2021-07-01T04:00:00 statement_token: statement_token_75b token: detail_token_96749 updated_date: 2021-08-01T07:00:19.755Z detail_token: detail_token_96749 group: INTEREST id: '11112222' impact_time: 2021-08-01T03:59:59.999Z memo: Interest charge on purchases request_time: 2021-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: 2021-07-01T07:00:24.240Z currency_code: USD detail_object: account_token: my_account_token_12 amount: 15 created: 2021-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: 2021-07-01T03:59:59.999Z memo: Late payment fee request_time: 2021-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: 2021-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: 2021-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: 2021-09-25T20:59:43Z currency_code: USD funding: amount: 9.11 source: active: true created_time: 2021-06-22T18:41:14Z is_default_account: false last_modified_time: 2021-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: 2021-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: 2021-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: 2021-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: 2021-09-25T20:59:43Z detail_token: detail_token_645736 group: PURCHASE id: '12345678' impact_time: 2021-09-26T11:53:48.228Z memo: SWEET TREATS 0484 related_token: journal_entry_token2460 request_time: 2021-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 summary: List account statement journal entries tags: - Statements /credit/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: |- The 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: |- The 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: enum: - detailObject type: string 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: 2021-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: 2021-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: 2021-09-25T20:59:43Z currency_code: USD funding: amount: 9.11 source: active: true created_time: 2021-06-22T18:41:14Z is_default_account: false last_modified_time: 2021-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: 2021-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: 2021-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: 2021-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: 2021-09-25T20:59:43Z detail_token: detail_token_645736 group: PURCHASE id: '12345678' impact_time: 2021-09-26T11:53:48.228Z memo: SWEET TREATS 0484 related_token: ledger_entry_token2460 request_time: 2021-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 summary: List account statement ledger entries tags: - Statements /credit/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: |- The 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: |- The 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 summary: Retrieve account statement payment information tags: - Statements /credit/accounts/{account_token}/statements/{statement_summary_token}/rewards: get: description: Retrieve the rewards on a credit account's statement summary. operationId: retrieveStatementReward parameters: - description: |- The 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: |- The 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 summary: Retrieve account statement rewards tags: - Statements /credit/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: |- The 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: |- The 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 summary: Retrieve account statement year-to-date totals tags: - Statements /credit/applications: post: description: Create a new application. parameters: [ ] requestBody: content: application/json: example: any_non_taxable_income: false bundle_token: bundle_token_1111 e_disclosure_tracking_token: tracking_token_X3NoybmxsEtQ0mZ monthly_mortgage_or_rent: 1200 prequalified_offer_pre_terms_tracking_token: tracking_token_D0VufJpbGZhdC primary_income_source: SELF_EMPLOYED privacy_policy_tracking_token: tracking_token_ImlzcyI6ImxJQ1k residence_type: OWN rewards_disclosure_pre_terms_tracking_token: tracking_token_ZjNmZ0MzIyNDYs soct_tracking_token: tracking_token_HAiOjE2Y1Nri3fPDg token: application_token_1111 total_annual_income: 95000 user_token: user_token_1111 schema: $ref: '#/components/schemas/CreateApplicationsRequest' required: false responses: '201': content: application/json: example: account_token: account_token_1111 any_non_taxable_income: false bundle_token: bundle_token_1111 created_date: 2022-07-07T19:47:46.268Z decision_token: decision_token_1111 e_disclosure_accepted_at: 2022-07-07T19:47:46.184Z monthly_mortgage_or_rent: 1200 primary_income_source: SELF_EMPLOYED privacy_policy_accepted_at: 2022-07-07T19:47:46.188Z residence_type: OWN rewards_disclosure_pre_terms_accepted_at: 2022-07-07T19:47:46.187Z soct_accepted_at: 2022-07-07T19:47:46.181Z state: CREATED token: application_token_1111 total_annual_income: 95000 type: CREDIT_DECISION updated_date: 2022-07-07T19:47:46.268Z user_token: user_token_1111 schema: $ref: '#/components/schemas/ApplicationsResponse' 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 application tags: - Applications /credit/applications/files: get: description: |- Retrieve an array of files on a bundle or application Each top-level object returned in the array contains the fields documented in the <>. The name of each object is its corresponding file type: * `BENEFITS_DISCLOSURE` * `CARD_MEMBER_AGREEMENT` * `E_DISCLOSURE` * `NOAA` * `PRIVACY_POLICY` * `REWARDS_DISCLOSURE_PRE_TERMS` * `REWARDS_DISCLOSURE_POST_TERMS` * `SOCT` * `TERMS_SCHEDULE` operationId: retrieveFiles parameters: - description: |- Unique identifier of the bundle whose files you want to retrieve. The following file types are returned with the `bundle_token`: * `CARD_MEMBER_AGREEMENT` * `E_DISCLOSURE` * `PRIVACY_POLICY` * `REWARDS_DISCLOSURE_PRE_TERMS` * `REWARDS_DISCLOSURE_POST_TERMS` * `SOCT` explode: true in: query name: bundle_token required: false schema: type: string x-allowableValues: Existing bundle token style: form - description: |- Unique identifier of the application whose files you want to retrieve. The following file types are returned with the `application_token`: * `BENEFITS_DISCLOSURE` * `CARD_MEMBER_AGREEMENT` * `E_DISCLOSURE` * `NOAA` * `PRIVACY_POLICY` * `REWARDS_DISCLOSURE_PRE_TERMS` * `REWARDS_DISCLOSURE_POST_TERMS` * `SOCT` * `TERMS_SCHEDULE` explode: true in: query name: application_token required: false schema: type: string x-allowableValues: Existing application token style: form responses: '200': content: application/json: examples: application_token_example: summary: |- The following code block shows the files returned on an application if the application is approved. The name of each top-level object is its corresponding file type. value: BENEFITS_DISCLOSURE: file_type: BENEFITS_DISCLOSURE links: html: https://url.com/link_to_html_file json: https://url.com/link_to_json_file pdf: https://url.com/link_to_pdf_file tracking_token: tracking_token_yIxO2NvZY4YjEiLCJzi1lNTB CARD_MEMBER_AGREEMENT: file_type: CARD_MEMBER_AGREEMENT links: html: https://url.com/link_to_html_file json: https://url.com/link_to_json_file pdf: https://url.com/link_to_pdf_file tracking_token: tracking_token_c1YjY2NjBlOGEiLCJzdGF0Z E_DISCLOSURE: file_type: E_DISCLOSURE links: html: https://url.com/link_to_html_file json: https://url.com/link_to_json_file pdf: https://url.com/link_to_pdf_file PRIVACY_POLICY: file_type: PRIVACY_POLICY links: html: https://url.com/link_to_html_file json: https://url.com/link_to_json_file pdf: https://url.com/link_to_pdf_file REWARDS_DISCLOSURE_POST_TERMS: file_type: REWARDS_DISCLOSURE_POST_TERMS links: html: https://url.com/link_to_html_file json: https://url.com/link_to_json_file pdf: https://url.com/link_to_pdf_file tracking_token: tracking_token_eyJraWQiOiJtODVlYS1I6I REWARDS_DISCLOSURE_PRE_TERMS: file_type: REWARDS_DISCLOSURE_PRE_TERMS links: html: https://url.com/link_to_html_file json: https://url.com/link_to_json_file pdf: https://url.com/link_to_pdf_file SOCT: file_type: SOCT links: html: https://url.com/link_to_html_file json: https://url.com/link_to_json_file pdf: https://url.com/link_to_pdf_file TERMS_SCHEDULE: file_type: TERMS_SCHEDULE links: html: https://url.com/link_to_html_file json: https://url.com/link_to_json_file pdf: https://url.com/link_to_pdf_file tracking_token: tracking_token_e4MjgtnaCIsyIJTkciLCJ0e bundle_token_example: summary: |- The following code block shows the files returned on a bundle. The name of each top-level object is its corresponding file type. value: CARD_MEMBER_AGREEMENT: file_type: CARD_MEMBER_AGREEMENT links: html: https://url.com/link_to_html_file json: https://url.com/link_to_json_file pdf: https://url.com/link_to_pdf_file tracking_token: tracking_token_c1YjY2NjBlOGEiLCJzdGF0Z E_DISCLOSURE: file_type: E_DISCLOSURE links: html: https://url.com/link_to_html_file json: https://url.com/link_to_json_file pdf: https://url.com/link_to_pdf_file tracking_token: tracking_token_X3NoybmxnaCIsEtQ0mZpbGZ PRIVACY_POLICY: file_type: PRIVACY_POLICY links: html: https://url.com/link_to_html_file json: https://url.com/link_to_json_file pdf: https://url.com/link_to_pdf_file tracking_token: tracking_token_ImlzcyI6ImxJQ1kiLD0VufJ REWARDS_DISCLOSURE_POST_TERMS: file_type: REWARDS_DISCLOSURE_POST_TERMS links: html: https://url.com/link_to_html_file json: https://url.com/link_to_json_file pdf: https://url.com/link_to_pdf_file tracking_token: tracking_token_eyJraWQiOiJtODVlYS1I6I REWARDS_DISCLOSURE_PRE_TERMS: file_type: REWARDS_DISCLOSURE_PRE_TERMS links: html: https://url.com/link_to_html_file json: https://url.com/link_to_json_file pdf: https://url.com/link_to_pdf_file tracking_token: tracking_token_ZjNmZ0MzIyNDYsImlhdCI6M SOCT: file_type: SOCT links: html: https://url.com/link_to_html_file json: https://url.com/link_to_json_file pdf: https://url.com/link_to_pdf_file tracking_token: tracking_token_HAiOjE2Y1NzIyMjYri3fPDg schema: $ref: '#/components/schemas/fileMapResponse' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: File does not exist '500': content: { } description: Server error summary: List files on a bundle or application tags: - Applications /credit/applications/files/{type}: get: description: Retrieve a specific type of file on a bundle or application. operationId: getFileByType parameters: - description: |- The type of file to retrieve. * `SOCT` - The Summary of Credit Terms (SOCT), which outlines the interest rates, interest charges, and fees associated with the credit account being offered to the user. * `REWARDS_DISCLOSURE_PRE_TERMS` - The Rewards Disclosure Pre-terms, which discloses detailed information about the rewards program on the credit account being offered to the user before a decision is rendered on their application. * `REWARDS_DISCLOSURE_POST_TERMS` - The Rewards Disclosure Post-terms, which discloses detailed information about the rewards program on the user's credit account if their application is approved. * `BENEFITS_DISCLOSURE` - The Benefits Disclosure, which which is given to a user if their application is approved and discloses detailed information about the benefits on the user's credit account. * `CARD_MEMBER_AGREEMENT` - The Card Member Agreement, which specifies the terms and conditions of the user's credit account, including the interest rates, interest charges, fees, minimum payment calculations, and more. * `PRIVACY_POLICY` - The Privacy Policy, which explains how the information on the user's application is collected, handled, and processed. * `E_DISCLOSURE` - The eDisclosure, which states that the user has agreed to receive disclosures electronically. * `TERMS_SCHEDULE` - The Terms Schedule, which is given to a user if their application is approved and specifies the interest rate details on the user's credit account. * `NOAA` - The Notice of Adverse Action (NOAA), which is given to a user if their application is declined and informs them of the specific reasons why they were denied a credit account. explode: false in: path name: type required: true schema: $ref: '#/components/schemas/FileType' style: simple - description: |- Unique identifier of the bundle on which you want to retrieve a file. Required if retrieving one of the following file types: * `CARD_MEMBER_AGREEMENT` * `E_DISCLOSURE` * `PRIVACY_POLICY` * `REWARDS_DISCLOSURE_PRE_TERMS` * `REWARDS_DISCLOSURE_POST_TERMS` * `SOCT` explode: true in: query name: bundle_token required: false schema: type: string x-allowableValues: Existing bundle token style: form - description: |- Unique identifier of the application on which you want to retrieve a file. Required if retrieving one of the following files: * `BENEFITS_DISCLOSURE` * `NOAA` * `TERMS_SCHEDULE` explode: true in: query name: application_token required: false schema: type: string x-allowableValues: Existing application token style: form responses: '200': content: application/json: example: file_type: NOAA links: html: https://url.com/link_to_html_file json: https://url.com/link_to_json_file pdf: https://url.com/link_to_pdf_file tracking_token: tracking_token_Cf7xNsl6vGtHn%2BcTH96zdf schema: $ref: '#/components/schemas/FileResponse' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: File does not exist '500': content: { } description: Server error summary: Retrieve file on a bundle or application tags: - Applications /credit/applications/{token}: get: description: Retrieve a specific application. operationId: retrieveApplication parameters: - description: Unique identifier of the application to retrieve. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing application token style: simple - description: Embeds the specified object into the response. explode: true in: query name: expand required: false schema: items: $ref: '#/components/schemas/ExpandObjects' type: array style: form responses: '200': content: application/json: example: account_token: account_token_1111 any_non_taxable_income: false bundle_token: bundle_token_1111 created_date: 2022-07-07T19:47:46Z decision_model: application_token: 0467ff1b-798a-492a-a743-f490a3ccd892 card_product_level: TRADITIONAL created_date: 2022-07-07T19:47:47Z credit_bureau: address: address1: 2 Baldwin Place address2: P.O. Box 1000 city: Chester state: PA zip: '19016' name: TransUnion Customer Relations phone_number: 1-800-888-4213 website: www.transunion.com credit_limit: 15000 credit_score: 821 credit_score_date: 2022-07-07 decision_date: 2022-07-07T00:00:00Z decision_id: ee7325e7-d13e-40db-8498-a784b76adc7d denial_reasons: - '[]' margin: 20 prime_rate: 3.25 purchase_apr: 23.25 received_best_rate: false score_factors: - '[TOO FEW ACCOUNTS CURRENTLY PAID AS AGREED' - ' LACK OF RECENT INSTALLMENT LOAN INFORMATION' - ' TOO MANY ACCOUNTS WITH BALANCES' - ' LENGTH OF TIME REVOLVING ACCOUNTS HAVE BEEN ESTABLISHED]' score_range: 300-850 status: APPROVED submitted_date_time: 2022-07-07T19:47:47Z token: b660b53c-0971-4ca2-b2cf-fc8739e860da user_token: user_token_1111 decision_token: decision_token_1111 e_disclosure_accepted_at: 2022-07-07T19:47:46Z monthly_mortgage_or_rent: 1200 primary_income_source: SELF_EMPLOYED privacy_policy_accepted_at: 2022-07-07T19:47:46Z residence_type: OWN rewards_disclosure_pre_terms_accepted_at: 2022-07-07T19:47:46Z soct_accepted_at: 2022-07-07T19:47:46Z state: APPROVED token: application_token_1111 total_annual_income: 95000 type: CREDIT_DECISION updated_date: 2022-07-07T19:48:16Z user_token: user_token_1111 schema: $ref: '#/components/schemas/ApplicationsResponse' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Application does not exist '500': content: { } description: Server error summary: Retrieve application tags: - Applications /credit/applications/{token}/transitions: get: description: Retrieve an array of transitions on a specific application. operationId: pageApplicationTransitions parameters: - description: The unique identifier of the application for which you want to retrieve transitions. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing application token style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/ApplicationsTransitionPage' description: Success '404': content: { } description: Application does not exist. '500': content: { } description: Server error summary: List application transitions tags: - Applications post: description: Transition the current state of an application to a new state. operationId: transitionApplication parameters: - description: Unique identifier of the application whose state you want to transition. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing application token style: simple requestBody: content: application/json: example: application_state: ACCEPTED benefits_disclosure_tracking_token: tracking_token_JXRapWJL2BI4EwdNqjBBvpI5 card_member_agreement_tracking_token: tracking_token_c1YjY2NjBlOGEiLCJzdGF0Z rewards_disclosure_post_terms_tracking_token: tracking_token_ZjNmZ0MzIyNDYsImlhdCI terms_schedule_tracking_token: tracking_token_CpkwJCoqzucVnJNwj5BsKC9e5 schema: $ref: '#/components/schemas/ApplicationTransitionRequest' required: true responses: '200': content: application/json: example: application_token: application_token_1111 created_time: 2019-08-24T14:15:22Z original_status: APPROVED status: ACCEPTED token: app_state_transition_token_1111 schema: $ref: '#/components/schemas/ApplicationTransitionResponse' description: Successful application transition. '400': content: { } description: User input error/Bad request/Invalid Ack Token '404': content: { } description: Application does not exist '500': content: { } description: Server error summary: Transition application state tags: - Applications /credit/bundles: get: description: |- Retrieve an array of bundles. This endpoint supports <>. operationId: listBundles parameters: - 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. *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: 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: 2022-04-01T23:41:58.802Z description: A golden APR policy effective_date: 2022-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: 2022-04-05T16:04:48.643Z apr_policy_token: my_apr_policy_token_1234 created_time: 2022-04-01T23:41:58.802Z credit_product_policy_detail: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER created_time: 2022-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A golden 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: 2022-04-05T16:04:48.643Z usage: - PURCHASE credit_product_policy_token: my_credit_product_policy_token_1234 description: A golden 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: 2022-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: 2022-04-05T16:04:48.643Z document_policy_token: my_document_policy_token_1234 fee_policy_detail: account: late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2022-04-01T23:41:58.802Z description: A golden fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z fee_policy_token: my_fee_policy_token_1234 name: Gold Credit Bundle offer_policy_detail: created_time: 2022-04-01T23:41:58.802Z description: A golden offer policy name: Gold Offer Policy token: my_offer_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z offer_policy_token: my_offer_policy_token_1234 parent_token: my_parent_token_1234 reward_policy_detail: created_time: 2022-04-01T23:41:58.802Z description: A golden reward policy name: Gold Reward Policy rules: - filters: amount: greater_than: 1 less_than: 10 mcc_dynamic: includes: - HIGHEST_SPEND outcome: max_amount: 100 percentage: 20 type: CASHBACK token: my_reward_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z reward_policy_token: my_reward_policy_token_1234 status: DRAFT token: my_bundle_token_1234 updated_time: 2022-04-05T16:04:48.643Z - apr_policy_detail: created_time: 2022-04-01T23:41:58.802Z description: A silver APR policy effective_date: 2022-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: 2022-04-05T16:04:48.643Z apr_policy_token: my_apr_policy_token_4321 created_time: 2022-04-01T23:41:58.802Z credit_product_policy_detail: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token4321 classification: CONSUMER created_time: 2022-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: 2022-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: 2022-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: 2022-04-05T16:04:48.643Z document_policy_token: my_document_policy_token_4321 fee_policy_detail: account: late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2022-04-01T23:41:58.802Z description: A silver fee policy name: Silver Fee Policy token: my_fee_policy_token_4321 updated_time: 2022-04-05T16:04:48.643Z fee_policy_token: my_fee_policy_token_4321 name: Silver Credit Bundle offer_policy_detail: created_time: 2022-04-01T23:41:58.802Z description: A silver offer policy name: Silver Offer Policy token: my_offer_policy_token_4321 updated_time: 2022-04-05T16:04:48.643Z offer_policy_token: my_offer_policy_token_4321 parent_token: my_parent_token_4321 reward_policy_detail: created_time: 2022-04-01T23:41:58.802Z description: A silver reward policy name: Silver Reward Policy rules: - filters: amount: greater_than: 1 less_than: 10 mcc_dynamic: includes: - HIGHEST_SPEND outcome: max_amount: 100 percentage: 20 type: CASHBACK token: my_reward_policy_token_4321 updated_time: 2022-04-05T16:04:48.643Z reward_policy_token: my_reward_policy_token_4321 status: DRAFT token: my_bundle_token_4321 updated_time: 2022-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 summary: List bundles tags: - Bundles (Beta) 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 golden 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: 2022-04-01T23:41:58.802Z description: A golden APR policy effective_date: 2022-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: 2022-04-05T16:04:48.643Z apr_policy_token: my_apr_policy_token_1234 created_time: 2022-04-01T23:41:58.802Z credit_product_policy_detail: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER created_time: 2022-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A golden 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: 2022-04-05T16:04:48.643Z usage: - PURCHASE credit_product_policy_token: my_credit_product_policy_token_1234 description: A golden 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: 2022-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: 2022-04-05T16:04:48.643Z document_policy_token: my_document_policy_token_1234 fee_policy_detail: account: late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2022-04-01T23:41:58.802Z description: A golden fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z fee_policy_token: my_fee_policy_token_1234 name: Gold Credit Bundle offer_policy_detail: created_time: 2022-04-01T23:41:58.802Z description: A golden offer policy name: Gold Offer Policy token: my_offer_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z offer_policy_token: my_offer_policy_token_1234 parent_token: my_parent_token_1234 reward_policy_detail: created_time: 2022-04-01T23:41:58.802Z description: A golden reward policy name: Gold Reward Policy rules: - filters: amount: greater_than: 1 less_than: 10 mcc_dynamic: includes: - HIGHEST_SPEND outcome: max_amount: 100 percentage: 20 type: CASHBACK token: my_reward_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z reward_policy_token: my_reward_policy_token_1234 status: DRAFT token: my_bundle_token_1234 updated_time: 2022-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 summary: Create bundle tags: - Bundles (Beta) /credit/bundles/{token}: get: description: Retrieve a specific bundle. operationId: retrieveBundle parameters: - description: |- The 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: 2022-04-01T23:41:58.802Z description: A golden APR policy effective_date: 2022-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: 2022-04-05T16:04:48.643Z apr_policy_token: my_apr_policy_token_1234 created_time: 2022-04-01T23:41:58.802Z credit_product_policy_detail: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER created_time: 2022-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A golden 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: 2022-04-05T16:04:48.643Z usage: - PURCHASE credit_product_policy_token: my_credit_product_policy_token_1234 description: A golden 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: 2022-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: 2022-04-05T16:04:48.643Z document_policy_token: my_document_policy_token_1234 fee_policy_detail: account: late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2022-04-01T23:41:58.802Z description: A golden fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z fee_policy_token: my_fee_policy_token_1234 name: Gold Credit Bundle offer_policy_detail: created_time: 2022-04-01T23:41:58.802Z description: A golden offer policy name: Gold Offer Policy token: my_offer_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z offer_policy_token: my_offer_policy_token_1234 parent_token: my_parent_token_1234 reward_policy_detail: created_time: 2022-04-01T23:41:58.802Z description: A golden reward policy name: Gold Reward Policy rules: - filters: amount: greater_than: 1 less_than: 10 mcc_dynamic: includes: - HIGHEST_SPEND outcome: max_amount: 100 percentage: 20 type: CASHBACK token: my_reward_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z reward_policy_token: my_reward_policy_token_1234 status: DRAFT token: my_bundle_token_1234 updated_time: 2022-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 summary: Retrieve bundle tags: - Bundles (Beta) 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 is immutable, and 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: 2022-04-01T23:41:58.802Z description: A golden APR policy effective_date: 2022-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: 2022-04-05T16:04:48.643Z apr_policy_token: my_apr_policy_token_1234 created_time: 2022-04-01T23:41:58.802Z credit_product_policy_detail: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER created_time: 2022-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A golden 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: 2022-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: 2022-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: 2022-04-05T16:04:48.643Z document_policy_token: my_document_policy_token_1234 fee_policy_detail: account: late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2022-04-01T23:41:58.802Z description: A golden fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z fee_policy_token: my_fee_policy_token_1234 name: Renamed Bundle offer_policy_detail: created_time: 2022-04-01T23:41:58.802Z description: A golden offer policy name: Gold Offer Policy token: my_offer_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z offer_policy_token: my_offer_policy_token_1234 parent_token: my_parent_token_1234 reward_policy_detail: created_time: 2022-04-01T23:41:58.802Z description: A golden reward policy name: Gold Reward Policy rules: - filters: amount: greater_than: 1 less_than: 10 mcc_dynamic: includes: - HIGHEST_SPEND outcome: max_amount: 100 percentage: 20 type: CASHBACK token: my_reward_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z reward_policy_token: my_reward_policy_token_1234 status: DRAFT token: my_bundle_token_1234 updated_time: 2022-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 summary: Update bundle tags: - Bundles (Beta) /credit/bundles/{token}/clone: post: description: Create a new bundle based on an existing bundle. operationId: cloneBundle parameters: - description: |- The 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: 2022-04-01T23:41:58.802Z description: A golden APR policy effective_date: 2022-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: 2022-04-05T16:04:48.643Z apr_policy_token: my_apr_policy_token_1234 created_time: 2022-04-01T23:41:58.802Z credit_product_policy_detail: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token1234 classification: CONSUMER created_time: 2022-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A golden 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: 2022-04-05T16:04:48.643Z usage: - PURCHASE credit_product_policy_token: my_credit_product_policy_token_1234 description: A golden 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: 2022-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: 2022-04-05T16:04:48.643Z document_policy_token: my_document_policy_token_1234 fee_policy_detail: account: late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2022-04-01T23:41:58.802Z description: A golden fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z fee_policy_token: my_fee_policy_token_1234 name: Gold Credit Bundle offer_policy_detail: created_time: 2022-04-01T23:41:58.802Z description: A golden offer policy name: Gold Offer Policy token: my_offer_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z offer_policy_token: my_offer_policy_token_1234 parent_token: my_parent_token_1234 reward_policy_detail: created_time: 2022-04-01T23:41:58.802Z description: A golden reward policy name: Gold Reward Policy rules: - filters: amount: greater_than: 1 less_than: 10 mcc_dynamic: includes: - HIGHEST_SPEND outcome: max_amount: 100 percentage: 20 type: CASHBACK token: my_reward_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z reward_policy_token: my_reward_policy_token_1234 status: DRAFT token: my_bundle_token_1234 updated_time: 2022-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 summary: Clone bundle tags: - Bundles (Beta) /credit/bundles/{token}/lineage: get: description: |- Retrieve an array of related product bundles. This endpoint supports <>. operationId: listRelatedBundles parameters: - description: |- The 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: 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. *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: 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: schema: $ref: '#/components/schemas/BundleResponsePage' description: Expected response to a valid request default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: List related bundles tags: - Bundles (Beta) /credit/bundles/{token}/promote: put: description: Promote a specific bundle, which replaces the current active bundle and activates the promoted bundle. operationId: promoteBundle parameters: - description: |- The 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: 2022-04-01T23:41:58.802Z description: A silver APR policy effective_date: 2022-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: 2022-04-05T16:04:48.643Z apr_policy_token: my_apr_policy_token_4321 created_time: 2022-04-01T23:41:58.802Z credit_product_policy_detail: card_products: - level: TRADITIONAL network: VISA token: my_card_product_token4321 classification: CONSUMER created_time: 2022-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: 2022-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: 2022-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: 2022-04-05T16:04:48.643Z document_policy_token: my_document_policy_token_4321 fee_policy_detail: account: late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2022-04-01T23:41:58.802Z description: A silver fee policy name: Silver Fee Policy token: my_fee_policy_token_4321 updated_time: 2022-04-05T16:04:48.643Z fee_policy_token: my_fee_policy_token_4321 name: Silver Credit Bundle offer_policy_detail: created_time: 2022-04-01T23:41:58.802Z description: A silver offer policy name: Silver Offer Policy token: my_offer_policy_token_4321 updated_time: 2022-04-05T16:04:48.643Z offer_policy_token: my_offer_policy_token_4321 parent_token: my_parent_token_4321 reward_policy_detail: created_time: 2022-04-01T23:41:58.802Z description: A silver reward policy name: Silver Reward Policy rules: - filters: amount: greater_than: 1 less_than: 10 mcc_dynamic: includes: - HIGHEST_SPEND outcome: max_amount: 100 percentage: 20 type: CASHBACK token: my_reward_policy_token_4321 updated_time: 2022-04-05T16:04:48.643Z reward_policy_token: my_reward_policy_token_4321 status: DRAFT token: my_bundle_token_4321 updated_time: 2022-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 summary: Promote bundle tags: - Bundles (Beta) /credit/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: 2022-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 summary: Transition a bundle tags: - Bundles (Beta) /credit/paymentsources: get: description: |- Retrieve an array of payment sources. This endpoint supports <>. operationId: listPaymentSources parameters: - description: The 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: The 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: 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. *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: 1 data: - account_suffix: '5678' account_token: my_account_token_12 created_time: 2021-05-19T19:19:24Z last_modified_time: 2021-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 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: 2021-05-19T19:19:24Z last_modified_time: 2021-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 summary: Create payment source tags: - Payment Sources /credit/paymentsources/{token}: get: description: Retrieve a payment source. operationId: retrievePaymentSource parameters: - description: |- The 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: 2021-05-19T19:19:24Z last_modified_time: 2021-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 summary: Retrieve payment source tags: - Payment Sources put: description: Update details of a payment source. operationId: updatePaymentSource parameters: - description: |- The 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: 2021-05-19T19:19:24Z last_modified_time: 2021-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 summary: Update payment source tags: - Payment Sources /credit/policies/aprs: get: description: |- Retrieve an array of existing APR policies. This endpoint supports <>. operationId: getAprPolicies parameters: - 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. *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: 2022-04-01T23:41:58.802Z description: A golden APR policy effective_date: 2022-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: 2022-04-05T16:04:48.643Z - created_time: 2022-04-01T23:41:58.802Z description: A silver APR policy effective_date: 2022-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: 2022-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 summary: List APR policies tags: - Policies (Beta) post: description: Create a new annual percentage rate (APR) policy. operationId: createAprPolicy parameters: [ ] requestBody: content: application/json: example: description: A golden 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: 2022-04-01T23:41:58.802Z description: A golden APR policy effective_date: 2022-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: 2022-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 summary: Create APR policy tags: - Policies (Beta) /credit/policies/aprs/{token}: get: description: |- Retrieve a specific annual percentage rate (APR) policy. This endpoint supports <>. operationId: getAprPolicyByToken parameters: - description: |- The 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: 2022-04-01T23:41:58.802Z description: A golden APR policy effective_date: 2022-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: 2022-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 summary: Retrieve APR policy tags: - Policies (Beta) put: description: Update a specific APR policy. operationId: updateAprPolicyWithToken parameters: - description: |- The 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: 2022-04-01T23:41:58.802Z description: Description of the renamed APR Policy effective_date: 2022-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: 2022-04-05T16:04:48.643Z schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Update APR policy tags: - Policies (Beta) /credit/policies/aprs/{token}/clone: post: description: Create a new annual percentage rate (APR) policy based on an existing APR policy. operationId: cloneAprPolicy parameters: - description: |- The 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: 2022-04-01T23:41:58.802Z description: A golden APR policy effective_date: 2022-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: 2022-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 summary: Clone APR policy tags: - Policies (Beta) /credit/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: |- The 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: 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. *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: 2022-04-01T23:41:58.802Z description: A golden APR policy effective_date: 2022-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: 2022-04-05T16:04:48.643Z - created_time: 2022-04-01T23:41:58.802Z description: A silver APR policy effective_date: 2022-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: 2022-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 summary: List APR schedules tags: - Policies (Beta) /credit/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: 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. *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: 2022-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 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: 2022-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: 2022-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 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: 2022-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 summary: List document policies tags: - Policies (Beta) 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 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: 2022-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 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: 2022-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 summary: Create document policy tags: - Policies (Beta) /credit/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: |- The 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: 2022-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 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: 2022-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 summary: Retrieve document policy tags: - Policies (Beta) 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: |- The 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 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: 2022-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 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: 2022-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 summary: Update document policy tags: - Policies (Beta) /credit/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: |- The 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: 2022-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: 2022-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 summary: Clone document policy tags: - Policies (Beta) /credit/policies/fees: get: description: |- Retrieve an array of existing fee policies. This endpoint supports <>. operationId: getFeePolicies parameters: - 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. *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: late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2022-04-01T23:41:58.802Z description: A golden fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z - account: late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2022-04-01T23:41:58.802Z description: A silver fee policy name: Silver Fee Policy token: my_fee_policy_token_4321 updated_time: 2022-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 summary: List fee policies tags: - Policies (Beta) post: description: Create a new fee policy. operationId: createFeePolicy requestBody: content: application/json: example: account: late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 description: A golden 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: late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2022-04-01T23:41:58.802Z description: A golden fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2022-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 summary: Create fee policy tags: - Policies (Beta) /credit/policies/fees/{token}: get: description: |- Retrieve a specific fee policy. This endpoint supports <>. operationId: getFeePolicyByToken parameters: - description: |- The 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: late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2022-04-01T23:41:58.802Z description: A golden fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2022-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 summary: Retrieve fee policy tags: - Policies (Beta) put: description: Update a specific fee policy. operationId: updateFeePolicyWithToken parameters: - description: |- The 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: 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: late_payment: default_method: FLAT default_value: 5 returned_payment: default_method: FLAT default_value: 5 created_time: 2022-04-01T23:41:58.802Z description: Description for changed fee policy name: My Changed Fee Policy token: my_fee_policy_token_1234 updated_time: 2022-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 summary: Update fee policy tags: - Policies (Beta) /credit/policies/fees/{token}/clone: post: description: Create a new fee policy based on an existing fee policy. operationId: cloneFeePolicy parameters: - description: |- The 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: late_payment: default_method: FLAT default_value: 10 returned_payment: default_method: FLAT default_value: 10 created_time: 2022-04-01T23:41:58.802Z description: A golden fee policy name: Gold Fee Policy token: my_fee_policy_token_1234 updated_time: 2022-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 summary: Clone fee policy tags: - Policies (Beta) /credit/policies/products: get: description: |- Retrieve an array of existing credit product policies. This endpoint supports <>. operationId: listProductPolicies parameters: - 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. *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: 2022-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A golden 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: 2022-04-05T16:04:48.643Z usage: - PURCHASE - card_products: - level: TRADITIONAL network: VISA token: my_card_product_token4321 classification: CONSUMER created_time: 2022-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: 2022-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 summary: List credit product policies tags: - Policies (Beta) 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 golden 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 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: 2022-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A golden 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: 2022-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 summary: Create credit product policy tags: - Policies (Beta) /credit/policies/products/{token}: get: description: Retrieve a specific credit product policy. operationId: retrieveProductPolicy parameters: - description: |- The 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: 2022-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A golden 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: 2022-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 summary: Retrieve credit product policy tags: - Policies (Beta) put: description: Update a specific credit product policy. operationId: updateProductPolicy parameters: - description: |- The 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: 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: 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 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: 2022-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: Description of the renamed 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: 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 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: 2022-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 summary: Update credit product policy tags: - Policies (Beta) /credit/policies/products/{token}/clone: post: description: Create a new credit product policy based on an existing credit product policy. operationId: cloneProductPolicy parameters: - description: |- The 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: 2022-04-01T23:41:58.802Z credit_line: max: 3500 min: 50 currency_code: USD description: A golden 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: 2022-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 summary: Clone credit product policy tags: - Policies (Beta) /credit/policies/rewards: get: description: |- Retrieve an array of reward policies. This endpoint supports <>. operationId: listRewardPolicies parameters: - 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. *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: 2022-04-01T23:41:58.802Z description: A golden reward policy name: Gold Reward Policy rules: - filters: amount: greater_than: 1 less_than: 10 mcc_dynamic: includes: - HIGHEST_SPEND outcome: max_amount: 100 percentage: 20 type: CASHBACK token: my_reward_policy_token_1234 updated_time: 2022-04-05T16:04:48.643Z - created_time: 2022-04-01T23:41:58.802Z description: A silver reward policy name: Silver Reward Policy rules: - filters: amount: greater_than: 1 less_than: 10 mcc_dynamic: includes: - HIGHEST_SPEND outcome: max_amount: 100 percentage: 20 type: CASHBACK token: my_reward_policy_token_4321 updated_time: 2022-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 summary: List reward policies tags: - Policies (Beta) post: description: Create a new reward policy. operationId: createRewardPolicy parameters: [ ] requestBody: content: application/json: example: description: A golden reward policy name: Gold Reward Policy rules: - filters: amount: greater_than: 1 less_than: 10 mcc_dynamic: includes: - HIGHEST_SPEND outcome: max_amount: 100 percentage: 20 type: CASHBACK token: my_reward_policy_token_1234 schema: $ref: '#/components/schemas/PolicyRewardReq' required: true responses: '201': content: application/json: example: created_time: 2022-04-01T23:41:58.802Z description: A golden reward policy name: Gold Reward Policy rules: - filters: amount: greater_than: 1 less_than: 10 mcc_dynamic: includes: - HIGHEST_SPEND outcome: max_amount: 100 percentage: 20 type: CASHBACK token: my_reward_policy_token_1234 updated_time: 2022-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 summary: Create reward policy tags: - Policies (Beta) /credit/policies/rewards/{token}: get: description: Retrieve a reward policy. operationId: retrieveRewardPolicy parameters: - description: |- The 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: created_time: 2022-04-01T23:41:58.802Z description: A golden reward policy name: Gold Reward Policy rules: - filters: amount: greater_than: 1 less_than: 10 mcc_dynamic: includes: - HIGHEST_SPEND outcome: max_amount: 100 percentage: 20 type: CASHBACK token: my_reward_policy_token_1234 updated_time: 2022-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 summary: Retrieve reward policy tags: - Policies (Beta) put: description: Update a reward policy. operationId: updateRewardPolicy parameters: - description: |- The 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: created_time: 2022-04-01T23:41:58.802Z description: Description of renamed reward policy name: Renamed Reward Policy rules: - filters: amount: greater_than: 1 less_than: 10 mcc_dynamic: includes: - HIGHEST_SPEND outcome: max_amount: 100 percentage: 20 type: CASHBACK token: my_reward_policy_token_1234 updated_time: 2022-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 summary: Update reward policy tags: - Policies (Beta) /credit/policies/rewards/{token}/clone: post: description: Create a new reward policy based on existing reward policy. operationId: cloneRewardPolicy parameters: - description: |- The 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: created_time: 2022-04-01T23:41:58.802Z description: A golden reward policy name: Gold Reward Policy rules: - filters: amount: greater_than: 1 less_than: 10 mcc_dynamic: includes: - HIGHEST_SPEND outcome: max_amount: 100 percentage: 20 type: CASHBACK token: my_reward_policy_token_1234 updated_time: 2022-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 summary: Clone reward policy tags: - Policies (Beta) /credit/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: 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. *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: 2021-09-03T19:03:21.035Z credit_line: max: 200000 min: 25 currency_code: USD description: Description of credit product interest_calculation: application_of_credits: cycle_type: BEGINNING_REVOLVING day: 1 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 - 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: 2021-10-26T14:46:26.678Z credit_line: max: 20000 min: 200 currency_code: USD description: Platinum consumer product interest_calculation: application_of_credits: cycle_type: BEGINNING_REVOLVING day: 1 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: 2021-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 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: application_of_credits: cycle_type: BEGINNING_REVOLVING day: 1 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: application_of_credits: cycle_type: BEGINNING_REVOLVING day: 1 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 summary: Create credit product tags: - Credit Products /credit/products/{token}: get: description: Retrieve a credit product. operationId: retrieveProduct parameters: - description: |- The 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: application_of_credits: cycle_type: BEGINNING_REVOLVING day: 31 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 summary: Retrieve credit product tags: - Credit Products /credit/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: |- The 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: 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. *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: 2021-10-26T14:46:26.678Z credit_line: max: 20000 min: 200 currency_code: USD description: Platinum consumer product interest_calculation: application_of_credits: cycle_type: BEGINNING_REVOLVING day: 1 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: 2021-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: 2021-10-26T14:43:11.187Z credit_line: max: 20000 min: 200 currency_code: USD description: Platinum consumer product interest_calculation: application_of_credits: cycle_type: BEGINNING_REVOLVING day: 1 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: 2021-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: 2021-10-26T14:44:54.770Z credit_line: max: 20000 min: 200 currency_code: USD description: Platinum consumer product interest_calculation: application_of_credits: cycle_type: BEGINNING_REVOLVING day: 1 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: 2021-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 summary: Retrieve credit product lineage tags: - Credit Products /credit/rewardprograms: get: description: Retrieve an array of reward programs. operationId: retrieveRewardPrograms parameters: - description: The unique identifier of the credit account for which you want to retrieve reward programs. explode: true in: query name: account_token required: false schema: type: string x-allowableValues: 36 char max style: form - description: A value of `true` returns active resources; `false` returns inactive resources. explode: true in: query name: is_active required: false schema: type: boolean x-allowableValues: '`true`, `false`' style: form - description: Number of resources to retrieve. explode: true in: query name: count required: false schema: default: 5 type: integer x-allowableValues: 1–100 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: int64 type: integer x-allowableValues: 0 min 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 `updatedTime`, 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: -updatedTime enum: - updatedTime - -updatedTime type: string style: form responses: '200': content: application/json: example: count: 1 data: - account_token: credit_account_token_1234 bundle_token: bundle_token_1234 calculation_type: NET_BALANCE created_time: 2021-03-24 16:34:26.666 is_active: false note: Bundle was updated for this account token: reward_program_token_1234 updated_time: 2021-09-24 16:34:26.666 end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/RewardProgramsPageResponse' description: Success '404': content: { } description: Reward program does not exist. '500': content: { } description: Server error summary: List reward programs tags: - Reward Programs (Beta) /credit/rewardprograms/redemptions: get: description: retrieves all completed redemptions by settlement date operationId: retrieveRedemptionsBySettlementDate parameters: - description: Specifies the destination for external redemptions to filter for. explode: true in: query name: destination required: false schema: $ref: '#/components/schemas/DestinationType' style: form - description: Settlement start date to filter by. explode: true in: query name: settlement_start_date required: true schema: description: yyyy-MM-ddThh:mm:ssZ format: date-time type: string style: form - description: Settlement end date to filter by. explode: true in: query name: settlement_end_date required: true schema: description: yyyy-MM-ddThh:mm:ssZ format: date-time type: string style: form - description: Number of resources to retrieve. explode: true in: query name: count required: false schema: default: 5 type: integer x-allowableValues: 1–100 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: int64 type: integer x-allowableValues: 0 min style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/RedemptionsBySettlementDatePage' description: Success '400': content: { } description: User input error/Bad request. '500': content: { } description: Server error summary: retrieves all completed redemptions by settlement date tags: - reward programs - redemptions /credit/rewardprograms/{token}: get: description: Retrieve a specific reward program. operationId: retrieveRewardProgram parameters: - description: Unique identifier of the reward program. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward program token style: simple responses: '200': content: application/json: example: account_token: credit_account_token_1234 bundle_token: bundle_token_1234 calculation_type: NET_BALANCE created_time: 2021-03-24 16:34:26.666 is_active: false note: Bundle was updated for this account token: reward_program_token_1234 updated_time: 2021-09-24 16:34:26.666 schema: $ref: '#/components/schemas/RewardProgramsResponse' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Reward program does not exist. '500': content: { } description: Server error summary: Retrieve reward program tags: - Reward Programs (Beta) put: description: |- Activate or deactivate a specific reward program. [CAUTION] This endpoint is available for banks only. Do not use this endpoint if you are a brand contributor. operationId: updateRewardProgram parameters: - description: Unique identifier of the reward program. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward program token style: simple requestBody: content: application/json: example: is_active: false note: Bundle was updated for this account schema: $ref: '#/components/schemas/PutRewardProgramsRequest' required: false responses: '200': content: application/json: example: account_token: credit_account_token_1234 bundle_token: bundle_token_1234 calculation_type: NET_BALANCE created_time: 2021-03-24 16:34:26.666 is_active: false note: Bundle was updated for this account token: reward_program_token_1234 updated_time: 2021-09-24 16:34:26.666 schema: $ref: '#/components/schemas/RewardProgramsResponse' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Reward program does not exist. '500': content: { } description: Server error summary: Activate or deactivate reward program tags: - Reward Programs (Beta) /credit/rewardprograms/{token}/balances: get: description: |- Retrieve the balances for a specific reward program. The reward accrual service calculates values to a 4 point precision, however the retrieve reward balance endpoint returns pending and accrued balances to a 2 point precision operationId: retrieveRewardProgramBalance parameters: - description: Unique identifier of the reward program. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward program token style: simple responses: '200': content: application/json: example: billing_cycle_closing_date: 2021-03-31 16:34:26.666 billing_cycle_opening_date: 2021-03-01 16:34:26.666 net_balance: 833.33 pending_reward_balance: 25 percentage: 3 reward_program_token: reward_program_token_1234 total_reward_balance: 25 schema: $ref: '#/components/schemas/RewardProgramsBalancesResponse' description: Success '404': content: { } description: Reward program does not exist. '500': content: { } description: Server error summary: Retrieve reward program balances tags: - Reward Programs (Beta) /credit/rewardprograms/{token}/entries: get: description: "Retrieve an array of reward entries on a specific reward program.\n\ \nThe reward accrual service calculates values to a 4 point precision, \n\ however the retrieve reward balance endpoint returns pending and accrued balances\ \ to a 2 point precision" operationId: retrieveRewardProgramEntries parameters: - description: Unique identifier of the reward program. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward program token style: simple - description: The starting date (or date-time) of a date range from which to return resources, in UTC. explode: true in: query name: start_date required: false schema: description: yyyy-MM-ddThh:mm:ssZ format: date-time type: string style: form - description: The ending date (or date-time) of a date range from which to return resources, in UTC. explode: true in: query name: end_date required: false schema: description: yyyy-MM-ddThh:mm:ssZ format: date-time type: string style: form - description: Number of resources to retrieve. explode: true in: query name: count required: false schema: default: 5 type: integer x-allowableValues: 1–100 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: int64 type: integer x-allowableValues: 0 min 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 - description: Status of the reward entries in the returned array. explode: true in: query name: status required: false schema: items: $ref: '#/components/schemas/RewardEntryStatus' type: array style: form responses: '200': content: application/json: example: count: 2 data: - created_time: 2021-03-24 16:34:26.666 mcc: APPAREL mid: NORDSTROM note: Reward adjustment related_journal_entry_token: related_journal_entry_token_1234 reward_program_token: reward_program_token_1234 reward_rules_config_token: reward_rules_config_token_1234 status: PENDING token: reward_entry_token_1234 transaction_amount: 87 value: 0.87 - created_time: 2021-03-24 16:34:26.666 mcc: GROCERY mid: COSTCO note: Reward adjustment related_journal_entry_token: related_journal_entry_token_1111 reward_program_token: reward_program_token_1234 reward_rules_config_token: reward_rules_config_token_1234 status: PENDING token: reward_entry_token_1111 transaction_amount: 159.11 value: 1.59 end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/RewardProgramsEntriesPage' description: Success '404': content: { } description: Reward program does not exist. '500': content: { } description: Server error summary: List reward entries tags: - Reward Programs (Beta) post: description: |- Create a reward entry on a specific reward program. Use this endpoint to manually create a reward entry if an existing reward is being disputed. operationId: postRewardProgramEntry parameters: - description: Unique identifier of the reward program. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward program token style: simple requestBody: content: application/json: example: note: Reward adjustment value: 2.5 schema: $ref: '#/components/schemas/CreateRewardProgramsEntriesRequest' responses: '201': content: application/json: example: created_time: 2021-03-24 16:34:26.666 note: Reward adjustment related_journal_entry_token: related_journal_entry_token_1234 reward_program_token: reward_program_token_1234 reward_rules_config_token: reward_rules_config_token_1234 status: PENDING token: reward_entry_token_1234 transaction_amount: 250 value: 2.5 schema: $ref: '#/components/schemas/RewardProgramsEntriesResponse' description: Success '400': content: { } description: User input error/Bad request. '404': content: { } description: Reward program does not exist. '409': content: { } description: Token already associated with a different payload. '500': content: { } description: Server error summary: Create reward entry tags: - Reward Programs (Beta) /credit/rewardprograms/{token}/entries/balance: get: description: "Retrieve the balance of reward entries, which is the accrued rewards\ \ amount, within a specified date range.\n\nThe reward accrual service calculates\ \ values to a 4 point precision, \nhowever the retrieve reward balance endpoint\ \ returns pending and accrued balances to a 2 point precision" operationId: retrieveRewardProgramEntriesBalance parameters: - description: Unique identifier of the reward program. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward program token style: simple - description: The starting date (or date-time) of a date range from which to return resources, in UTC. explode: true in: query name: start_date required: true schema: description: yyyy-MM-ddThh:mm:ssZ format: date-time type: string style: form - description: The ending date (or date-time) of a date range from which to return resources, in UTC. explode: true in: query name: end_date required: true schema: description: yyyy-MM-ddThh:mm:ssZ format: date-time type: string style: form responses: '200': content: application/json: example: created_time: 2021-03-24 16:34:26.666 end_date: 2021-03-31 16:34:26.666 reward_program_token: reward_program_token_1234 start_date: 2021-03-01 16:34:26.666 total_reward_balance: 25 schema: $ref: '#/components/schemas/RewardProgramsEntriesBalanceResponse' description: Success '404': content: { } description: Reward program does not exist. '500': content: { } description: Server error summary: Retrieve reward entries balance tags: - Reward Programs (Beta) /credit/rewardprograms/{token}/entries/{entry_token}: get: description: "Retrieve a specific reward entry on a reward program.\n\nThe reward\ \ accrual service calculates values to a 4 point precision, \nhowever the\ \ retrieve reward balance endpoint returns pending and accrued balances to\ \ a 2 point precision" operationId: retrieveRewardProgramEntry parameters: - description: Unique identifier of the reward program. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward program token style: simple - description: Unique identifier of the reward entry to retrieve. explode: false in: path name: entry_token required: true schema: type: string style: simple responses: '200': content: application/json: example: created_time: 2021-03-24 16:34:26.666 mcc: APPAREL mid: NORDSTROM note: Reward adjustment related_journal_entry_token: related_journal_entry_token_1234 reward_program_token: reward_program_token_1234 reward_rules_config_token: reward_rules_config_token_1234 status: PENDING token: reward_entry_token_1234 transaction_amount: 87 value: 0.87 schema: $ref: '#/components/schemas/RewardProgramsEntriesResponse' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Reward Program or entry does not exist. '500': content: { } description: Server error summary: Retrieve reward entry tags: - Reward Programs (Beta) /credit/rewardprograms/{token}/redemptions: get: description: Retrieve an array of reward redemptions for a specific reward program. operationId: retrieveRedemptions parameters: - description: Unique identifier of the reward program. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward program token style: simple - description: The starting date (or date-time) of a date range from which to return resources, in UTC. explode: true in: query name: start_date required: false schema: description: yyyy-MM-ddThh:mm:ssZ format: date-time type: string style: form - description: The ending date (or date-time) of a date range from which to return resources, in UTC. explode: true in: query name: end_date required: false schema: description: yyyy-MM-ddThh:mm:ssZ format: date-time type: string style: form - description: Number of resources to retrieve. explode: true in: query name: count required: false schema: default: 5 type: integer x-allowableValues: 1–100 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: int64 type: integer x-allowableValues: 0 min 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 - description: Type of reward redemptions in the returned array. explode: true in: query name: type required: false schema: $ref: '#/components/schemas/RedemptionType' style: form responses: '200': content: application/json: example: count: 1 data: - amount: 50 created_time: 2021-03-24 16:34:26.666 destination: INVESTMENT note: Credit to investment account pending_reward_entry_token: pending_reward_entry_token_1234 reward_program_token: reward_program_token_1234 sor_reward_token: sor_reward_token_1234 status: COMPLETED token: reward_redemption_token_1234 type: EXTERNAL updated_time: 2021-03-24 16:34:26.666 end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/RedemptionsPage' description: Success '404': content: { } description: Reward program does not exist. '500': content: { } description: Server error summary: List reward redemptions tags: - Reward Redemptions (Beta) post: description: Create a redemption to redeem rewards on a specific reward program. operationId: postRewardProgramRedemption parameters: - description: Unique identifier of the reward program. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward program token style: simple requestBody: content: application/json: example: amount: 0.03 destination: WALLET note: reward redemption type: EXTERNAL schema: $ref: '#/components/schemas/CreateRedemptionsRequest' responses: '201': content: application/json: example: amount: 0.03 created_time: 2022-08-31T19:48:42.638Z destination: WALLET external_settlement_date_time: 2022-08-31T19:43:03.606Z note: reward redemption related_reward_entries: [ ] reward_program_token: reward_program_token_1234 sor_reward_token: sor_reward_token_1234 status: INITIATED token: reward_redemption_token_1234 type: EXTERNAL updated_time: 2022-08-31T19:48:42.639Z schema: $ref: '#/components/schemas/RedemptionsResponse' description: Success '400': content: { } description: User input error/Bad request. '404': content: { } description: Reward program does not exist. '409': content: { } description: Token already associated with a different payload. '500': content: { } description: Server error summary: Create reward redemption tags: - Reward Redemptions (Beta) /credit/rewardprograms/{token}/redemptions/balance: get: description: Retrieve the balance for reward redemptions within a specified date range. operationId: retrieveRedemptionsBalance parameters: - description: Unique identifier of the reward program. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward program token style: simple - description: The starting date (or date-time) of a date range from which to return resources, in UTC. explode: true in: query name: start_date required: false schema: description: yyyy-MM-ddThh:mm:ssZ format: date-time type: string style: form - description: The ending date (or date-time) of a date range from which to return resources, in UTC. explode: true in: query name: end_date required: false schema: description: yyyy-MM-ddThh:mm:ssZ format: date-time type: string style: form - description: Type of reward redemptions in the returned array. explode: true in: query name: type required: false schema: items: $ref: '#/components/schemas/RedemptionType' type: array style: form responses: '200': content: application/json: example: created_time: 2021-03-24 16:34:26.666 end_date: 2021-03-24 16:34:26.666 redemption_total_amount: 25 reward_program_token: reward_program_token_1234 start_date: 2021-03-24 16:34:26.666 schema: $ref: '#/components/schemas/RedemptionsBalanceResponse' description: Success '404': content: { } description: Reward program does not exist. '500': content: { } description: Server error summary: Retrieve reward redemption balance tags: - Reward Redemptions (Beta) /credit/rewardprograms/{token}/redemptions/{redemption_token}: get: description: Retrieve a specific redemption for a specific reward program. operationId: getRedemption parameters: - description: Unique identifier of the reward program. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward program token style: simple - description: Unique identifier of the reward redemption. explode: false in: path name: redemption_token required: true schema: type: string x-allowableValues: Existing redemption token style: simple responses: '200': content: application/json: example: amount: 0.03 created_time: 2022-08-31T19:48:42.638Z destination: WALLET external_settlement_date_time: 2022-08-31T19:43:03.606Z note: reward redemption related_reward_entries: [ ] reward_program_token: reward_program_token_1234 sor_reward_token: sor_reward_token_1234 status: INITIATED token: reward_redemption_token_1234 type: EXTERNAL updated_time: 2022-08-31T19:48:42.639Z schema: $ref: '#/components/schemas/RedemptionsResponse' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Redemption does not exist. '500': content: { } description: Server error summary: Retrieve reward redemption tags: - Reward Redemptions (Beta) /credit/rewardprograms/{token}/redemptions/{redemption_token}/transitions: post: description: Transition the current status of a reward redemption to a new status. operationId: postRedemptionTransition parameters: - description: Unique identifier of the reward program. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward program token style: simple - description: Unique identifier of the reward redemption. explode: false in: path name: redemption_token required: true schema: type: string x-allowableValues: Existing redemption token style: simple requestBody: content: application/json: example: new_state: COMPLETED schema: $ref: '#/components/schemas/CreateRedemptionTransitionsRequest' responses: '201': content: application/json: example: created_time: 2022-08-31T19:43:03.606Z external_settlement_date_time: 2022-08-31T19:43:03.606Z initial_status: INITIATED new_status: COMPLETED redemption_token: reward_redemption_token_1234 token: reward_program_token_1234 schema: $ref: '#/components/schemas/RedemptionTransitionsResponse' description: Success '400': content: { } description: User input error/Bad request. '404': content: { } description: Reward Program or redemption does not exist. '409': content: { } description: Token already associated with a different payload. '500': content: { } description: Server error summary: Transition reward redemption status tags: - Reward Redemptions (Beta) /credit/rewardprograms/{token}/rulesconfigs: get: description: Retrieve an array of rules configs for a specific reward program. operationId: retrieveRewardProgramsRulesConfig parameters: - description: Unique identifier of the reward program. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward program token style: simple - description: A value of `true` returns active resources; `false` returns inactive resources. explode: true in: query name: is_active required: false schema: type: boolean x-allowableValues: '`true`, `false`' style: form - description: Number of resources to retrieve. explode: true in: query name: count required: false schema: default: 5 type: integer x-allowableValues: 1–100 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: int64 type: integer x-allowableValues: 0 min 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 `updatedTime`, 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: -updatedTime enum: - updatedTime - -updatedTime type: string style: form responses: '200': content: application/json: example: count: 2 data: - accrual_type: CASHBACK created_time: 2021-03-24 16:34:26.666 greater_than: 3999 is_active: true less_than: 20000 percentage: 3 reward_program_token: reward_program_token_1234 token: reward_rules_config_token_3333 updated_time: 2021-03-24 16:34:26.666 - accrual_type: CASHBACK created_time: 2021-03-24 16:34:26.666 greater_than: 1499 is_active: true less_than: 4000 percentage: 2 reward_program_token: reward_program_token_1234 token: reward_rules_config_token_2222 updated_time: 2021-03-24 16:34:26.666 - accrual_type: CASHBACK created_time: 2021-03-24 16:34:26.666 greater_than: 1 is_active: true less_than: 1500 percentage: 1 reward_program_token: reward_program_token_1234 token: reward_rules_config_token_1111 updated_time: 2021-03-24 16:34:26.666 end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/RewardProgramsRulesConfigsPage' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Reward program does not exist. '500': content: { } description: Server error summary: List rules configurations tags: - Reward Programs (Beta) /credit/rewardprograms/{token}/rulesconfigs/applied: get: description: Retrieve the most recently applied rules config on a specific reward program. operationId: retrieveRewardProgramsRulesConfigApplied parameters: - description: Unique identifier of the reward program. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing reward program token style: simple responses: '200': content: application/json: example: accrual_type: CASHBACK created_time: 2021-03-24 16:34:26.666 greater_than: 3999 is_active: true less_than: 20000 percentage: 3 reward_program_token: reward_program_token_1234 token: reward_rules_config_token_3333 updated_time: 2021-03-24 16:34:26.666 schema: $ref: '#/components/schemas/RewardProgramsRulesConfigsResponse' description: Success '400': content: { } description: User input error/Bad request '404': content: { } description: Reward program does not exist. '500': content: { } description: Server error summary: Retrieve last rules configuration applied tags: - Reward Programs (Beta) /credit/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 type: string style: simple - description: |- The 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. 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, or delinquency transition 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: 2023-04-01T03:59:59.999Z created_time: 2021-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: 2023-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: 2021-08-18T20:25:10.408Z original_status: UNACTIVATED status: ACTIVE token: my_credit_account_transition_token1234 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: 2023-03-01 04:59:59.999 current_due: 40 impact_time: 2023-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: 2023-03-01 04:59:59.999 updated_time: 2023-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: 2021-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: 2021-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: 2021-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: 2021-10-14T17:26:35Z is_default_account: false last_modified_time: 2021-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: 2021-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: 2021-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: 2021-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: 2021-08-18T22:06:52Z detail_token: my_detail_token1234 dispute_token: null group: PURCHASE id: '12345678' impact_time: 2021-08-18T22:07:21.422Z memo: Jane's Bakery related_token: null request_time: 2021-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: 2021-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: 2021-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: 2021-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: 2021-10-14T17:26:35Z is_default_account: false last_modified_time: 2021-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: 2021-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: 2021-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: 2021-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: 2021-08-18T22:06:52Z detail_token: my_detail_token1234 dispute_token: null group: PURCHASE id: '12345678' impact_time: 2021-08-18T22:07:21.422Z memo: Jane's Bakery related_token: null request_time: 2021-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: 2021-08-17T18:26:47.591Z payment_token: my_credit_account_payment_token1234 refund_details: null status: COMPLETED token: my_payment_transition_token1234 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 summary: Resend credit event notification tags: - Account Transitions - Journal Entries - Ledger Entries - Payments - Statements - Delinquency /depositaccounts: post: operationId: createAccount requestBody: content: application/json: schema: $ref: '#/components/schemas/direct_deposit_account_request' 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/direct_deposit_account_transition_request' 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/{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/customer_due_diligence_update_response' 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: 2022-11-06T22:43:20Z last_modified_time: 2022-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: 2023-03-22T21:22:19Z encrypted_pass_data: my_encrypted_pass_data_KGga... ephemeral_public_key: my_ephemeral_public_key_omvw... last_modified_time: 2023-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/wpp/applePayJWT: post: description: |- [NOTE] This endpoint is currently in beta and subject to change. For more information, contact your Marqeta representative. Use this endpoint to add a card to Apple Wallet via a web application. operationId: generateApplePayWPPJWT parameters: - description: Random pseudo-unique value used for troubleshooting between multiple parties. 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: Random pseudo-unique value used for troubleshooting between multiple parties. 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. 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. 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. 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: |- [NOTE] This endpoint is currently in beta and subject to change. For more information, contact your Marqeta representative. 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: Random pseudo-unique value used for troubleshooting between multiple parties. 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: Random pseudo-unique value used for troubleshooting between multiple parties. 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. 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. 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. explode: false schema: type: string style: simple summary: Create request for Google Wallet web push provisioning tags: - Digital Wallets Management /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 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: -createdTime 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: -createdTime 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: 2022-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: 2023-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: 2022-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: 2023-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: 2022-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: 2023-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: 2023-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: 2023-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: 2023-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: 2023-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: The number of direct deposit records 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: 'Comma-delimited list of direct deposit states to display e.g. PENDING | REVERSED | APPLIED | REJECTED ' 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: Retrieves a list of all direct deposit records for your program. 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/deposit_account' 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/deposit_account_update_request' description: Deposit account update request required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/deposit_account' 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 /fees: get: description: |- Use this endpoint to list existing fees. This endpoint supports <> and <>. operationId: getFees 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: |- 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 amount: 3.0 created_time: 2022-05-11T18:03:39Z currency_code: USD last_modified_time: 2022-05-11T18:03:39Z name: My Fee 02 real_time_assessment: domestic_enabled: true international_enabled: true transaction_type: authorization tags: My Tags token: my_fee_02 end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/FeeListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List fees tags: - Fees post: description: |- Use this endpoint to create a fee. Add the source details to the body of the request in link:http://www.json.org/[JSON, window="_blank"] format. operationId: postFees requestBody: content: application/json: example: amount: 1.0 currency_code: USD name: My Fee 01 real_time_assessment: domestic_enabled: true international_enabled: true transaction_type: authorization tags: My Tags token: my_fee_01 schema: $ref: '#/components/schemas/fee_request' required: false responses: '201': content: application/json: example: active: true amount: 1 created_time: 2022-05-11T17:57:21Z currency_code: USD last_modified_time: 2022-05-11T17:57:21Z name: My Fee 01 real_time_assessment: domestic_enabled: true international_enabled: true transaction_type: authorization tags: My Tags token: my_fee_01 schema: $ref: '#/components/schemas/fee' 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 fee tags: - Fees /fees/{token}: get: description: |- Use this endpoint to retrieve a fee. Include the `token` path parameter to specify the fee to return. operationId: getFeesToken parameters: - description: Unique identifier of the fee resource. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: active: true amount: 1.0 created_time: 2022-05-11T17:57:21Z currency_code: USD last_modified_time: 2022-05-11T17:57:21Z name: My Fee 01 real_time_assessment: domestic_enabled: true international_enabled: true transaction_type: authorization tags: My Tags token: my_fee_01 schema: $ref: '#/components/schemas/fee' description: Success '404': content: { } description: Fee not found '500': content: { } description: Server error summary: Retrieve fee tags: - Fees put: description: |- Use this endpoint to update a fee. Include the `token` as a path parameter to indicate the fee to update. operationId: putFeesToken parameters: - description: Unique identifier of the fee resource. explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: example: active: false schema: $ref: '#/components/schemas/fee_update_request' required: false responses: '200': content: application/json: example: active: false amount: 1.0 created_time: 2022-05-11T17:57:21Z currency_code: USD last_modified_time: 2022-05-11T17:57:21Z name: My Fee 01 real_time_assessment: domestic_enabled: true international_enabled: true transaction_type: authorization tags: My Tags token: my_fee_01 schema: $ref: '#/components/schemas/fee' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: Update fee tags: - Fees /feetransfers: post: description: |- Use this endpoint to create a fee transfer. You must pass in either `user_token` or `business_token` to associate a user or business with the fee transfer. This is an all-or-nothing operation. When more than one fee is present, you must assess either all fees, or no fees. [NOTE] This feature is currently in beta and subject to change. It also requires additional activation steps. To learn more about the Beta program for this feature and about activating it for your program, contact your Marqeta representative. operationId: postFeetransfers requestBody: content: application/json: example: business_token: my_business_01 fees: - memo: Initiation fee token: my_fee_01 token: my_feetransfer_01 user_token: my_user_01 schema: $ref: '#/components/schemas/fee_transfer_request' required: false responses: '201': content: application/json: example: business_token: my_business_01 created_time: 2022-05-11T19:05:55Z fees: - fee: active: true amount: 1 created_time: 2022-05-11T17:57:21Z currency_code: USD last_modified_time: 2022-05-11T17:57:21Z name: My Fee 01 real_time_assessment: domestic_enabled: true international_enabled: true transaction_type: authorization tags: My Tags token: my_fee_01 memo: Initiation fee token: my_fee_01 transaction_token: '162' token: my_feetransfer_01 user_token: my_user_01 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: Create fee transfer tags: - Fee Transfers /feetransfers/{token}: get: description: |- Use this endpoint to retrieve a specific fee transfer. Include the fee transfer `token` path parameter to specify the fee transfer to return. operationId: getFeetransfersToken parameters: - description: Unique identifier of the fee transfer to retrieve. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: business_token: my_business_01 created_time: 2022-05-11T19:05:55Z fees: - fee: active: true amount: 1 created_time: 2022-05-11T17:57:21Z currency_code: USD last_modified_time: 2022-05-11T17:57:21Z name: My Fee 01 real_time_assessment: domestic_enabled: true international_enabled: true transaction_type: authorization tags: My Tags token: my_fee_01 memo: Initiation fee token: my_fee_01 transaction_token: '162' token: my_feetransfer_01 user_token: my_user_01 schema: $ref: '#/components/schemas/fee_transfer_response' description: Success '404': content: { } description: Fee transfer not found '500': content: { } description: Server error summary: Retrieve fee transfer tags: - Fee Transfers /fundingsources/ach: post: description: |- Create an ACH funding source for an existing account holder. Specify the account holder of the funding source by passing a user or business token. When adding an ACH funding source, a small amount is deposited in the bank account as a test. The test deposit should be reflected in the account after two to three business days. You must then make an API call to verify the deposit amount in order to activate the ACH account. See <> on this page for more information. The response body returns details about the account, including the verification status. Possible ACH verification status values include `VERIFICATION_PENDING`, `ACH_VERIFIED`, and `ACH_FAILED`. operationId: postFundingsourcesAch requestBody: content: application/json: example: account_number: '987654321' account_type: savings is_default_account: false name_on_account: Jane Doe routing_number: '121000358' token: my_user_01_fundingsource_token_01 user_token: my_user_01 verification_notes: These are my verification notes. verification_override: true schema: $ref: '#/components/schemas/ach_model' required: false responses: '200': content: application/json: example: account_suffix: '4321' account_type: savings active: true created_time: 2023-02-26T18:46:06Z date_sent_for_verification: 2023-02-27T07:36:05Z date_verified: 2023-02-27T11:03:45Z is_default_account: false last_modified_time: 2023-03-26T12:44:02Z name_on_account: Jane Doe token: my_user_01_fundingsource_token_01 user_token: my_user_01 verification_notes: These are my verification notes. verification_override: true verification_status: ACH_VERIFIED 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: Create ACH source tags: - Account Holder Funding Sources /fundingsources/ach/partner: post: description: |- Create an ACH funding source for an existing account holder by using a third-party partner to handle account validation and provide PII account data. Because you don't handle any personally identifiable information (PII) yourself, using a third party when creating the funding source enables you to bypass the regulatory and compliance measures related to capturing, storing, and transmitting PII. With this endpoint, you can create a US-based funding source—either a checking account or a savings account—for a program or user without passing bank account details such as the account number or routing number to Marqeta. Instead, validating account data and account verification is handled by the third-party partner you specify, and a secure token (i.e., a Plaid `processor_token`) is shared across partners. By using a secure account verification platform to provide immediate verification, you shorten the wait time until the ACH funding source is ready and avoid managing the microdeposit-based account verification process. To create an ACH funding source for an existing account holder without validating through a third party, see <>. [NOTE] This endpoint assumes that you already have established a relationship with both Marqeta and the third-party account validation partner you want to use. In addition, you must explicitly authorize the sharing of information with the third-party partner, and enable Marqeta as a processor for your integration. For more information, contact your Marqeta representative. operationId: postFundingsourcesAchPartner requestBody: content: application/json: example: is_default_account: false partner: PLAID partner_account_link_reference_token: processor-sandbox-reference-token token: my_user_01_fundingsource_token_01 user_token: my_user_01 schema: $ref: '#/components/schemas/ach_partner_request_model' required: false responses: '200': content: application/json: example: account_suffix: '4321' account_type: savings active: true created_time: 2023-02-26T18:46:06Z date_sent_for_verification: 2023-02-27T07:36:05Z date_verified: 2023-02-27T11:03:45Z is_default_account: false last_modified_time: 2023-03-26T12:44:02Z name_on_account: Jane Doe partner: PLAID partner_account_link_reference_token: processor-sandbox-reference-token token: my_user_01_fundingsource_token_01 user_token: my_user_01 verification_notes: These are my verification notes. verification_override: true verification_status: ACH_VERIFIED 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: Create ACH source via a partner integration tags: - Account Holder Funding Sources /fundingsources/ach/{funding_source_token}: get: description: |- Retrieve a specific ACH funding source. The response body returns details about the account, including the verification status. Possible ACH verification status values are: `ACH_FAILED`, `ACH_VERIFIED`, and `VERIFICATION_PENDING`. operationId: getFundingsourcesAchFundingsourcetoken parameters: - description: |- Unique identifier of the funding source. Send a `GET` request to `/fundingsources/user/{user_token}` to retrieve existing funding source tokens for a user or to `/fundingsources/business/{business_token}` to retrieve existing funding source tokens for a business. explode: false in: path name: funding_source_token required: true schema: type: string style: simple responses: '200': content: application/json: example: account_suffix: '4321' account_type: savings active: true created_time: 2023-02-26T18:46:06Z date_sent_for_verification: 2023-02-27T18:00:00Z date_verified: 2023-02-27T18:15:00Z is_default_account: false last_modified_time: 2023-03-12T04:58:46Z name_on_account: Jane Doe token: my_user_01_fundingsource_token_01 user_token: my_user_01 verification_notes: These are my verification notes. verification_override: true verification_status: ACH_VERIFIED 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: Retrieve ACH source tags: - Account Holder Funding Sources put: description: |- Verify or update an ACH funding source. If you are verifying the ACH source, include the verification amounts in the body of the request. ACH verification will fail if the verification amounts are not entered in the correct order. `verify_amount1` must match the first deposit amount, and `verify_amount2` must match the second. If you are updating the ACH source, include the `active` field instead. The `active` field is the only field you can update. operationId: putFundingsourcesAchFundingsourcetoken parameters: - description: |- Unique identifier of the funding source. Send a `GET` request to `/fundingsources/user/{user_token}` to retrieve existing funding source tokens for a user or to `/fundingsources/business/{business_token}` to retrieve existing funding source tokens for a business. explode: false in: path name: funding_source_token required: true schema: type: string style: simple requestBody: content: application/json: example: active: false verify_amount1: 0.43 verify_amount2: 0.11 schema: $ref: '#/components/schemas/ach_verification_model' required: false responses: '200': content: application/json: example: account_suffix: '4321' account_type: savings active: false created_time: 2023-01-26T20:03:05Z date_sent_for_verification: 2023-01-27T18:00:00Z date_verified: 2023-01-27T18:15:00Z is_default_account: false last_modified_time: 2023-02-26T20:03:05Z name_on_account: Jane Doe token: my_user_01_fundingsource_token_01 user_token: my_user_01 verification_status: ACH_VERIFIED schema: $ref: '#/components/schemas/ach_response_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Verify or update ACH source tags: - Account Holder Funding Sources /fundingsources/ach/{funding_source_token}/verificationamounts: get: description: |- In your sandbox environment, retrieve the amounts used to verify the association with your ACH account. Use this endpoint for testing purposes only. In production, verification amounts are retrieved from the bank statement of the account holder. operationId: getFundingsourcesAchFundingsourcetokenVerificationamounts parameters: - description: |- Unique identifier of the funding source. Send a `GET` request to `/fundingsources/user/{user_token}` to retrieve existing funding source tokens for a user or to `/fundingsources/business/{business_token}` to retrieve existing funding source tokens for a business. explode: false in: path name: funding_source_token required: true schema: type: string style: simple responses: '200': content: application/json: example: token: jane_doe_ach_token verify_amount1: 0.43 verify_amount2: 0.11 schema: $ref: '#/components/schemas/ach_verification_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Retrieve ACH verification amounts tags: - Account Holder Funding Sources /fundingsources/addresses: post: description: |- Use this endpoint to create an address resource. When creating the address, you must pass the token of either an existing user in the `user_token` field or an existing business in the `business_token` field. Do not pass both. operationId: postFundingsourcesAddresses requestBody: content: application/json: example: address_1: 1234 Grove Street business_token: my_business_01 city: Berkeley country: USA first_name: Jane last_name: Doe phone: '5104444444' postal_code: '94705' state: CA token: my_funding_source_address_biz_01 zip: '94705' schema: $ref: '#/components/schemas/card_holder_address_model' required: false responses: '201': content: application/json: example: active: true address_1: 1234 Grove Street business_token: my_business_01 city: Berkeley country: USA created_time: 2023-02-20T20:04:13Z first_name: Jane is_default_address: true last_modified_time: 2023-02-20T20:04:13Z last_name: Doe phone: '5104444444' postal_code: '94705' state: CA token: my_funding_source_address_biz_01 zip: '94705' 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: Create address tags: - Addresses /fundingsources/addresses/business/{business_token}: get: description: |- Use this endpoint to list existing addresses for a business. This endpoint supports <>. operationId: getFundingsourcesAddressesBusinessBusinesstoken parameters: - description: |- Unique identifier of the business account holder. Send a `GET` request to `/businesses` to retrieve business tokens. explode: false in: path name: business_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: count: 2 data: - active: true address_1: 1234 Grove Street business_token: my_business_01 city: Berkeley country: USA created_time: 2023-02-26T21:34:42Z first_name: Jane is_default_address: true last_modified_time: 2023-02-27T18:55:59Z last_name: Doe phone: '5104444444' postal_code: '94705' state: CA token: my_funding_source_address_bus_01 zip: '94705' - active: true address_1: 5678 Grove Street business_token: my_business_01 city: Berkeley country: USA created_time: 2023-02-25T19:48:30Z first_name: Jane is_default_address: false last_modified_time: 2023-03-25T10:17:38Z last_name: Doe phone: '5104444444' postal_code: '94705' state: CA token: my_funding_source_address_bus_02 zip: '94705' end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/CardholderAddressListResponse' description: Success '400': content: { } description: Bad request '404': content: { } description: Not found '500': content: { } description: Server error summary: List business addresses tags: - Addresses /fundingsources/addresses/user/{user_token}: get: description: |- Use this endpoint to list existing addresses for a user. This endpoint supports <>. operationId: getFundingsourcesAddressesUserUsertoken parameters: - description: Unique identifier of the user account holder. explode: false in: path name: user_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: count: 2 data: - active: true address_1: 1234 Grove Street business_token: my_user_01 city: Berkeley country: USA created_time: 2023-02-27T21:34:42Z first_name: Jane is_default_address: true last_modified_time: 2023-02-28T18:55:59Z last_name: Doe phone: '5104444444' postal_code: '94705' state: CA token: my_funding_source_address_user_01 zip: '94705' - active: true address_1: 5678 Grove Street business_token: my_user_01 city: Berkeley country: USA created_time: 2023-02-25T19:48:30Z first_name: Jane is_default_address: false last_modified_time: 2023-03-25T19:48:30Z last_name: Doe phone: '5104444444' postal_code: '94705' state: CA token: my_funding_source_address_user_02 zip: '94705' end_index: 1 is_more: false start_index: 0 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: - Addresses /fundingsources/addresses/{funding_source_address_token}: get: description: Use this endpoint to retrieve a funding source address. operationId: getFundingsourcesAddressesFundingsourceaddresstoken parameters: - description: Unique identifier of the funding source address. explode: false in: path name: funding_source_address_token required: true schema: type: string style: simple responses: '200': content: application/json: example: active: true address_1: 1234 Grove Street business_token: my_business_01 city: Berkeley country: USA created_time: 2023-02-20T20:04:13Z first_name: Jane is_default_address: true last_modified_time: 2023-02-20T20:04:13Z last_name: Doe phone: '5104444444' postal_code: '94705' state: CA token: my_funding_source_address_biz_01 zip: '94705' schema: $ref: '#/components/schemas/CardholderAddressResponse' description: Success '400': content: { } description: Bad request '404': content: { } description: Not found '500': content: { } description: Server error summary: Retrieve address tags: - Addresses put: description: |- Use this endpoint to update an address. Only values of parameters in the request are modified; all others are left unchanged. operationId: putFundingsourcesAddressesFundingsourceaddresstoken parameters: - description: Unique identifier of the funding source address. explode: false in: path name: funding_source_address_token required: true schema: type: string style: simple requestBody: content: application/json: example: address_1: 333 Elm Street schema: $ref: '#/components/schemas/card_holder_address_update_model' required: false responses: '200': content: application/json: example: active: true address_1: 333 Elm Street business_token: my_business_01 city: Berkeley country: USA created_time: 2023-02-20T20:04:13Z first_name: Jane is_default_address: true last_modified_time: 2023-02-28T16:00:00Z last_name: Doe phone: '5104444444' postal_code: '94705' state: CA token: my_funding_source_address_biz_01 zip: '94705' schema: $ref: '#/components/schemas/CardholderAddressResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Update address tags: - Addresses /fundingsources/business/{business_token}: get: description: |- List funding sources associated with a specific business. This endpoint supports <>. operationId: getFundingsourcesBusinessBusinesstoken parameters: - description: |- Unique identifier of the business account holder. Send a `GET` request to `/businesses` to retrieve business tokens. explode: false in: path name: business_token required: true schema: type: string style: simple - description: |- Type of funding source to return: ACH or payment card. Leave unspecified to return both types. explode: true in: query name: 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 responses: '200': content: application/json: example: count: 1 data: - account_suffix: '4113' account_type: corporate active: true created_time: 2023-02-26T21:26:13Z exp_date: '1227' is_default_account: true last_modified_time: 2023-02-26T21:26:13Z token: my_paymentcard_funding_source_01 type: paymentcard user_token: my_business_01 end_index: 0 is_more: false start_index: 0 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: List sources for business tags: - Account Holder Funding Sources /fundingsources/paymentcard: post: description: |- Create a payment card funding source for an existing account holder. This endpoint returns the card type and the last four digits of the card, and then sets the `active_ field` to `true`. Marqeta retains only a tokenized representation of the card number. operationId: postFundingsourcesPaymentcard requestBody: content: application/json: example: account_number: '6559906559906557' cvv_number: '123' exp_date: '1227' is_default_account: true postal_code: '94608' token: my_paymentcard_01 user_token: my_user_01 schema: $ref: '#/components/schemas/token_request' required: false responses: '200': content: application/json: example: account_suffix: '6557' account_type: corporate active: true created_time: 2023-02-26T20:00:00Z exp_date: '1227' is_default_account: true last_modified_time: 2023-02-26T21:00:00Z token: my_paymentcard_01 type: paymentcard user_token: my_user_01 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: Create payment card source tags: - Account Holder Funding Sources /fundingsources/paymentcard/{funding_source_token}: get: description: Retrieve a specific payment card funding source. operationId: getFundingsourcesPaymentcardFundingsourcetoken parameters: - description: |- U|- Unique identifier of the funding source. Send a `GET` request to `/fundingsources/user/{user_token}` to retrieve existing funding source tokens for a user or to `/fundingsources/business/{business_token}` to retrieve existing funding source tokens for a business. explode: false in: path name: funding_source_token required: true schema: type: string style: simple responses: '200': content: application/json: example: account_suffix: '6557' account_type: corporate active: true created_time: 2023-02-26T20:00:00Z exp_date: '1227' is_default_account: true last_modified_time: 2023-02-26T21:00:00Z token: my_paymentcard_01 type: paymentcard user_token: my_user_01 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: Retrieve payment card source tags: - Account Holder Funding Sources put: description: |- Update a payment card funding source. Only the values of parameters specified in the request are modified; all others are left unchanged. operationId: putFundingsourcesFundingsourcetoken parameters: - description: |- Unique identifier of the funding source. Send a `GET` request to `/fundingsources/user/{user_token}` to retrieve existing funding source tokens for a user or to `/fundingsources/business/{business_token}` to retrieve existing funding source tokens for a business. explode: false in: path name: funding_source_token required: true schema: type: string style: simple requestBody: content: application/json: example: exp_date: '1227' is_default_account: false schema: $ref: '#/components/schemas/token_update_request' description: Payment card required: true responses: '200': content: application/json: example: account_suffix: '6557' account_type: DISCOVER active: true created_time: 2023-02-26T20:00:00Z exp_date: '1227' is_default_account: false last_modified_time: 2023-02-26T21:00:00Z token: my_paymentcard_01 type: paymentcard user_token: my_user_01 schema: $ref: '#/components/schemas/payment_card_response_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Update payment card source tags: - Account Holder Funding Sources /fundingsources/program: post: description: Create a program funding source. operationId: postFundingsourcesProgram requestBody: content: application/json: example: active: true name: my_programfundingsource_name token: my_programfundingsource_token schema: $ref: '#/components/schemas/program_funding_source_request' required: false responses: '201': content: application/json: example: account: 12.003.001.000147 active: true created_time: 2023-02-25T20:46:04Z last_modified_time: 2023-02-25T20:46:04Z name: my_programfundingsource_name token: my_programfundingsource_token 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: Create program source tags: - Program Funding Sources /fundingsources/program/ach: get: description: List ACH program funding sources. operationId: getAllACHFundingSources 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: |- 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: |- If `true`, returns ACH funding sources from active programs only. If `false`, returns all ACH funding sources. 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: List ACH program sources tags: - Program Funding Sources post: description: Create an ACH program funding source. operationId: postFundingsourcesProgramAch requestBody: content: application/json: example: account_number: '888271159' account_type: checking is_default_account: true name_on_account: John Doe routing_number: '121000357' verification_notes: testing verification_override: true schema: $ref: '#/components/schemas/base_ach_request_model' required: false responses: '200': content: application/json: example: account_suffix: '1156' account_type: checking active: true created_time: 2023-02-27T18:40:27Z is_default_account: true last_modified_time: 2023-02-27T18:40:27Z name_on_account: John Doe token: my_program_ach_source_token verification_status: ACH_VERIFIED 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: Create ACH program source tags: - Program Funding Sources /fundingsources/program/{token}: get: description: Retrieve a specific program funding source, whether active or inactive. operationId: getFundingsourcesProgramToken parameters: - description: Unique identifier of the program funding source. explode: false in: path name: token required: true schema: type: string style: simple responses: '201': content: application/json: example: account: 12.003.001.000147 active: true created_time: 2023-02-25T20:46:04Z last_modified_time: 2023-02-25T20:46:04Z name: my_programfundingsource_name token: my_programfundingsource_token schema: $ref: '#/components/schemas/program_funding_source_response' description: Success '404': content: { } description: Program funding source not found '500': content: { } description: Server error summary: Retrieve program source tags: - Program Funding Sources put: description: |- Update a program funding source. Only the values of parameters specified in the request are modified; all others are left unchanged. operationId: putFundingsourcesProgramToken parameters: - description: Unique identifier of the program funding source. explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: example: active: false name: your_programfundingsource_name schema: $ref: '#/components/schemas/program_funding_source_update_request' required: false responses: '200': content: application/json: example: account: 12.003.001.000147 active: true created_time: 2023-02-25T20:46:04Z last_modified_time: 2023-02-25T20:50:00Z name: your_programfundingsource_name token: my_programfundingsource_token schema: $ref: '#/components/schemas/program_funding_source_response' description: Success '400': content: { } description: Invalid fields detected '500': content: { } description: Server error summary: Update program source tags: - Program Funding Sources /fundingsources/programgateway: post: description: |- Creates a program gateway funding source. A program gateway funding source is a transaction relay that allows you to approve or decline transactions in real time. operationId: postFundingsourcesProgramgateway requestBody: content: application/json: example: basic_auth_password: my_20-to-100-character_password basic_auth_username: my_username name: my_pgfs_name token: my_pgfs_token url: https://my_secure_domain.com/my_gateway schema: $ref: '#/components/schemas/gateway_program_funding_source_request' required: false responses: '201': content: application/json: example: account: 12.003.001.000155 active: true basic_auth_password: my_20-to-100-character_password basic_auth_username: my_username created_time: 2023-02-28T20:00:00Z custom_header: my_header_name_1: my_value_1 my_header_name_2: my_value_2 my_header_name_3: my_value_3 last_modified_time: 2023-02-28T20:00:00Z name: my_pgfs_name timeout_millis: 3000 token: my_pgfs_token url: https://my_secure_domain.com/my_gateway use_mtls: false version: '2' 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: Create program gateway source tags: - Program Gateway Funding Sources /fundingsources/programgateway/customheaders/{token}: put: description: Adds or updates custom HTTP headers for a specific program gateway funding source. operationId: putFundingsourcesProgramgatewayCustomHeaderToken parameters: - description: Unique identifier of the program gateway funding source. 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/gateway_program_custom_header_update_request' required: false responses: '200': content: application/json: example: account: 12.003.001.000155 active: true basic_auth_password: my_20-to-100-character_password basic_auth_username: my_username created_time: 2023-02-28T20:00:00Z custom_header: my_header_name_1: my_value_1 my_header_name_2: my_value_2 my_header_name_3: my_value_3 last_modified_time: 2023-02-28T20:00:00Z name: my_pgfs_name timeout_millis: 3000 token: my_pgfs_token url: https://my_secure_domain.com/my_gateway use_mtls: false version: '2' schema: $ref: '#/components/schemas/gateway_program_funding_source_response' description: Success '400': content: { } description: Invalid fields detected '500': content: { } description: Server error summary: Update program gateway source custom headers tags: - Program Gateway Funding Sources /fundingsources/programgateway/{token}: get: description: Retrieves a specific program gateway funding source. operationId: getFundingsourcesProgramgatewayToken parameters: - description: Unique identifier of the program gateway funding source. explode: false in: path name: token required: true schema: type: string style: simple responses: '201': content: application/json: example: account: 12.003.001.000155 active: true basic_auth_password: my_20-to-100-character_password basic_auth_username: my_username created_time: 2023-02-28T20:00:00Z custom_header: my_header_name_1: my_value_1 my_header_name_2: my_value_2 my_header_name_3: my_value_3 last_modified_time: 2023-02-28T20:00:00Z name: my_pgfs_name timeout_millis: 3000 token: my_pgfs_token url: https://my_secure_domain.com/my_gateway use_mtls: false version: '2' schema: $ref: '#/components/schemas/gateway_program_funding_source_response' description: Success '404': content: { } description: Program gateway funding source not found '500': content: { } description: Server error summary: Retrieve program gateway source tags: - Program Gateway Funding Sources put: description: |- Update a program gateway funding source. Only the values of parameters specified in the request are modified; all others are left unchanged. operationId: putFundingsourcesProgramgatewayToken parameters: - description: Unique identifier of the program gateway funding source. explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: example: active: false basic_auth_password: my_20-to-100-character_password basic_auth_username: my_username url: https://my_secure_domain.com/my_gateway schema: $ref: '#/components/schemas/gateway_program_funding_source_update_request' required: false responses: '200': content: application/json: example: account: 12.003.001.000155 active: false basic_auth_password: my_20-to-100-character_password basic_auth_username: my_username created_time: 2023-02-28T20:00:00Z custom_header: my_header_name_1: my_value_1 my_header_name_2: my_value_2 my_header_name_3: my_value_3 last_modified_time: 2023-02-28T20:00:00Z name: my_pgfs_name timeout_millis: 3000 token: my_pgfs_token url: https://my_secure_domain.com/my_gateway use_mtls: false version: '2' schema: $ref: '#/components/schemas/gateway_program_funding_source_response' description: Success '400': content: { } description: Invalid fields detected '500': content: { } description: Server error summary: Update program gateway source tags: - Program Gateway Funding Sources /fundingsources/user/{user_token}: get: description: |- List funding sources associated with a specific user. This endpoint supports <>. operationId: getFundingsourcesUserUsertoken parameters: - description: Unique identifier of the user account holder. explode: false in: path name: user_token required: true schema: type: string style: simple - description: |- Type of funding source to retrieve: ACH or payment card. Leave unspecified to return both types. explode: true in: query name: 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 responses: '200': content: application/json: example: count: 2 data: - account_suffix: '4113' account_type: corporate active: true created_time: 2023-02-26T20:03:05Z exp_date: '1227' is_default_account: true last_modified_time: 2023-02-26T20:03:05Z token: jane_doe_paymentcard_01 type: paymentcard user_token: my_user_01 - account_suffix: '4321' account_type: savings active: false created_time: 2023-02-26T20:03:05Z date_sent_for_verification: 2023-02-27T23:27:58Z is_default_account: false last_modified_time: 2023-02-26T20:03:05Z name_on_account: Jane Doe token: jane_doe_ach_token type: ach user_token: my_user_01 verification_status: ACH_VERIFIED end_index: 1 is_more: false start_index: 0 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: List sources for user tags: - Account Holder Funding Sources /fundingsources/{funding_source_token}/default: put: description: |- Configure either an ACH funding source or a payment card funding source as the default funding source. A default funding source is used when you omit the `funding_source_token` field from funding requests, such as a `POST` request to `/gpaorders`. Note that the first funding source you create is automatically set as the default (`is_default_source=true`). operationId: putFundingsourcesFundingsourcetokenDefault parameters: - description: |- Unique identifier of the funding source. Send a `GET` request to `/fundingsources/user/{user_token}` to retrieve existing funding source tokens for a user or to `/fundingsources/business/{business_token}` to retrieve existing funding source tokens for a business. explode: false in: path name: funding_source_token required: true schema: type: string style: simple responses: '200': content: application/json: example: account_suffix: '4321' account_type: corporate active: true created_time: 2023-02-28T20:00:00Z exp_date: '1227' is_default_account: true last_modified_time: 2023-02-28T20:00:00Z token: jane_doe_paymentcard_token type: paymentcard user_token: my_user_01 schema: $ref: '#/components/schemas/payment_card_response_model' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Set default source tags: - Account Holder Funding Sources /gpaorders: post: description: |- Use this endpoint to create an order to fund an account holder's GPA. You can assess a <> while funding a GPA by using the optional `fees` array to attach one or more fee resources to the GPA order. When you create a GPA order, the GPA is first credited for the fees, then debited at funding time. operationId: postGpaorders requestBody: content: application/json: example: amount: 1000 currency_code: USD funding_source_token: my_program_funding_source_01 token: my_gpaorder_01 user_token: my_user_01 schema: $ref: '#/components/schemas/gpa_request' required: false responses: '201': content: application/json: example: amount: 1000 created_time: 2022-05-10T23:00:15Z currency_code: USD funding: amount: 1000 source: active: true created_time: 2022-11-30T19:13:23Z is_default_account: false last_modified_time: 2022-11-30T19:13:23Z name: my_program_funding_source_01 token: '**********e_01' type: program funding_source_token: '**********e_01' last_modified_time: 2022-05-10T23:00:15Z response: code: '0000' memo: Approved or completed successfully state: COMPLETION token: my_gpaorder_01 transaction_token: 156 user_token: my_user_01 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: Create GPA order tags: - GPA Orders /gpaorders/unloads: get: description: |- Use this endpoint to list all GPA unloads or GPA unloads associated with a specific user or business. This endpoint supports <> and <>. operationId: getGpaordersUnloads 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: |- 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 resource. 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 resource. 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 original GPA order. Send a `GET` request to `/transactions?type=gpa.credit` to retrieve GPA order tokens. explode: true in: query name: original_order_token required: false schema: type: string style: form responses: '200': content: application/json: example: count: 2 data[]: amount: 500 created_time: 2022-11-30T23:14:50Z funding: amount: 500 source: active: true created_time: 2022-03-31T19:13:23Z is_default_account: false last_modified_time: 2022-03-31T19:13:23Z name: my_program_funding_source_01 token: '**********e_01' type: program funding_source_token: '**********e_01' last_modified_time: 2022-11-30T23:15:50Z original_order_token: my_gpaorder_01 response: code: '0000' memo: Approved or completed successfully state: COMPLETION token: my_unload_01 transaction_token: '158' end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/GPAUnloadListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List GPA unloads tags: - GPA Orders post: description: |- Use this endpoint to unload a GPA order. Unloading a GPA order returns funds to the funding source. A GPA unload must be tied to an original GPA order and can be used to return the amount of the original order or a lesser amount. operationId: postGpaordersUnloads requestBody: content: application/json: example: amount: 500 original_order_token: my_gpaorder_01 token: my_unload_01 schema: $ref: '#/components/schemas/unload_request_model' required: false responses: '201': content: application/json: example: amount: 500 created_time: 2022-11-30T23:14:50Z funding: amount: 500 source: active: true created_time: 2022-03-31T19:13:23Z is_default_account: false last_modified_time: 2022-03-31T19:13:23Z name: my_program_funding_source_01 token: '**********e_01' type: program funding_source_token: '**********e_01' last_modified_time: 2022-11-30T23:30:50Z original_order_token: my_gpaorder_01 response: code: '0000' memo: Approved or completed successfully state: COMPLETION token: my_unload_01 transaction_token: '158' 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: Create GPA unload tags: - GPA Orders /gpaorders/unloads/{unload_token}: get: description: Use this endpoint to retrieve a specific GPA unload. operationId: getGpaordersUnloadsUnloadtoken parameters: - description: Unique identifier of the GPA unload. explode: false in: path name: unload_token required: true schema: type: string style: simple responses: '200': content: application/json: example: amount: 500 created_time: 2022-11-30T23:14:50Z funding: amount: 500 source: active: true created_time: 2022-03-31T19:13:23Z is_default_account: false last_modified_time: 2022-03-31T19:13:23Z name: my_program_funding_source_01 token: '**********e_01' type: program funding_source_token: '**********e_01' last_modified_time: 2022-11-30T23:15:50Z original_order_token: my_gpaorder_01 response: code: '0000' memo: Approved or completed successfully state: COMPLETION token: my_unload_01 transaction_token: '158' 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: Retrieve GPA unload tags: - GPA Orders /gpaorders/{token}: get: description: Use this endpoint to retrieve a GPA order. operationId: getGpaordersToken parameters: - description: |- Unique identifier of the GPA order. Send a `GET` request to `/transactions?type=gpa.credit` to retrieve GPA order tokens. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: amount: 1000 created_time: 2022-11-30T23:00:15Z currency_code: USD funding: amount: 1000 source: active: true created_time: 2022-03-31T19:13:23Z is_default_account: false last_modified_time: 2022-03-31T19:13:23Z name: my_program_funding_source_01 token: '**********e_01' type: program funding_source_token: '**********e_01' last_modified_time: 2022-11-30T23:10:15Z response: code: '0000' memo: Approved or completed successfully state: COMPLETION token: my_gpaorder_01 transaction_token: 156 user_token: my_user_01 schema: $ref: '#/components/schemas/gpa_response' description: Success '404': content: { } description: GPA order token not found '500': content: { } description: Server error summary: Retrieve GPA order tags: - GPA Orders /kyc: post: description: |- Use this endpoint to verify the identity of an account holder in the United States, either a user or a business. You can perform KYC verification on an account holder, provided the following are true: * The KYC status of the account holder is `UNVERIFIED` or `LIMITED` * The account holder has not been submitted for KYC verification twice === Required fields In order to perform KYC verification, the user or business resource on which you perform the check must have the following fields configured with valid values: [cols="1a,1a"] |=== | User Fields Required for KYC | Business Fields Required for KYC | * `first_name` * `last_name` * `address1` (cannot be a PO Box) * `city` * `state` * `postal_code` * `country` * `birth_date` * `ssn` (nine digits, no delimiters) | * `business_name_legal` (128 char max) * `business_name_dba` ("Doing Business As" or fictitious business name; enter the legal business name in this field if your business does not use a fictitious business name) * `office_location` (cannot be a PO Box; `state` field must use a <>) * `identifications` (nine digits, no delimiters) * `incorporation.incorporation_type` * `incorporation.state_of_incorporation` * `date_established` * `proprietor_or_officer` * `beneficial_owner` (maximum of four beneficial owners) * `proprietor_is_beneficial_owner` (required if the business proprietor or officer is also a beneficial owner) * `attestation_consent` * `attester_name` * `attestation_date` |=== ==== Valid state, provincial, and territorial abbreviations The following list includes all valid two-letter abbreviations for US states, territories, and military (APO/FPO/DPO) addresses. It also includes abbreviations for Canadian provinces and territories. State, provincial, and territorial abbreviations are case sensitive, and must be in uppercase as they appear in this list: * `AL`: Alabama * `AK`: Alaska * `AB`: Alberta * `AS`: American Samoa * `AZ`: Arizona * `AR`: Arkansas * `AE`: Armed Forces * `AA`: Armed Forces Americas * `AP`: Armed Forces Pacific * `BC`: British Columbia * `CA`: California * `CO`: Colorado * `CT`: Connecticut * `DE`: Delaware * `DC`: District of Columbia * `FL`: Florida * `GA`: Georgia * `GU`: Guam * `HI`: Hawaii * `ID`: Idaho * `IL`: Illinois * `IN`: Indiana * `IA`: Iowa * `KS`: Kansas * `KY`: Kentucky * `LA`: Louisiana * `ME`: Maine * `MB`: Manitoba * `MD`: Maryland * `MA`: Massachusetts * `MI`: Michigan * `MN`: Minnesota * `MS`: Mississippi * `MO`: Missouri * `MT`: Montana * `NE`: Nebraska * `NV`: Nevada * `NB`: New Brunswick * `NH`: New Hampshire * `NJ`: New Jersey * `NM`: New Mexico * `NY`: New York * `NF`: Newfoundland * `NC`: North Carolina * `ND`: North Dakota * `NT`: Northwest Territories * `NS`: Nova Scotia * `NU`: Nunavut * `OH`: Ohio * `OK`: Oklahoma * `ON`: Ontario * `OR`: Oregon * `PA`: Pennsylvania * `PE`: Prince Edward Island * `PR`: Puerto Rico * `QC`: Quebec * `RI`: Rhode Island * `SK`: Saskatchewan * `SC`: South Carolina * `SD`: South Dakota * `TN`: Tennessee * `TX`: Texas * `UT`: Utah * `VT`: Vermont * `VI`: Virgin Islands * `VA`: Virginia * `WA`: Washington * `WV`: West Virginia * `WI`: Wisconsin * `WY`: Wyoming * `YT`: Yukon Territory operationId: postKyc requestBody: content: application/json: examples: business_request_example: summary: '*Sample request body for a business*' value: business_token: my_biz01 token: my_bizkyc01 user_request_example: summary: '*Sample request body for a user*' value: manual_override: false token: my_userkyc01 user_token: my_user01 schema: $ref: '#/components/schemas/kyc_request' required: false responses: '201': content: application/json: examples: business_response_example: summary: '*Sample response body for a business*' value: business_token: my_biz01 created_time: 2022-02-08T19:52:58Z last_modified_time: 2022-02-08T19:52:58Z results: - component: BUSINESS outcome: SUCCESS outcome_reasons: [ ] reference_id: xxxxx - component: PROPRIETOR outcome: PENDING outcome_reasons: - SSNIssue - DOBIssue reference_id: yyyyy - component: BENEFICIAL_OWNER1 outcome: PENDING outcome_reasons: - AddressIssue reference_id: aaaaa - component: BENEFICIAL_OWNER2 outcome: SUCCESS outcome_reasons: [ ] reference_id: bbbbb - component: BENEFICIAL_OWNER3 outcome: SUCCESS outcome_reasons: [ ] reference_id: ccccc - component: BENEFICIAL_OWNER4 outcome: SUCCESS outcome_reasons: [ ] reference_id: ddddd status: PENDING token: my_bizkyc01 user_response_example: summary: '*Sample response body for a user*' value: created_time: 2022-02-08T19:52:58Z last_modified_time: 2022-02-08T19:52:58Z manual_override: false result: codes: - code: AddressIssue message: 'failed check: AddressIssue' status: failure token: my_userkyc01 user_token: my_user01 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: Perform KYC verification tags: - KYC Verification /kyc/business/{business_token}: get: description: |- Use this endpoint to retrieve all KYC verification results for a business. This endpoint supports <> and <>. === Business KYC outcome reasons (business response) The following tables describe KYC outcome reasons potentially returned in the `outcome_reasons` field of the business `result` response object when a business is in a `PENDING` or `FAILURE` state. Where possible, they also describe acceptable documents that your customers can submit to resolve `PENDING` outcomes. ==== Outcome reasons for the business These outcome reasons pertain to the business organization itself. [cols=",,2a"] |=== | Outcome Reason and State | Description | Accepted Documents | AddressIssue + `PENDING` | Missing, invalid, mismatched, or PO Box address. | One of the following documents. Document must show the full business name and address: * Bank statement * Utility bill * Current lease or rental agreement * Insurance policy | BusinessNameIssue + `PENDING` | Invalid or mismatched name. | Articles or certificate of incorporation. | OFACIssue + `FAILURE` | Business appears on an OFAC list. | This outcome requires a manual review by Marqeta to determine the next appropriate step. Contact your Marqeta representative. | RegistrationIssue + `PENDING` | Business is inactive, not registered, or not in good standing with the Secretary of State; recently reported or not recently updated. | This outcome requires a manual review by Marqeta to determine the next appropriate step. Contact your Marqeta representative. | Sanctions List Non-OFAC + `PENDING` | Business appears on a non-OFAC screening list, bankruptcy, or alert list. | This outcome requires a manual review by Marqeta to determine the next appropriate step. Contact your Marqeta representative. | TINIssue + `PENDING` | Missing, invalid, or mismatched Tax Identification Number (TIN). | IRS Notice Letter 147C or CP575, or most recent tax return. |=== ===== Outcome reasons for individuals associated with a business These outcome reasons pertain to individuals associated with a business: proprietors, business officers, and beneficial owners. [cols=",,2a"] |=== | Outcome Reason and State | Description | Accepted Documents | AddressIssue + `FAILURE` | Missing, invalid, mismatched, or PO Box address. | One of the following documents. Document must show the full name and address: * Unexpired state-issued driver's license or identification card * US Military Identification Card * Utility bill * Bank statement * Current rental or lease agreement * Mortgage statement | DateofBirthIssue + `FAILURE` | Invalid or mismatched date of birth. | Unexpired government-issued photo identification that shows name and date of birth: * Driver's license or state-issued identification card * Passport | NameIssue + `FAILURE` | Invalid or mismatched name. | Unexpired government-issued photo identification that has name and date of birth: * Driver's license or state-issued identification card * Passport or US passport card | NoRecordFound + `FAILURE` | No records were found for this individual. | As no record was found for this individual, supporting documentation must be provided for each attribute (name, date of birth, address, and SSN): * To verify an individual's address, provide one of these documents: ** Unexpired state-issued driver's license or identification card ** US Military Identification Card ** Utility bill ** Bank statement ** Current rental or lease agreement ** Mortgage statement * To verify an individual's name and date of birth, provide one of these documents: ** Driver's license or state-issued identification card ** Passport * To verify an individual's Social Security Number, provide one of these documents: ** Social Security card ** Recent W-2 or 1099 showing nine-digit SSN, full name, and address. ** ITIN card or document showing ITIN approval | OFAC + `FAILURE` | Appears on an Office of Foreign Assets Control (OFAC) list. | This outcome requires a manual review by Marqeta to determine the next appropriate step. Contact your Marqeta representative. | RiskIssue + `FAILURE` | Appears on a non-OFAC screening list, bankruptcy, or alert list, or has an insufficient record. | This outcome requires a manual review by Marqeta to determine the next appropriate step. Contact your Marqeta representative. | SSNFail + `FAILURE` | Social Security Number (SSN) appears on Network Alert List, is of a deceased person, or was issued before the individual's date of birth. | This outcome requires a manual review by Marqeta to determine the next appropriate step. Contact your Marqeta representative. | SSNIssue + `FAILURE` | Missing, invalid, or mismatched SSN. | * Social Security card * Recent W-2 or 1099 showing nine-digit SSN, full name, and address. * ITIN card or document showing ITIN approval |=== operationId: getKycBusinessBusinesstoken parameters: - description: The unique identifier of the business resource for which you want to retrieve KYC verification results. explode: false in: path name: business_token required: true schema: type: string style: simple - description: The number of 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: -createdTime type: string style: form responses: '200': content: application/json: example: count: 1 data: - business_token: my-business-token created_time: 2021-09-25T05:35:02Z last_modified_time: 2021-09-25T05:35:02Z manual_override: false result: status: pending token: 164dc008-1503-4932-a42d-27739346710f end_index: 0 is_more: false start_index: 0 schema: $ref: '#/components/schemas/KYCListResponse' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: List KYC results for a business tags: - KYC Verification /kyc/user/{user_token}: get: description: |- Use this endpoint to retrieve all KYC results for a user. This endpoint supports <> and <>. === User KYC failure codes The following table lists KYC failure codes potentially returned in the response when a user does not pass verification. It also includes a list of acceptable documents that your customers can submit to resolve failures. [cols=",,2a"] |=== | Failure Code and State | Description | Accepted Documents | AddressIssue + `FAILURE` | Missing, invalid, mismatched, or PO Box address. | One of the following documents. Document must show the full name and address: * Unexpired state-issued driver's license or identification card * US Military Identification Card * Utility bill * Bank statement * Current rental or lease agreement * Mortgage statement | DateofBirthIssue + `FAILURE` | Invalid or mismatched date of birth. | Unexpired government-issued photo identification that shows name and date of birth: * Driver's license or state-issued identification card * Passport | NameIssue + `FAILURE` | Invalid or mismatched name. | Unexpired government-issued photo identification that has name and date of birth: * Driver's license or state-issued identification card * Passport or US passport card | NoRecordFound + `FAILURE` | No records were found for this individual. | As no record was found for this individual, supporting documentation must be provided for each attribute (name, date of birth, address, and SSN): * To verify an individual's address, provide one of these documents: ** Unexpired state-issued driver's license or identification card ** US Military Identification Card ** Utility bill ** Bank statement ** Current rental or lease agreement ** Mortgage statement * To verify an individual's name and date of birth, provide one of these documents: ** Driver's license or state-issued identification card ** Passport * To verify an individual's Social Security Number, provide one of these documents: ** Social Security card ** Recent W-2 or 1099 showing nine-digit SSN, full name, and address. ** ITIN card or document showing ITIN approval | OFAC + `FAILURE` | Appears on an Office of Foreign Assets Control (OFAC) list. | This outcome requires a manual review by Marqeta to determine the next appropriate step. Contact your Marqeta representative. | RiskIssue + `FAILURE` | Appears on a non-OFAC screening list, bankruptcy, or alert list, or has an insufficient record. | This outcome requires a manual review by Marqeta to determine the next appropriate step. Contact your Marqeta representative. | SSNFail + `FAILURE` | Social Security Number (SSN) appears on Network Alert List, is of a deceased person, or was issued before the individual's date of birth. | This outcome requires a manual review by Marqeta to determine the next appropriate step. Contact your Marqeta representative. | SSNIssue + `FAILURE` | Missing, invalid, or mismatched SSN. | * Social Security card * Recent W-2 or 1099 showing nine-digit SSN, full name, and address. * ITIN card or document showing ITIN approval |=== operationId: getKycUserUsertoken parameters: - description: Unique identifier of the user resource for which you want to retrieve KYC verification results. explode: false in: path name: user_token required: true schema: type: string style: simple - 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: 2 data: - created_time: 2022-03-07T23:17:36Z last_modified_time: 2022-03-07T23:17:36Z manual_override: false result: status: success token: my_user_01_kyc_02 user_token: my_user_01 - created_time: 2022-03-08T18:00:00Z last_modified_time: 2022-03-08T18:00:00Z manual_override: false result: status: failure token: my_user_01_kyc_01 user_token: my_user_01 end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/KYCListResponse' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: List KYC results for a user tags: - KYC Verification /kyc/{token}: get: description: Use this endpoint to retrieve a specific KYC result. operationId: getKycToken parameters: - description: Unique identifier of the KYC verification for which you want to retrieve the result. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: created_time: 2022-03-07T22:52:39Z last_modified_time: 2022-03-07T22:52:39Z manual_override: false result: status: success token: my_user_01_kyc_01 user_token: my_user_01 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: Retrieve KYC result tags: - KYC Verification /mccgroups: get: description: |- Use this endpoint to list all MCC groups defined in your program or list MCC groups that contain a specified code. This endpoint supports <> and <>. operationId: getMccgroups parameters: - description: Returns all MCC groups that contain the specified merchant category code. explode: true in: query name: mcc required: false schema: type: string style: form - description: The number of resources 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: |- 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: schema: $ref: '#/components/schemas/MCCGroupListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List MCC groups tags: - MCC Groups post: description: Use this endpoint to create an MCC group. 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: Create MCC group tags: - MCC Groups /mccgroups/{token}: get: description: Use this endpoint to retrieve a specific MCC group. operationId: getMccgroupsToken parameters: - description: Unique identifier of the MCC group. 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: Retrieve MCC group tags: - MCC Groups put: description: |- Use this endpoint to update an MCC group. Include the `token` path parameter to identify the MCC group to update. You must pass all the merchant category codes you want included in the group, including existing ones you want to retain. operationId: putMccgroupsToken parameters: - description: |- The unique identifier of the MCC group. Send a `GET` request to `/mccgroups` to retrieve MCC group tokens. 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: Update MCC group tags: - MCC Groups /merchantgroups: get: description: |- To return an array of all merchant groups, send a `GET` request to the `/merchantgroups` endpoint. To return an array of all merchant groups that include a specific merchant identifier, send a `GET` request to the `/merchantgroups` endpoint that includes the merchant identifier in the query parameters. operationId: getMerchantGroups parameters: - description: Returns all merchant groups that contain the specified merchant identifier. explode: true in: query name: mid required: false schema: type: string style: form - description: Number of resources to retrieve. explode: true in: query name: count required: false schema: default: 10 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: -lastModifiedTime type: string style: form responses: '200': content: application/json: example: count: 2 data: - active: true created_time: 2022-05-01T13:22:07Z last_modified_time: 2022-05-01T13:32:07Z mids: - '123456789012345' - '345123456789012' - '123456789012' name: My Merchant Group token: my_merchantgroup - active: true created_time: 2021-05-02T01:42:07Z last_modified_time: 2022-05-02T01:42:07Z mids: - '998877665544331' - '246813579000' name: My Merchant Group 01 token: my_merchantgroup_01 end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/MerchantGroupListResponse' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: List merchant groups tags: - Merchant Groups post: description: To create a merchant group, send a `POST` request to the `/merchantgroups` endpoint. operationId: postMerchantGroup requestBody: content: application/json: example: active: true mids: - '123456789012345' - '345123456789012' - '123456789012' name: My Merchant Group token: my_merchantgroup schema: $ref: '#/components/schemas/merchant_group_request' required: false responses: '201': content: application/json: example: active: true created_time: 2022-05-01T13:22:07Z last_modified_time: 2022-05-01T13:22:07Z mids: - '123456789012345' - '345123456789012' - '123456789012' name: My Merchant Group token: my_merchantgroup 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: Create merchant group tags: - Merchant Groups /merchantgroups/{token}: get: description: |- To retrieve a specific merchant group, send a `GET` request to the `/merchantgroups/{token}` endpoint. Include the merchant group `token` path parameter to specify the merchant group to return. operationId: getMerchantGroup parameters: - description: Unique identifier of the merchant 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-05-01T13:22:07Z last_modified_time: 2022-05-01T13:32:07Z mids: - '123456789012345' - '345123456789012' - '123456789012' - '234567890123' name: My Merchant Group token: my_merchantgroup 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: Retrieve merchant group tags: - Merchant Groups put: description: |- To update a merchant group, send a `PUT` request to the `/merchantgroups/{token}` endpoint. Include the merchant group `token` path parameter to specify the merchant group to update. operationId: putMerchantGroupsToken parameters: - description: Unique identifier of the merchant group. explode: false in: path name: token required: true schema: type: string style: simple requestBody: content: application/json: example: active: true mids: - '234567890123' name: My Merchant Group schema: $ref: '#/components/schemas/merchant_group_update_request' description: Merchant Group required: true responses: '200': content: application/json: example: active: true created_time: 2022-05-01T13:22:07Z last_modified_time: 2022-05-01T13:32:07Z mids: - '123456789012345' - '345123456789012' - '123456789012' - '234567890123' name: My Merchant Group token: my_merchantgroup schema: $ref: '#/components/schemas/merchant_group_response' description: Success '400': content: { } description: Bad request '500': content: { } description: Server error summary: Update merchant group tags: - Merchant Groups /peertransfers: post: description: |- Use this endpoint to request a peer transfer (i.e., a movement of funds from the GPA of an account holder to another account belonging to the same account holder). Add the source details to the body of the request in link:http://www.json.org/[JSON, window="_blank"] format. When creating a peer transfer request, you must pass in both a token to identify the fee sender (either `sender_user_token` or `sender_business_token`) and a token to identify the fee recipient (either `recipient_user_token` or `recipient_business_token`). The sender and recipient objects must already exist. [NOTE] This feature is disabled by default and requires activation by Marqeta. + + This feature enables you to transfer or reallocate funds where the `sender_*\_token` and the `recipient_*_token` belong to the same account holder. It does not allow you to transfer or reallocate funds between different account holders. Contact your Marqeta representative for more information. operationId: postPeertransfers requestBody: content: application/json: example: amount: 50.0 currency_code: USD recipient_user_token: my_user_01_account_2 sender_user_token: my_user_01 token: my_peertransfer_01 schema: $ref: '#/components/schemas/peer_transfer_request' required: false responses: '201': content: application/json: example: amount: 50.0 created_time: 2023-03-11T19:15:01Z currency_code: USD recipient_user_token: my_user_01_account_2 sender_user_token: my_user_01 token: my_peertransfer_01 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: Create peer transfer tags: - Peer Transfers /peertransfers/user/{user_or_business_token}: get: description: |- Use this endpoint to list peer transfers sent or received by a particular account holder. Include a user or business token as a path parameter to identify the account holder whose transfers you want to list. This endpoint supports <> and <>. operationId: getPeertransfersUserUserorbusinesstoken parameters: - description: |- Existing user or business token. Send a `GET` request to `/users` to retrieve user tokens or to `/businesses` to retrieve business tokens. explode: false in: path name: user_or_business_token required: true schema: type: string style: simple - description: Number of peer transfer resources to retrieve. explode: true in: query name: count required: false schema: default: 25 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 responses: '200': content: application/json: example: amount: 40.0 count: 1 created_time: 2023-03-11T20:41:27Z currency_code: USD data[]: null end_index: 2 is_more: false recipient_user_token: my_user_01_account_2 sender_user_token: my_user_01 start_index: 0 token: my_peertransfer_01 schema: $ref: '#/components/schemas/peer_transfer_response' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: List peer transfers by account holder tags: - Peer Transfers /peertransfers/user/{user_or_business_token}/recipient: get: description: |- Use this endpoint to list peer transfers sent by an account holder. Include a user or business token as a path parameter to identify the recipient. This endpoint supports <> and <>. operationId: getPeertransfersUserUserorbusinesstokenRecipient parameters: - description: |- Existing user or business token. Send a `GET` request to `/users` to retrieve user tokens or to `/businesses` to retrieve business tokens. explode: false in: path name: user_or_business_token required: true schema: type: string style: simple - description: Number of peer transfer resources to retrieve. explode: true in: query name: count required: false schema: default: 25 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 responses: '200': content: application/json: example: amount: 40.0 count: 3 created_time: 2023-03-11T20:41:27Z currency_code: USD data[]: null end_index: 2 is_more: false recipient_user_token: my_user_01_account_2 sender_user_token: my_user_01 start_index: 0 token: my_peertransfer_01 schema: $ref: '#/components/schemas/peer_transfer_response' description: Success '404': content: { } description: User token not found '500': content: { } description: Server error summary: List received peer transfers tags: - Peer Transfers /peertransfers/user/{user_or_business_token}/sender: get: description: |- Use this endpoint to list peer transfers sent by an account holder. Include a user or business token as a path parameter to identify the sender. This endpoint supports <> and <>. operationId: getPeertransfersUserUserorbusinesstokenSender parameters: - description: |- Existing user or business token. Send a `GET` request to `/users` to retrieve user tokens or to `/businesses` to retrieve business tokens. explode: false in: path name: user_or_business_token required: true schema: type: string style: simple - description: Number of peer transfer resources to retrieve. explode: true in: query name: count required: false schema: default: 25 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 responses: '200': content: application/json: example: amount: 40.0 count: 3, created_time: 2023-05-11T20:41:27Z currency_code: USD data[]: null end_index: 2 is_more: false recipient_user_token: my_user_01_account_2 sender_user_token: my_user_01 start_index: 0 token: my_peertransfer_01 schema: $ref: '#/components/schemas/peer_transfer_response' description: Success '400': content: { } description: User input error/Bad request '500': content: { } description: Server error summary: List sent peer transfers tags: - Peer Transfers /peertransfers/{token}: get: description: |- Use this endpoint to retrieve a peer transfer request. Include the peer transfer `token` as a path parameter in the URL to identify the peer transfer to return. operationId: getPeertransfersToken parameters: - description: Unique identifier of the peer transfer. explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: amount: 50.0 created_time: 2023-03-11T19:15:01Z currency_code: USD recipient_user_token: my_user_01_account_2 sender_user_token: my_user_01 token: my_peertransfer_01 schema: $ref: '#/components/schemas/peer_transfer_response' description: Success '404': content: { } description: Transfer token not found '500': content: { } description: Server error summary: Retrieve peer 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. 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. *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 instead to update a card's PIN, 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 /programreserve/balances: get: description: Use this endpoint to return balances for your program reserve 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/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: 2023-02-10T21:52:18Z currency_code: USD last_modified_time: 2023-02-10T21:52:18Z memo: my_memo tags: my, tags token: my_deposit_02 transaction_token: '154' type: CREDIT - amount: 100.0 created_time: 2023-02-10T21:51:28Z currency_code: USD last_modified_time: 2023-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 /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 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 /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: 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: 2021-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: 2021-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: 2021-08-21T17:25:43Z is_default_account: false last_modified_time: 2021-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: 2021-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: 2021-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: 2021-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: 2021-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: 2021-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: 2021-08-21T17:25:43Z is_default_account: false last_modified_time: 2021-08-21T17:25:43Z name: PGFS for simulating transactions token: '**********dd5f' type: programgateway user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 last_modified_time: 2021-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: 2021-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: 2021-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: 2021-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: 2021-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: 2021-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: 2021-08-21T17:25:43Z is_default_account: false last_modified_time: 2021-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: 2021-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: 2021-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: 2021-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: 2021-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: 2021-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: 2021-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: 2021-08-21T17:25:43Z is_default_account: false last_modified_time: 2021-08-21T17:25:43Z name: PGFS for simulating transactions token: '**********dd5f' type: programgateway user_token: 99f323d4-298f-4b0c-93b1-19b2d9921eb8 last_modified_time: 2021-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: 2021-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: 2021-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: '5105551212' 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: '5105551212' 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.\nA new user's initial\ \ status depends on the <> of the program or associated <>.\n\n[cols=\"1,1,1,1\"]\n|===\n| KYC Required | Initial\ \ User Status | User Active on Creation | User Limitations\n\n| Always\n|\ \ `UNVERIFIED`\n| Optional\n| Cannot load funds; cannot activate cards.\n\n\ | Conditionally\n| `LIMITED`\n| Optional\n| Restricted by rules in `accountholdergroups.pre_kyc_controls`.\n\ \n| Never\n| `ACTIVE`\n| Required\n| None.\n|===\n\n[NOTE]\nUse the `/usertransitions`\ \ endpoints to transition user resources between statuses and to view the\ \ history of a user's status.\nDo not set the value of the `user.active` field\ \ directly.\nFor more information on status changes, see <>. \n\nTo perform KYC verification on users, the\ \ user object must have the following fields configured:\n\n* `first_name`\n\ * `last_name`\n* `address1` (cannot be a PO Box)\n* `city`\n* `state`\n* `postal_code`\n\ * `country`\n* `birth_date`\n* `identifications`\n\n[NOTE]\nThe `identifications`\ \ requirement depends on your program's configuration.\nTo determine if you\ \ should provide a full or abbreviated identification number, contact your\ \ Marqeta representative.\nKYC verification requires the full Social Security\ \ Number (SSN) of the user.\n\nTo create a child user, you must identify the\ \ parent user or business and determine whether the child user shares an account\ \ with the parent.\n\nThe parent must be an existing user or business.\nOn\ \ the child user, set the `parent_token` field to the value of the parent's\ \ `token` field.\nIf either the parent or the grandparent is a business, a\ \ `business_token` field is added to the user.\nThis field's value is set\ \ to the token of either the parent or grandparent (whichever is the business).\n\ \nThe `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`).\nIf 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.\nThis field cannot be updated, so you\ \ must decide upon creation whether the child user shares the parent balance.\n\ \nSharing an account with a parent user affects how the child user interacts\ \ with cards as follows:\n\n* A child user cannot spend funds if its parent\ \ is not active.\n* 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 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: '5105551212' postal_code: '94702' state: CA 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 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: '5105551212' ssn: '5555' state: CA status: ACTIVE 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: '5105551212' 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/{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: '5101111111' 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 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: '5105551212' postal_code: '94702' state: CA status: ACTIVE 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}/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, 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="2,4a,4a"] |=== | 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` | Cannot load funds or activate cards. *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` | Cannot load funds or activate cards. *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` | Cannot load funds or activate cards. *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: 2023-03-15T00:00:00Z 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: 2023-03-15T00:00:00Z 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: 2023-03-15T00:00:00Z 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.0 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.0 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.0 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/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: