{ "opencollection": "1.0.0", "info": { "name": "Lithic Developer API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Account Holder", "type": "folder" }, "items": [ { "info": { "name": "Get a list of individual or business account holders", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/account_holders", "params": [ { "name": "external_id", "value": "00000000-0000-0000-0000-000000000001", "type": "query", "description": "If applicable, represents the external_id associated with the account_holder." }, { "name": "limit", "value": "10", "type": "query", "description": "The number of account_holders to limit the response to." }, { "name": "first_name", "value": "John", "type": "query", "description": "(Individual Account Holders only) The first name of the account holder. The query is case insensitive and supports partial matches." }, { "name": "last_name", "value": "Appleseed", "type": "query", "description": "(Individual Account Holders only) The last name of the account holder. The query is case insensitive and supports partial matches." }, { "name": "legal_business_name", "value": "Busy Business, Inc.", "type": "query", "description": "(Business Account Holders only) The legal business name of the account holder. The query is case insensitive and supports partial matches." }, { "name": "phone_number", "value": "+15555555555", "type": "query", "description": "Phone number of the account holder. The query must be an exact match." }, { "name": "email", "value": "example@domain.com", "type": "query", "description": "Email address of the account holder. The query must be an exact match, case insensitive." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." } ] }, "docs": "Get a list of individual or business account holders and their KYC or KYB evaluation status." }, { "info": { "name": "Create an individual or business account holder", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/account_holders", "body": { "type": "json", "data": "{}" } }, "docs": "Create an account holder and initiate the appropriate onboarding workflow. Account holders and accounts have a 1:1 relationship. When an account holder is successfully created an associated account is also created.\nAll calls to this endpoint will return a synchronous response. The response time will depend on the workflow. In some cases, the response may indicate the workflow is under review or further action will be needed to complete the account creation process.\nThis endpoint can only be use" }, { "info": { "name": "Get an individual or business account holder", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/account_holders/:account_holder_token", "params": [ { "name": "account_holder_token", "value": "", "type": "path", "description": "Globally unique identifier for the account holder." } ] }, "docs": "Get an Individual or Business Account Holder and/or their KYC or KYB evaluation status." }, { "info": { "name": "Update account holder information and possibly resubmit for evaluation", "type": "http" }, "http": { "method": "PATCH", "url": "https://sandbox.lithic.com/v1/account_holders/:account_holder_token", "params": [ { "name": "account_holder_token", "value": "", "type": "path", "description": "Globally unique identifier for the account holder." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the information associated with a particular account holder (including business owners and control persons associated to a business account).\nIf Lithic is performing KYB or KYC and additional verification is required we will run the individual's or business's updated information again and return whether the status is accepted or pending (i.e., further action required).\nAll calls to this endpoint will return a synchronous response. The response time will depend on the workflow. In some cas" }, { "info": { "name": "Get account holder document uploads", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/account_holders/:account_holder_token/documents", "params": [ { "name": "account_holder_token", "value": "", "type": "path", "description": "Globally unique identifier for the account holder." } ] }, "docs": "Retrieve the status of account holder document uploads, or retrieve the upload URLs to process your image uploads.\n\nNote that this is not equivalent to checking the status of the KYC evaluation overall (a document may be successfully uploaded but not be sufficient for KYC to pass).\n\nIn the event your upload URLs have expired, calling this endpoint will refresh them.\nSimilarly, in the event a previous account holder document upload has failed, you can use this endpoint to get a new upload URL for" }, { "info": { "name": "Initiate account holder document upload", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/account_holders/:account_holder_token/documents", "params": [ { "name": "account_holder_token", "value": "", "type": "path", "description": "Globally unique identifier for the account holder." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to identify which type of supported government-issued documentation you will upload for further verification.\nIt will return two URLs to upload your document images to - one for the front image and one for the back image.\n\nThis endpoint is only valid for evaluations in a `PENDING_DOCUMENT` state.\n\nSupported file types include `jpg`, `png`, and `pdf`. Each file must be less than 15 MiB. Once both required uploads have been successfully completed, your document will be run throug" }, { "info": { "name": "Get account holder document upload status", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/account_holders/:account_holder_token/documents/:document_token", "params": [ { "name": "account_holder_token", "value": "", "type": "path", "description": "Globally unique identifier for the account holder." }, { "name": "document_token", "value": "", "type": "path", "description": "Globally unique identifier for the document." } ] }, "docs": "Check the status of an account holder document upload, or retrieve the upload URLs to process your image uploads.\n\nNote that this is not equivalent to checking the status of the KYC evaluation overall (a document may be successfully uploaded but not be sufficient for KYC to pass).\n\nIn the event your upload URLs have expired, calling this endpoint will refresh them.\nSimilarly, in the event a document upload has failed, you can use this endpoint to get a new upload URL for the failed image upload." }, { "info": { "name": "Create a new beneficial owner individual or replace the existing control person entity", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/account_holders/:account_holder_token/entities", "params": [ { "name": "account_holder_token", "value": "", "type": "path", "description": "Globally unique identifier for the account holder." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new beneficial owner individual or replace the control person entity on an existing KYB account holder. This endpoint is only applicable for account holders enrolled through a KYB workflow with the Persona KYB provider.\nA new control person can only replace the existing one. A maximum of 4 beneficial owners can be associated with an account holder." }, { "info": { "name": "Deactivate a beneficial owner individual", "type": "http" }, "http": { "method": "DELETE", "url": "https://sandbox.lithic.com/v1/account_holders/:account_holder_token/entities/:entity_token", "params": [ { "name": "account_holder_token", "value": "", "type": "path", "description": "Globally unique identifier for the account holder." }, { "name": "entity_token", "value": "", "type": "path", "description": "Globally unique identifier for the entity." } ] }, "docs": "Deactivate a beneficial owner individual on an existing KYB account holder. Only beneficial owner individuals can be deactivated." }, { "info": { "name": "Simulate an account holder's enrollment review", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/simulate/account_holders/enrollment_review", "body": { "type": "json", "data": "{}" } }, "docs": " Simulates an enrollment review for an account holder. This endpoint is only applicable for workflows that may required intervention such as `KYB_BASIC`. " }, { "info": { "name": "Simulate an account holder document upload's review", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/simulate/account_holders/enrollment_document_review", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates a review for an account holder document upload." } ] }, { "info": { "name": "Account", "type": "folder" }, "items": [ { "info": { "name": "List accounts", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/accounts", "params": [ { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List account configurations.\n" }, { "info": { "name": "Get account", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/accounts/:account_token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Globally unique identifier for account." } ] }, "docs": "Get account configuration such as spend limits." }, { "info": { "name": "Update account", "type": "http" }, "http": { "method": "PATCH", "url": "https://sandbox.lithic.com/v1/accounts/:account_token", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Globally unique identifier for account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update account configuration such as state or spend limits. Can only be run on accounts that are part of the program managed by this API key.\nAccounts that are in the `PAUSED` state will not be able to transact or create new cards.\n" }, { "info": { "name": "Get account's available spend limits", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/accounts/:account_token/spend_limits", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "Globally unique identifier for account." } ] }, "docs": "Get an Account's available spend limits, which is based on the spend limit configured on the Account and the amount already spent over the spend limit's duration. For example, if the Account has a daily spend limit of $1000 configured, and has spent $600 in the last 24 hours, the available spend limit returned would be $400." }, { "info": { "name": "Fetch account signals", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/accounts/:account_token/signals", "params": [ { "name": "account_token", "value": "", "type": "path", "description": "The token of the account to fetch signals for." } ] }, "docs": "Returns behavioral feature state derived from an account's transaction history.\n\nThese signals expose the same data used by behavioral rule attributes (e.g. `AMOUNT_Z_SCORE`\nwith `scope: ACCOUNT`, `IS_NEW_COUNTRY` with `scope: ACCOUNT`) and custom code\n`TRANSACTION_HISTORY_SIGNALS` features, allowing clients to inspect feature values before\nwriting rules and debug rule behavior.\n\nNote: 3DS fields are not available at the account scope and will be null.\n" } ] }, { "info": { "name": "Auth Rules", "type": "folder" }, "items": [ { "info": { "name": "List rules", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v2/auth_rules", "params": [ { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." }, { "name": "card_token", "value": "", "type": "query", "description": "Only return Auth Rules that are bound to the provided card token." }, { "name": "account_token", "value": "", "type": "query", "description": "Only return Auth Rules that are bound to the provided account token." }, { "name": "business_account_token", "value": "", "type": "query", "description": "Only return Auth Rules that are bound to the provided business account token." }, { "name": "scope", "value": "", "type": "query", "description": "Only return Auth Rules that are bound to the provided scope." }, { "name": "event_stream", "value": "", "type": "query", "description": "Deprecated: Use event_streams instead. Only return Auth rules that are executed during the provided event stream." }, { "name": "event_streams", "value": "", "type": "query", "description": "Only return Auth rules that are executed during any of the provided event streams. If event_streams and event_stream are specified, the values will be combined." } ] }, "docs": "Lists V2 Auth rules" }, { "info": { "name": "Create a new rule", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v2/auth_rules", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new V2 Auth rule in draft mode" }, { "info": { "name": "Fetch a rule", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v2/auth_rules/:auth_rule_token", "params": [ { "name": "auth_rule_token", "value": "", "type": "path" } ] }, "docs": "Fetches a V2 Auth rule by its token" }, { "info": { "name": "Update a rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://sandbox.lithic.com/v2/auth_rules/:auth_rule_token", "params": [ { "name": "auth_rule_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a V2 Auth rule's properties\n\nIf `account_tokens`, `card_tokens`, `program_level`, `excluded_card_tokens`, `excluded_account_tokens`, or `excluded_business_account_tokens` is provided, this will replace existing associations with the provided list of entities.\n" }, { "info": { "name": "Delete a rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://sandbox.lithic.com/v2/auth_rules/:auth_rule_token", "params": [ { "name": "auth_rule_token", "value": "", "type": "path" } ] }, "docs": "Deletes a V2 Auth rule" }, { "info": { "name": "Draft a new rule version", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v2/auth_rules/:auth_rule_token/draft", "params": [ { "name": "auth_rule_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new draft version of a rule that will be ran in shadow mode.\n\nThis can also be utilized to reset the draft parameters, causing a draft version to no longer be ran in shadow mode.\n" }, { "info": { "name": "Calculated Feature values", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v2/auth_rules/:auth_rule_token/features", "params": [ { "name": "auth_rule_token", "value": "", "type": "path" }, { "name": "account_token", "value": "", "type": "query" }, { "name": "card_token", "value": "", "type": "query" } ] }, "docs": "Fetches the current calculated Feature values for the given Auth Rule\n\nThis only calculates the features for the active version.\n- VelocityLimit Rules calculates the current Velocity Feature data. This requires a `card_token` or `account_token` matching what the rule is Scoped to.\n- ConditionalBlock Rules calculates the CARD_TRANSACTION_COUNT_* attributes on the rule. This requires a `card_token`\n" }, { "info": { "name": "Promote a rule version", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v2/auth_rules/:auth_rule_token/promote", "params": [ { "name": "auth_rule_token", "value": "", "type": "path" } ] }, "docs": "Promotes the draft version of an Auth rule to the currently active version such that it is enforced in the respective stream." }, { "info": { "name": "List rule versions", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v2/auth_rules/:auth_rule_token/versions", "params": [ { "name": "auth_rule_token", "value": "", "type": "path" } ] }, "docs": "Returns all versions of an auth rule, sorted by version number descending (newest first)." }, { "info": { "name": "Retrieve a performance report", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v2/auth_rules/:auth_rule_token/report", "params": [ { "name": "auth_rule_token", "value": "", "type": "path" }, { "name": "begin", "value": "", "type": "query", "description": "Start date for the report" }, { "name": "end", "value": "", "type": "query", "description": "End date for the report" } ] }, "docs": "Retrieves a performance report for an Auth rule containing daily statistics and evaluation outcomes.\n\n**Time Range Limitations:**\n- Reports are supported for the past 3 months only\n- Maximum interval length is 1 month\n- Report data is available only through the previous day in UTC (current day data is not available)\n\nThe report provides daily statistics for both current and draft versions of the Auth rule, including approval, decline, and challenge counts along with sample events.\n" }, { "info": { "name": "List backtests", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v2/auth_rules/:auth_rule_token/backtests", "params": [ { "name": "auth_rule_token", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "Lists backtests for an Auth Rule" }, { "info": { "name": "Request a backtest", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v2/auth_rules/:auth_rule_token/backtests", "params": [ { "name": "auth_rule_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates a request to asynchronously generate a backtest for an Auth rule. During backtesting, both the active version (if one exists) and the draft version of the Auth Rule are evaluated by replaying historical transaction data against the rule's conditions. This process allows customers to simulate and understand the effects of proposed rule changes before deployment.\nThe generated backtest report provides detailed results showing whether the draft version of the Auth Rule would have approved" }, { "info": { "name": "Retrieve backtest results", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v2/auth_rules/:auth_rule_token/backtests/:auth_rule_backtest_token", "params": [ { "name": "auth_rule_token", "value": "", "type": "path" }, { "name": "auth_rule_backtest_token", "value": "", "type": "path" } ] }, "docs": "Returns the backtest results of an Auth rule (if available).\n\nBacktesting is an asynchronous process that requires time to complete. If a customer retrieves the backtest results using this endpoint before the report is fully generated, the response will return null for `results.current_version` and `results.draft_version`. Customers are advised to wait for the backtest creation process to complete (as indicated by the webhook event auth_rules.backtest_report.created) before retrieving results fr" }, { "info": { "name": "List rule evaluation results", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v2/auth_rules/results", "params": [ { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." }, { "name": "event_token", "value": "", "type": "query", "description": "Filter by event token" }, { "name": "auth_rule_token", "value": "", "type": "query", "description": "Filter by Auth Rule token" }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only events evaluated after the specified time will be included. UTC time zone." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only events evaluated before the specified time will be included. UTC time zone." }, { "name": "has_actions", "value": "", "type": "query", "description": "Filter by whether the rule evaluation produced any actions. When not provided, all results are returned." } ] }, "docs": "Lists Auth Rule evaluation results.\n\n**Limitations:**\n- Results are available for the past 3 months only\n- At least one filter (`event_token` or `auth_rule_token`) must be provided\n- When filtering by `event_token`, pagination is not supported\n" } ] }, { "info": { "name": "Card", "type": "folder" }, "items": [ { "info": { "name": "Fetch card signals", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/cards/:card_token/signals", "params": [ { "name": "card_token", "value": "", "type": "path", "description": "The token of the card to fetch signals for." } ] }, "docs": "Returns behavioral feature state derived from a card's transaction history.\n\nThese signals expose the same data used by behavioral rule attributes (e.g. `AMOUNT_Z_SCORE` with `scope: CARD`, `IS_NEW_COUNTRY` with `scope: CARD`) and custom code `TRANSACTION_HISTORY_SIGNALS` features, allowing clients to inspect feature values before writing rules and debug rule behavior.\n" }, { "info": { "name": "List card programs", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/card_programs", "params": [ { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List card programs." }, { "info": { "name": "Get card program", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/card_programs/:card_program_token", "params": [ { "name": "card_program_token", "value": "", "type": "path", "description": "Globally unique identifier for the card program." } ] }, "docs": "Get card program." }, { "info": { "name": "List cards", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/cards", "params": [ { "name": "account_token", "value": "", "type": "query", "description": "Returns cards associated with the specified account.\n" }, { "name": "state", "value": "", "type": "query", "description": "Returns cards with the specified state.\n" }, { "name": "memo", "value": "", "type": "query", "description": "Returns cards containing the specified partial or full memo text.\n" }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List cards." }, { "info": { "name": "Create card", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/cards", "headers": [ { "name": "Idempotency-Key", "value": "65a9dad4-1b60-4686-83fd-65b25078a4b4" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new virtual or physical card. Parameters `shipping_address` and `product_id` only apply to physical cards.\n" }, { "info": { "name": "Search for card by PAN", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/cards/search_by_pan", "body": { "type": "json", "data": "{}" } }, "docs": "Get card configuration such as spend limit and state. Customers must be PCI compliant to use this endpoint. Please contact [support@lithic.com](mailto:support@lithic.com) for questions.\n*Note: this is a `POST` endpoint because it is more secure to send sensitive data in a request body than in a URL.*" }, { "info": { "name": "Get card", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/cards/:card_token", "params": [ { "name": "card_token", "value": "", "type": "path" } ] }, "docs": "Get card configuration such as spend limit and state." }, { "info": { "name": "Update card", "type": "http" }, "http": { "method": "PATCH", "url": "https://sandbox.lithic.com/v1/cards/:card_token", "params": [ { "name": "card_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the specified properties of the card. Unsupplied properties will remain unchanged.\n\n*Note: setting a card to a `CLOSED` state is a final action that cannot be undone.*\n" }, { "info": { "name": "Get card balances", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/cards/:card_token/balances", "params": [ { "name": "balance_date", "value": "", "type": "query", "description": "UTC date of the balance to retrieve. Defaults to latest available balance" }, { "name": "last_transaction_event_token", "value": "", "type": "query", "description": "Balance after a given financial event occured.\nFor example, passing the event_token of a $5 CARD_CLEARING financial event will return a balance decreased by $5\n" }, { "name": "card_token", "value": "", "type": "path" } ] }, "docs": "Get the balances for a given card." }, { "info": { "name": "List card financial transactions", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/cards/:card_token/financial_transactions", "params": [ { "name": "category", "value": "", "type": "query", "description": "Financial Transaction category to be returned." }, { "name": "result", "value": "", "type": "query", "description": "Financial Transaction result to be returned." }, { "name": "status", "value": "", "type": "query", "description": "Financial Transaction status to be returned." }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "card_token", "value": "", "type": "path" }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List the financial transactions for a given card." }, { "info": { "name": "Get card financial transaction", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/cards/:card_token/financial_transactions/:financial_transaction_token", "params": [ { "name": "card_token", "value": "", "type": "path" }, { "name": "financial_transaction_token", "value": "", "type": "path", "description": "Globally unique identifier for financial transaction token." } ] }, "docs": "Get the card financial transaction for the provided token." }, { "info": { "name": "Provision card (Digital Wallet)", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/cards/:card_token/provision", "params": [ { "name": "card_token", "value": "", "type": "path", "description": "The unique token of the card to add to the device's digital wallet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allow your cardholders to directly add payment cards to the device's digital wallet (e.g. Apple Pay) with one touch from your app.\n\nThis requires some additional setup and configuration. Please [Contact Us](https://lithic.com/contact) or your Customer Success representative for more information.\n" }, { "info": { "name": "Web Push Provision card (Digital Wallet)", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/cards/:card_token/web_provision", "params": [ { "name": "card_token", "value": "", "type": "path", "description": "The unique token of the card to add to the device's digital wallet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allow your cardholders to directly add payment cards to the device's digital wallet from a browser on the web.\n\nThis requires some additional setup and configuration. Please [Contact Us](https://lithic.com/contact) or your Customer Success representative for more information.\n" }, { "info": { "name": "Reissue physical card", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/cards/:card_token/reissue", "params": [ { "name": "card_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiate print and shipment of a duplicate physical card (e.g. card is physically damaged). The PAN, expiry, and CVC2 will remain the same and the original card can continue to be used until the new card is activated.\nOnly applies to cards of type `PHYSICAL`. A card can be reissued or renewed a total of 8 times." }, { "info": { "name": "Renew a card", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/cards/:card_token/renew", "params": [ { "name": "card_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Applies to card types `PHYSICAL` and `VIRTUAL`.\nFor `PHYSICAL`, creates a new card with the same card token and PAN, but updated expiry and CVC2 code. The original card will keep working for card-present transactions until the new card is activated. For card-not-present transactions, the original card details (expiry, CVC2) will also keep working until the new card is activated.\nA `PHYSICAL` card can be reissued or renewed a total of 8 times.\nFor `VIRTUAL`, the card will retain the same card tok" }, { "info": { "name": "Convert virtual to physical card", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/cards/:card_token/convert_physical", "params": [ { "name": "card_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Convert a virtual card into a physical card and manufacture it.\nCustomer must supply relevant fields for physical card creation including `product_id`, `carrier`, `shipping_method`, and `shipping_address`.\nThe card token will be unchanged. The card's type will be altered to `PHYSICAL`.\nThe card will be set to state `PENDING_FULFILLMENT` and fulfilled at next fulfillment cycle.\nVirtual cards created on card programs which do not support physical cards cannot be converted. The card program canno" }, { "info": { "name": "Get card's available spend limit", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/cards/:card_token/spend_limits", "params": [ { "name": "card_token", "value": "", "type": "path" } ] }, "docs": "Get a Card's available spend limit, which is based on the spend limit configured on the Card and the amount already spent over the spend limit's duration. For example, if the Card has a monthly spend limit of $1000 configured, and has spent $600 in the last month, the available spend limit returned would be $400." }, { "info": { "name": "Embedded card UI", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/embed/card", "params": [ { "name": "embed_request", "value": "", "type": "query", "description": "A base64 encoded JSON string of an EmbedRequest to specify which card to load." }, { "name": "hmac", "value": "", "type": "query", "description": "SHA256 HMAC of the embed_request JSON string with base64 digest." } ] }, "docs": "Handling full card PANs and CVV codes requires that you comply with the Payment Card Industry Data Security Standards (PCI DSS). Some clients choose to reduce their compliance obligations by leveraging our embedded card UI solution documented below.\n\nIn this setup, PANs and CVV codes are presented to the end-user via a card UI that we provide, optionally styled in the customer's branding using a specified css stylesheet. A user's browser makes the request directly to api.lithic.com, so card PANs" } ] }, { "info": { "name": "Auth Stream Access (ASA)", "type": "folder" }, "items": [ { "info": { "name": "Retrieve the ASA HMAC secret key", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/auth_stream/secret" }, "docs": "Retrieve the ASA HMAC secret key. If one does not exist for your program yet, calling this endpoint will create one for you. The headers (which you can use to verify webhooks) will begin appearing shortly after calling this endpoint for the first time. See [this page](https://docs.lithic.com/docs/auth-stream-access-asa#asa-webhook-verification) for more detail about verifying ASA webhooks.\n" }, { "info": { "name": "Rotate the ASA HMAC secret key", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/auth_stream/secret/rotate" }, "docs": "Generate a new ASA HMAC secret key. The old ASA HMAC secret key will be deactivated 24 hours after a successful request to this endpoint. Make a [`GET /auth_stream/secret`](https://docs.lithic.com/reference/getauthstreamsecret) request to retrieve the new secret key.\n" } ] }, { "info": { "name": "Balance", "type": "folder" }, "items": [ { "info": { "name": "List balances", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/balances", "params": [ { "name": "account_token", "value": "", "type": "query", "description": "List balances for all financial accounts of a given account_token." }, { "name": "business_account_token", "value": "", "type": "query", "description": "List balances for all financial accounts of a given business_account_token." }, { "name": "balance_date", "value": "", "type": "query", "description": "UTC date and time of the balances to retrieve. Defaults to latest available balances" }, { "name": "financial_account_type", "value": "", "type": "query", "description": "List balances for a given Financial Account type." } ] }, "docs": "Get the balances for a program, business, or a given end-user account" }, { "info": { "name": "Get balances", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/balances", "params": [ { "name": "balance_date", "value": "", "type": "query", "description": "UTC date of the balance to retrieve. Defaults to latest available balance" }, { "name": "last_transaction_event_token", "value": "", "type": "query", "description": "Balance after a given financial event occured.\nFor example, passing the event_token of a $5 CARD_CLEARING financial event will return a balance decreased by $5\n" }, { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account." } ] }, "docs": "Get the balances for a given financial account." } ] }, { "info": { "name": "Card Bulk Orders", "type": "folder" }, "items": [ { "info": { "name": "List bulk orders", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/card_bulk_orders", "params": [ { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List bulk orders for physical card shipments" }, { "info": { "name": "Create bulk order", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/card_bulk_orders", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new bulk order for physical card shipments. Cards can be added to the order via the POST /v1/cards endpoint by specifying the bulk_order_token. Lock the order via PATCH /v1/card_bulk_orders/{bulk_order_token} to prepare for shipment. Please work with your Customer Success Manager and card personalization bureau to ensure bulk shipping is supported for your program." }, { "info": { "name": "Get bulk order", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/card_bulk_orders/:bulk_order_token", "params": [ { "name": "bulk_order_token", "value": "", "type": "path", "description": "Globally unique identifier for the bulk order" } ] }, "docs": "Retrieve a specific bulk order by token" }, { "info": { "name": "Update bulk order", "type": "http" }, "http": { "method": "PATCH", "url": "https://sandbox.lithic.com/v1/card_bulk_orders/:bulk_order_token", "params": [ { "name": "bulk_order_token", "value": "", "type": "path", "description": "Globally unique identifier for the bulk order" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a bulk order. Primarily used to lock the order, preventing additional cards from being added" } ] }, { "info": { "name": "Tokenization", "type": "folder" }, "items": [ { "info": { "name": "List digital card art", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/digital_card_art", "params": [ { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List digital card art." }, { "info": { "name": "Get digital card art by token", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/digital_card_art/:digital_card_art_token", "params": [ { "name": "digital_card_art_token", "value": "", "type": "path", "description": "Specifies the digital card art to be displayed in the user’s digital wallet after tokenization. This artwork must be approved by Mastercard and configured by Lithic to use. See [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art)." } ] }, "docs": "Get digital card art by token." }, { "info": { "name": "Simulate a card's tokenization", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/simulate/tokenizations", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is used to simulate a card's tokenization in the Digital Wallet and merchant tokenization ecosystem.\n" }, { "info": { "name": "Retrieve the Tokenization Decisioning HMAC secret key", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/tokenization_decisioning/secret" }, "docs": "Retrieve the Tokenization Decisioning secret key. If one does not exist your program yet, calling this endpoint will create one for you. The headers of the Tokenization Decisioning request will contain a hmac signature which you can use to verify requests originate from Lithic. See [this page](https://docs.lithic.com/docs/events-api#verifying-webhooks) for more detail about verifying Tokenization Decisioning requests.\n" }, { "info": { "name": "Rotate the Tokenization Decisioning HMAC secret key", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/tokenization_decisioning/secret/rotate" }, "docs": "Generate a new Tokenization Decisioning secret key. The old Tokenization Decisioning secret key will be deactivated 24 hours after a successful request to this endpoint.\n" }, { "info": { "name": "Get a card's tokenizations", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/tokenizations", "params": [ { "name": "account_token", "value": "", "type": "query", "description": "Filters for tokenizations associated with a specific account." }, { "name": "begin", "value": "", "type": "query", "description": "Filter for tokenizations created after this date." }, { "name": "card_token", "value": "", "type": "query", "description": "Filters for tokenizations associated with a specific card." }, { "name": "end", "value": "", "type": "query", "description": "Filter for tokenizations created before this date." }, { "name": "tokenization_channel", "value": "", "type": "query", "description": "Filter for tokenizations by tokenization channel. If this is not specified, only DIGITAL_WALLET tokenizations will be returned." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List card tokenizations" }, { "info": { "name": "Get a single card tokenization", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/tokenizations/:tokenization_token", "params": [ { "name": "tokenization_token", "value": "", "type": "path", "description": "Tokenization token" } ] }, "docs": "Get tokenization" }, { "info": { "name": "Pause a card tokenization", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/tokenizations/:tokenization_token/pause", "params": [ { "name": "tokenization_token", "value": "", "type": "path", "description": "Tokenization token" } ] }, "docs": "This endpoint is used to ask the card network to pause a tokenization. A successful response indicates that the request was successfully delivered to the card network. When the card network pauses the tokenization, the state will be updated and a tokenization.updated event will be sent. The endpoint may only be used on tokenizations with status `ACTIVE`.\nA paused token will prevent merchants from sending authorizations, and is a temporary status that can be changed.\nReach out at [lithic.com/cont" }, { "info": { "name": "Unpause a card tokenization", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/tokenizations/:tokenization_token/unpause", "params": [ { "name": "tokenization_token", "value": "", "type": "path", "description": "Tokenization token" } ] }, "docs": "This endpoint is used to ask the card network to unpause a tokenization. A successful response indicates that the request was successfully delivered to the card network. When the card network unpauses the tokenization, the state will be updated and a tokenization.updated event will be sent. The endpoint may only be used on tokenizations with status `PAUSED`.\nThis will put the tokenization in an active state, and transactions may resume.\nReach out at [lithic.com/contact](https://lithic.com/contac" }, { "info": { "name": "Deactivate a card tokenization", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/tokenizations/:tokenization_token/deactivate", "params": [ { "name": "tokenization_token", "value": "", "type": "path", "description": "Tokenization token" } ] }, "docs": "This endpoint is used to ask the card network to deactivate a tokenization. A successful response indicates that the request was successfully delivered to the card network. When the card network deactivates the tokenization, the state will be updated and a tokenization.updated event will be sent.\nAuthorizations attempted with a deactivated tokenization will be blocked and will not be forwarded to Lithic from the network. Deactivating the token is a permanent operation. If the target is a digital" }, { "info": { "name": "Activate a card tokenization", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/tokenizations/:tokenization_token/activate", "params": [ { "name": "tokenization_token", "value": "", "type": "path", "description": "Tokenization token" } ] }, "docs": "This endpoint is used to ask the card network to activate a tokenization. A successful response indicates that the request was successfully delivered to the card network. When the card network activates the tokenization, the state will be updated and a tokenization.updated event will be sent. The endpoint may only be used on digital wallet tokenizations with status `INACTIVE`, `PENDING_ACTIVATION`, or `PENDING_2FA`.\nThis will put the tokenization in an active state, and transactions will be allo" }, { "info": { "name": "Resend activation code for a card tokenization", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/tokenizations/:tokenization_token/resend_activation_code", "params": [ { "name": "tokenization_token", "value": "", "type": "path", "description": "Tokenization token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is used to ask the card network to send another activation code to a cardholder that has already tried tokenizing a card. A successful response indicates that the request was successfully delivered to the card network.\nThe endpoint may only be used on Mastercard digital wallet tokenizations with status `INACTIVE`, `PENDING_ACTIVATION`, or `PENDING_2FA`. The network will send a new activation code to the one of the contact methods provided in the initial tokenization flow. If a user" }, { "info": { "name": "Update digital card art for a card tokenization", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/tokenizations/:tokenization_token/update_digital_card_art", "params": [ { "name": "tokenization_token", "value": "", "type": "path", "description": "Tokenization token" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is used update the digital card art for a digital wallet tokenization. A successful response indicates that the card network has updated the tokenization's art, and the tokenization's `digital_cart_art_token` field was updated.\nThe endpoint may not be used on tokenizations with status `DEACTIVATED`.\nNote that this updates the art for one specific tokenization, not all tokenizations for a card. New tokenizations for a card will be created with the art referenced in the card object's" } ] }, { "info": { "name": "Chargeback", "type": "folder" }, "items": [ { "info": { "name": "List chargeback requests", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/disputes", "params": [ { "name": "status", "value": "", "type": "query", "description": "Filter by status." }, { "name": "transaction_tokens", "value": "", "type": "query", "description": "Transaction tokens to filter by." }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List chargeback requests." }, { "info": { "name": "Request chargeback", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/disputes", "body": { "type": "json", "data": "{}" } }, "docs": "Request a chargeback." }, { "info": { "name": "Get chargeback request", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/disputes/:dispute_token", "params": [ { "name": "dispute_token", "value": "", "type": "path" } ] }, "docs": "Get chargeback request." }, { "info": { "name": "Update chargeback request", "type": "http" }, "http": { "method": "PATCH", "url": "https://sandbox.lithic.com/v1/disputes/:dispute_token", "params": [ { "name": "dispute_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update chargeback request. Can only be modified if status is `NEW`." }, { "info": { "name": "Withdraw chargeback request", "type": "http" }, "http": { "method": "DELETE", "url": "https://sandbox.lithic.com/v1/disputes/:dispute_token", "params": [ { "name": "dispute_token", "value": "", "type": "path" } ] }, "docs": "Withdraw chargeback request." }, { "info": { "name": "List evidence", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/disputes/:dispute_token/evidences", "params": [ { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "dispute_token", "value": "", "type": "path" }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List evidence for a chargeback request." }, { "info": { "name": "Upload evidence", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/disputes/:dispute_token/evidences", "params": [ { "name": "dispute_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to upload evidence for a chargeback request. It will return a URL to upload your documents to. The URL will expire in 30 minutes.\n\nUploaded documents must either be a `jpg`, `png` or `pdf` file, and each must be less than 5 GiB.\n" }, { "info": { "name": "Get evidence", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/disputes/:dispute_token/evidences/:evidence_token", "params": [ { "name": "evidence_token", "value": "", "type": "path" }, { "name": "dispute_token", "value": "", "type": "path" } ] }, "docs": "Get evidence for a chargeback request." }, { "info": { "name": "Delete evidence", "type": "http" }, "http": { "method": "DELETE", "url": "https://sandbox.lithic.com/v1/disputes/:dispute_token/evidences/:evidence_token", "params": [ { "name": "evidence_token", "value": "", "type": "path" }, { "name": "dispute_token", "value": "", "type": "path" } ] }, "docs": "Soft delete evidence for a chargeback request. Evidence will not be reviewed or submitted by Lithic after it is withdrawn." } ] }, { "info": { "name": "Fraud Report", "type": "folder" }, "items": [ { "info": { "name": "Get a fraud report for a transaction", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/fraud/transactions/:transaction_token", "params": [ { "name": "transaction_token", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "The token of the transaction that the enhanced data is associated with." } ] }, "docs": "Retrieve a fraud report for a specific transaction identified by its unique transaction token.\n" }, { "info": { "name": "Create or update a fraud report for a transaction", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/fraud/transactions/:transaction_token", "params": [ { "name": "transaction_token", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "The token of the transaction that the enhanced data is associated with." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Report fraud for a specific transaction token by providing details such as fraud type, fraud status, and any additional comments.\n" } ] }, { "info": { "name": "Transaction", "type": "folder" }, "items": [ { "info": { "name": "List enhanced commercial data", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/transactions/:transaction_token/enhanced_commercial_data", "params": [ { "name": "transaction_token", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "The token of the transaction that the enhanced data is associated with." } ] }, "docs": "Get all L2/L3 enhanced commercial data associated with a transaction. Not available in sandbox." }, { "info": { "name": "Expire an authorization", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/transactions/:transaction_token/expire_authorization", "params": [ { "name": "transaction_token", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "The token of the transaction to expire." } ] }, "docs": "Expire authorization" }, { "info": { "name": "Get enhanced commercial data", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/transactions/events/:event_token/enhanced_commercial_data", "params": [ { "name": "event_token", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "The token of the transaction event that the enhanced data is associated with." } ] }, "docs": "Get L2/L3 enhanced commercial data associated with a transaction event. Not available in sandbox." }, { "info": { "name": "Simulate authorization advice", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/simulate/authorization_advice", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates an authorization advice from the card network as if it came from a merchant acquirer. An authorization advice changes the pending amount of the transaction.\n" }, { "info": { "name": "Simulate authorization", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/simulate/authorize", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates an authorization request from the card network as if it came from a merchant acquirer.\nIf you are configured for ASA, simulating authorizations requires your ASA client to be set up properly, i.e. be able to respond to the ASA request with a valid JSON. For users that are not configured for ASA, a daily transaction limit of $5000 USD is applied by default. You can update this limit via the [update account](https://docs.lithic.com/reference/patchaccountbytoken) endpoint.\n" }, { "info": { "name": "Simulate clearing", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/simulate/clearing", "body": { "type": "json", "data": "{}" } }, "docs": "Clears an existing authorization, either debit or credit. After this event, the transaction transitions from `PENDING` to `SETTLED` status.\n\nIf `amount` is not set, the full amount of the transaction will be cleared. Transactions that have already cleared, either partially or fully, cannot be cleared again using this endpoint.\n" }, { "info": { "name": "Simulate credit authorization advice", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/simulate/credit_authorization_advice", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates a credit authorization advice from the card network.\nThis message indicates that the network approved a credit authorization on your behalf.\n" }, { "info": { "name": "Simulate return", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/simulate/return", "body": { "type": "json", "data": "{}" } }, "docs": "Returns, or refunds, an amount back to a card. Returns simulated via this endpoint clear immediately, without prior authorization, and result in a `SETTLED` transaction status.\n" }, { "info": { "name": "Simulate return reversal", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/simulate/return_reversal", "body": { "type": "json", "data": "{}" } }, "docs": "Reverses a return, i.e. a credit transaction with a `SETTLED` status. Returns can be financial credit authorizations, or credit authorizations that have cleared.\n" }, { "info": { "name": "Simulate void", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/simulate/void", "body": { "type": "json", "data": "{}" } }, "docs": "Voids a pending authorization. If `amount` is not set, the full amount will be voided. Can be used on partially voided transactions but not partially cleared transactions. _Simulating an authorization expiry on credit authorizations or credit authorization advice is not currently supported but will be added soon._\n" }, { "info": { "name": "List card transactions", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/transactions", "params": [ { "name": "account_token", "value": "", "type": "query", "description": "Filters for transactions associated with a specific account.\n" }, { "name": "card_token", "value": "", "type": "query", "description": "Filters for transactions associated with a specific card." }, { "name": "result", "value": "", "type": "query", "description": "Filters for transactions using transaction result field. Can filter by `APPROVED`, and `DECLINED`." }, { "name": "status", "value": "", "type": "query", "description": "Filters for transactions using transaction status field." }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List card transactions. All amounts are in the smallest unit of their respective currency (e.g., cents for USD) and inclusive of any acquirer fees.\n" }, { "info": { "name": "Get card transaction", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/transactions/:transaction_token", "params": [ { "name": "transaction_token", "value": "", "type": "path", "description": "Globally unique identifier for the transaction." } ] }, "docs": "Get a specific card transaction. All amounts are in the smallest unit of their respective currency (e.g., cents for USD).\n" } ] }, { "info": { "name": "Event", "type": "folder" }, "items": [ { "info": { "name": "List event subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/event_subscriptions", "params": [ { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List all the event subscriptions." }, { "info": { "name": "Create event subscription", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/event_subscriptions", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new event subscription." }, { "info": { "name": "Get event subscription", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/event_subscriptions/:event_subscription_token", "params": [ { "name": "event_subscription_token", "value": "", "type": "path" } ] }, "docs": "Get an event subscription." }, { "info": { "name": "Update event subscription", "type": "http" }, "http": { "method": "PATCH", "url": "https://sandbox.lithic.com/v1/event_subscriptions/:event_subscription_token", "params": [ { "name": "event_subscription_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an event subscription." }, { "info": { "name": "Delete event subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://sandbox.lithic.com/v1/event_subscriptions/:event_subscription_token", "params": [ { "name": "event_subscription_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete an event subscription." }, { "info": { "name": "List message attempts for an event subscription", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/event_subscriptions/:event_subscription_token/attempts", "params": [ { "name": "status", "value": "", "type": "query" }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "event_subscription_token", "value": "", "type": "path" }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List all the message attempts for a given event subscription." }, { "info": { "name": "Resend failed messages", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/event_subscriptions/:event_subscription_token/recover", "params": [ { "name": "event_subscription_token", "value": "", "type": "path" }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resend all failed messages since a given time." }, { "info": { "name": "Replay missing messages", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/event_subscriptions/:event_subscription_token/replay_missing", "params": [ { "name": "event_subscription_token", "value": "", "type": "path" }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." } ] }, "docs": "Replays messages to the endpoint. Only messages that were created after `begin` will be sent. Messages that were previously sent to the endpoint are not resent.\nMessage will be retried if endpoint responds with a non-2xx status code. See [Retry Schedule](https://docs.lithic.com/docs/events-api#retry-schedule) for details.\n" }, { "info": { "name": "Get event subscription secret", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/event_subscriptions/:event_subscription_token/secret", "params": [ { "name": "event_subscription_token", "value": "", "type": "path" } ] }, "docs": "Get the secret for an event subscription." }, { "info": { "name": "Rotate event subscription secret", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/event_subscriptions/:event_subscription_token/secret/rotate", "params": [ { "name": "event_subscription_token", "value": "", "type": "path" } ] }, "docs": "Rotate the secret for an event subscription. The previous secret will be valid for the next 24 hours.\n" }, { "info": { "name": "List events", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/events", "params": [ { "name": "event_types", "value": "", "type": "query", "description": "Event types to filter events by." }, { "name": "with_content", "value": "", "type": "query", "description": "Whether to include the event payload content in the response." }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List all events." }, { "info": { "name": "Get event", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/events/:event_token", "params": [ { "name": "event_token", "value": "", "type": "path" } ] }, "docs": "Get an event." }, { "info": { "name": "List message attempts for an event", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/events/:event_token/attempts", "params": [ { "name": "status", "value": "", "type": "query" }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "event_token", "value": "", "type": "path" }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List all the message attempts for a given event." }, { "info": { "name": "Resend event", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/events/:event_token/event_subscriptions/:event_subscription_token/resend", "params": [ { "name": "event_subscription_token", "value": "", "type": "path" }, { "name": "event_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resend an event to an event subscription." }, { "info": { "name": "Send event type example message", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/simulate/event_subscriptions/:event_subscription_token/send_example", "params": [ { "name": "event_subscription_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Send an example message for event." } ] }, { "info": { "name": "External Bank Account", "type": "folder" }, "items": [ { "info": { "name": "List external bank accounts", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/external_bank_accounts", "params": [ { "name": "account_token", "value": "", "type": "query" }, { "name": "account_types", "value": "", "type": "query" }, { "name": "countries", "value": "", "type": "query" }, { "name": "owner_types", "value": "", "type": "query" }, { "name": "states", "value": "", "type": "query" }, { "name": "verification_states", "value": "", "type": "query" }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List all the external bank accounts for the provided search criteria." }, { "info": { "name": "Create external bank account", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/external_bank_accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an external bank account within a program or Lithic account." }, { "info": { "name": "Get external bank account by token", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/external_bank_accounts/:external_bank_account_token", "params": [ { "name": "external_bank_account_token", "value": "", "type": "path" } ] }, "docs": "Get the external bank account by token." }, { "info": { "name": "Update external bank account", "type": "http" }, "http": { "method": "PATCH", "url": "https://sandbox.lithic.com/v1/external_bank_accounts/:external_bank_account_token", "params": [ { "name": "external_bank_account_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the external bank account by token." }, { "info": { "name": "Verify external bank account via micro deposit amounts", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/external_bank_accounts/:external_bank_account_token/micro_deposits", "params": [ { "name": "external_bank_account_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verify the external bank account by providing the micro deposit amounts." }, { "info": { "name": "Retry external bank account via micro deposit", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/external_bank_accounts/:external_bank_account_token/retry_micro_deposits", "params": [ { "name": "external_bank_account_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retry external bank account micro deposit verification." }, { "info": { "name": "Retry external bank account via prenote", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/external_bank_accounts/:external_bank_account_token/retry_prenote", "params": [ { "name": "external_bank_account_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retry external bank account prenote verification." }, { "info": { "name": "Set verification method", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/external_bank_accounts/:external_bank_account_token/set_verification_method", "params": [ { "name": "external_bank_account_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the verification method for an external bank account. Verification method can only be updated\nif the `verification_state` is `PENDING`.\n" }, { "info": { "name": "Unpause external bank account", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/external_bank_accounts/:external_bank_account_token/unpause", "params": [ { "name": "external_bank_account_token", "value": "", "type": "path" } ] }, "docs": "Unpause an external bank account\n" } ] }, { "info": { "name": "Credit Product", "type": "folder" }, "items": [ { "info": { "name": "Get extended credit", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/credit_products/:credit_product_token/extended_credit", "params": [ { "name": "credit_product_token", "value": "", "type": "path", "description": "Credit Product Token" } ] }, "docs": "Get the extended credit for a given credit product under a program" }, { "info": { "name": "Get Credit Product Prime Rates", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/credit_products/:credit_product_token/prime_rates", "params": [ { "name": "credit_product_token", "value": "", "type": "path", "description": "Globally unique identifier for credit products." }, { "name": "starting_after", "value": "", "type": "query", "description": "The effective date that the prime rate starts after" }, { "name": "ending_before", "value": "", "type": "query", "description": "The effective date that the prime rates ends before" } ] }, "docs": "Get Credit Product Prime Rates" }, { "info": { "name": "Post Credit Product Prime Rate", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/credit_products/:credit_product_token/prime_rates", "params": [ { "name": "credit_product_token", "value": "", "type": "path", "description": "Globally unique identifier for credit products." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Post Credit Product Prime Rate" } ] }, { "info": { "name": "Financial Account", "type": "folder" }, "items": [ { "info": { "name": "List financial accounts", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/financial_accounts", "params": [ { "name": "account_token", "value": "", "type": "query", "description": "List financial accounts for a given account_token or business_account_token" }, { "name": "business_account_token", "value": "", "type": "query", "description": "List financial accounts for a given business_account_token" }, { "name": "type", "value": "", "type": "query", "description": "List financial accounts of a given type" } ] }, "docs": "Retrieve information on your financial accounts including routing and account number." }, { "info": { "name": "Create financial account", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/financial_accounts", "headers": [ { "name": "Idempotency-Key", "value": "65a9dad4-1b60-4686-83fd-65b25078a4b4" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new financial account" }, { "info": { "name": "Get financial account", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token", "params": [ { "name": "financial_account_token", "value": "", "type": "path" } ] }, "docs": "Get a financial account" }, { "info": { "name": "Update financial account", "type": "http" }, "http": { "method": "PATCH", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token", "params": [ { "name": "financial_account_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a financial account" }, { "info": { "name": "Get account credit configuration", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/credit_configuration", "params": [ { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account." } ] }, "docs": "Get an Account's credit configuration" }, { "info": { "name": "Update account credit configuration", "type": "http" }, "http": { "method": "PATCH", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/credit_configuration", "params": [ { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an account's credit configuration" }, { "info": { "name": "List financial transactions", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/financial_transactions", "params": [ { "name": "category", "value": "", "type": "query", "description": "Financial Transaction category to be returned." }, { "name": "result", "value": "", "type": "query", "description": "Financial Transaction result to be returned." }, { "name": "status", "value": "", "type": "query", "description": "Financial Transaction status to be returned." }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List the financial transactions for a given financial account." }, { "info": { "name": "Get financial transaction", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/financial_transactions/:financial_transaction_token", "params": [ { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account." }, { "name": "financial_transaction_token", "value": "", "type": "path", "description": "Globally unique identifier for financial transaction token." } ] }, "docs": "Get the financial transaction for the provided token." }, { "info": { "name": "Register Account Number", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/register_account_number", "params": [ { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Register account number" }, { "info": { "name": "Update financial account status", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/update_status", "params": [ { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update financial account status" }, { "info": { "name": "List Account Activity", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/account_activity", "params": [ { "name": "status", "value": "", "type": "query", "description": "Filter by transaction status" }, { "name": "result", "value": "", "type": "query", "description": "Filter by transaction result" }, { "name": "financial_account_token", "value": "", "type": "query", "description": "Filter by financial account token" }, { "name": "business_account_token", "value": "", "type": "query", "description": "Filter by business account token" }, { "name": "account_token", "value": "", "type": "query", "description": "Filter by account token" }, { "name": "category", "value": "", "type": "query", "description": "Filter by transaction category" }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "Retrieve a list of transactions across all public accounts." }, { "info": { "name": "Get Single Transaction from Account Activity", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/account_activity/:transaction_token", "params": [ { "name": "transaction_token", "value": "", "type": "path", "description": "The unique identifier for the transaction" } ] }, "docs": "Retrieve a single transaction" } ] }, { "info": { "name": "Hold", "type": "folder" }, "items": [ { "info": { "name": "List holds", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/holds", "params": [ { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for the financial account." }, { "name": "status", "value": "", "type": "query", "description": "Hold status to filter by." }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List holds for a financial account." }, { "info": { "name": "Create hold", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/holds", "params": [ { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for the financial account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a hold on a financial account. Holds reserve funds by moving them\nfrom available to pending balance. They can be resolved via settlement\n(linked to a payment or book transfer), voiding, or expiration.\n" }, { "info": { "name": "Get hold", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/holds/:hold_token", "params": [ { "name": "hold_token", "value": "", "type": "path", "description": "Globally unique identifier for the hold." } ] }, "docs": "Get hold by token." }, { "info": { "name": "Void hold", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/holds/:hold_token/void", "params": [ { "name": "hold_token", "value": "", "type": "path", "description": "Globally unique identifier for the hold." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Void an active hold. This returns the held funds from pending back to\navailable balance. Only holds in PENDING status can be voided.\n" } ] }, { "info": { "name": "Statements", "type": "folder" }, "items": [ { "info": { "name": "List statements", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/statements", "params": [ { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified date will be included." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified date will be included." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." }, { "name": "include_initial_statements", "value": "", "type": "query", "description": "Whether to include the initial statement. It is not included by default." } ] }, "docs": "List the statements for a given financial account." }, { "info": { "name": "Get statement by token", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/statements/:statement_token", "params": [ { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account." }, { "name": "statement_token", "value": "", "type": "path", "description": "Globally unique identifier for statements." } ] }, "docs": "Get a specific statement for a given financial account." }, { "info": { "name": "List line items for a statement", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/statements/:statement_token/line_items", "params": [ { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." }, { "name": "statement_token", "value": "", "type": "path", "description": "Globally unique identifier for statements." } ] }, "docs": "List the line items for a given statement within a given financial account." }, { "info": { "name": "List loan tapes", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/loan_tapes", "params": [ { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified date will be included." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified date will be included." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List the loan tapes for a given financial account." }, { "info": { "name": "Get loan tape by token", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/loan_tapes/:loan_tape_token", "params": [ { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account." }, { "name": "loan_tape_token", "value": "", "type": "path", "description": "Globally unique identifier for loan tape." } ] }, "docs": "Get a specific loan tape for a given financial account." }, { "info": { "name": "Get loan tape configuration", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/loan_tape_configuration", "params": [ { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account." } ] }, "docs": "Get the loan tape configuration for a given financial account." }, { "info": { "name": "List interest tier schedules", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/interest_tier_schedule", "params": [ { "name": "after_date", "value": "", "type": "query", "description": "Return schedules with effective_date >= after_date (ISO format YYYY-MM-DD)" }, { "name": "before_date", "value": "", "type": "query", "description": "Return schedules with effective_date <= before_date (ISO format YYYY-MM-DD)" }, { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account" }, { "name": "for_date", "value": "", "type": "query", "description": "Return schedule with effective_date == for_date (ISO format YYYY-MM-DD)" } ] }, "docs": "List interest tier schedules for a financial account with optional date filtering.\n\nIf no date parameters are provided, returns all tier schedules.\nIf date parameters are provided, uses filtering to return matching schedules (max 100).\n- for_date: Returns exact match (takes precedence over other dates)\n- before_date: Returns schedules with effective_date <= before_date\n- after_date: Returns schedules with effective_date >= after_date\n- Both before_date and after_date: Returns schedules in range" }, { "info": { "name": "Create interest tier schedule", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/interest_tier_schedule", "params": [ { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new interest tier schedule entry for a supported financial account" }, { "info": { "name": "Get interest tier schedule", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/interest_tier_schedule/:effective_date", "params": [ { "name": "effective_date", "value": "", "type": "path", "description": "Effective date in ISO format (YYYY-MM-DD)" }, { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account" } ] }, "docs": "Get a specific interest tier schedule by effective date" }, { "info": { "name": "Update interest tier schedule", "type": "http" }, "http": { "method": "PUT", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/interest_tier_schedule/:effective_date", "params": [ { "name": "effective_date", "value": "", "type": "path", "description": "Effective date in ISO format (YYYY-MM-DD)" }, { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing interest tier schedule" }, { "info": { "name": "Delete interest tier schedule", "type": "http" }, "http": { "method": "DELETE", "url": "https://sandbox.lithic.com/v1/financial_accounts/:financial_account_token/interest_tier_schedule/:effective_date", "params": [ { "name": "effective_date", "value": "", "type": "path", "description": "Effective date in ISO format (YYYY-MM-DD)" }, { "name": "financial_account_token", "value": "", "type": "path", "description": "Globally unique identifier for financial account" } ] }, "docs": "Delete an interest tier schedule entry.\n\nReturns:\n- 400 Bad Request: Invalid effective_date format OR attempting to delete the earliest\n tier schedule entry for a non-PENDING account\n- 404 Not Found: Tier schedule entry not found for the given effective_date OR ledger account not found\n\nNote: PENDING accounts can delete the earliest tier schedule entry (account hasn't opened yet).\nActive/non-PENDING accounts cannot delete the earliest entry to prevent orphaning the account.\n\nIf the deleted tier" } ] }, { "info": { "name": "Payment", "type": "folder" }, "items": [ { "info": { "name": "List payments", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/payments", "params": [ { "name": "financial_account_token", "value": "", "type": "query" }, { "name": "business_account_token", "value": "", "type": "query" }, { "name": "account_token", "value": "", "type": "query" }, { "name": "result", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "category", "value": "", "type": "query" }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List all the payments for the provided search criteria." }, { "info": { "name": "Create payment", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/payments", "body": { "type": "json", "data": "{}" } }, "docs": "Initiates a payment between a financial account and an external bank account." }, { "info": { "name": "Get payment by token", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/payments/:payment_token", "params": [ { "name": "payment_token", "value": "", "type": "path" } ] }, "docs": "Get the payment by token." }, { "info": { "name": "Retry payment", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/payments/:payment_token/retry", "params": [ { "name": "payment_token", "value": "", "type": "path" } ] }, "docs": "Retry an origination which has been returned." }, { "info": { "name": "Return payment", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/payments/:payment_token/return", "params": [ { "name": "payment_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return an ACH payment with a specified return reason code. Returns must be initiated\nwithin the time window specified by NACHA rules for each return code (typically 2 banking\ndays for most codes, 60 calendar days for unauthorized debits). For a complete list of\nreturn codes and their meanings, see the [ACH Return Reasons documentation](https://docs.lithic.com/docs/ach-overview#ach-return-reasons).\n\nNote:\n * This endpoint does not modify the state of the financial account associated with the pay" }, { "info": { "name": "Simulate receipt", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/simulate/payments/receipt", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates a receipt of a Payment." }, { "info": { "name": "Simulate release payment", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/simulate/payments/release", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates a release of a Payment." }, { "info": { "name": "Simulate return payment", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/simulate/payments/return", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates a return of a Payment." }, { "info": { "name": "Simulate payment lifecycle event", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/simulate/payments/:payment_token/action", "params": [ { "name": "payment_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Simulate payment lifecycle event" } ] }, { "info": { "name": "Settlement Report", "type": "folder" }, "items": [ { "info": { "name": "List settlement details", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/reports/settlement/details/:report_date", "params": [ { "name": "report_date", "value": "2023-09-01", "type": "path", "description": "Date of the settlement report to retrieve. Not available in sandbox." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List details." }, { "info": { "name": "Get settlement summary", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/reports/settlement/summary/:report_date", "params": [ { "name": "report_date", "value": "2023-09-01", "type": "path", "description": "Date of the settlement report to retrieve." } ] }, "docs": "Get the settlement report for a specified report date. Not available in sandbox." }, { "info": { "name": "List network totals", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/reports/settlement/network_totals", "params": [ { "name": "report_date", "value": "", "type": "query", "description": "Singular report date to filter on (YYYY-MM-DD). Cannot be populated in conjunction with report_date_begin or report_date_end." }, { "name": "report_date_begin", "value": "", "type": "query", "description": "Earliest report date to filter on, inclusive (YYYY-MM-DD)." }, { "name": "report_date_end", "value": "", "type": "query", "description": "Latest report date to filter on, inclusive (YYYY-MM-DD)." }, { "name": "network", "value": "", "type": "query", "description": "Network to filter on." }, { "name": "institution_id", "value": "", "type": "query", "description": "Institution ID to filter on." }, { "name": "settlement_institution_id", "value": "", "type": "query", "description": "Settlement institution ID to filter on." }, { "name": "begin", "value": "", "type": "query", "description": "Datetime in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "end", "value": "", "type": "query", "description": "Datetime in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." } ] }, "docs": "List network total records with optional filters. Not available in sandbox." }, { "info": { "name": "Get network total", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/reports/settlement/network_totals/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Token of the network total record to retrieve" } ] }, "docs": "Retrieve a specific network total record by token. Not available in sandbox." } ] }, { "info": { "name": "Responder Endpoints", "type": "folder" }, "items": [ { "info": { "name": "Check the status of a responder endpoint", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/responder_endpoints", "params": [ { "name": "type", "value": "", "type": "query", "description": "The type of the endpoint." } ] }, "docs": "Check the status of a responder endpoint" }, { "info": { "name": "Enroll a responder endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/responder_endpoints", "body": { "type": "json", "data": "{}" } }, "docs": "Enroll a responder endpoint" }, { "info": { "name": "Disenroll a responder endpoint", "type": "http" }, "http": { "method": "DELETE", "url": "https://sandbox.lithic.com/v1/responder_endpoints", "params": [ { "name": "type", "value": "", "type": "query", "description": "The type of the endpoint." } ] }, "docs": "Disenroll a responder endpoint" } ] }, { "info": { "name": "Status", "type": "folder" }, "items": [ { "info": { "name": "API status check", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/status" }, "docs": "Status of api" } ] }, { "info": { "name": "3DS", "type": "folder" }, "items": [ { "info": { "name": "Simulate 3DS authentication", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/three_ds_authentication/simulate", "body": { "type": "json", "data": "{}" } }, "docs": "Simulates a 3DS authentication request from the payment network as if it came from an ACS. If you're configured for 3DS Customer Decisioning, simulating authentications requires your customer decisioning endpoint to be set up properly (respond with a valid JSON). If the authentication decision is to challenge, ensure that the account holder associated with the card transaction has a valid phone number configured to receive the OTP code via SMS. " }, { "info": { "name": "Simulate entering OTP into 3DS Challenge UI", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/three_ds_decisioning/simulate/enter_otp", "body": { "type": "json", "data": "{}" } }, "docs": "Endpoint for simulating entering OTP into 3DS Challenge UI. A call to [/v1/three_ds_authentication/simulate](https://docs.lithic.com/reference/postsimulateauthentication) that resulted in triggered SMS-OTP challenge must precede. Only a single attempt is supported; upon entering OTP, the challenge is either approved or declined." }, { "info": { "name": "Get 3DS authentication", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/three_ds_authentication/:three_ds_authentication_token", "params": [ { "name": "three_ds_authentication_token", "value": "", "type": "path", "description": "Globally unique identifier for the 3DS authentication." } ] }, "docs": "Get 3DS Authentication by token" }, { "info": { "name": "Retrieve the 3DS Decisioning HMAC secret key", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/three_ds_decisioning/secret" }, "docs": "Retrieve the 3DS Decisioning HMAC secret key. If one does not exist for your program yet, calling this endpoint will create one for you. The headers (which you can use to verify 3DS Decisioning requests) will begin appearing shortly after calling this endpoint for the first time. See [this page](https://docs.lithic.com/docs/3ds-decisioning#3ds-decisioning-hmac-secrets) for more detail about verifying 3DS Decisioning requests.\n" }, { "info": { "name": "Rotate the 3DS Decisioning HMAC secret key", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/three_ds_decisioning/secret/rotate" }, "docs": "Generate a new 3DS Decisioning HMAC secret key. The old secret key will be deactivated 24 hours after a successful request to this endpoint. Make a [`GET /three_ds_decisioning/secret`](https://docs.lithic.com/reference/getthreedsdecisioningsecret) request to retrieve the new secret key.\n" }, { "info": { "name": "Respond to a Challenge Request", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/three_ds_decisioning/challenge_response", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Card program's response to a 3DS Challenge Request.\nChallenge Request is emitted as a webhook [three_ds_authentication.challenge](https://docs.lithic.com/reference/post_three-ds-authentication-challenge) and your Card Program needs to be configured with Out of Band (OOB) Challenges in order to receive it (see https://docs.lithic.com/docs/3ds-challenge-flow for more information)." } ] }, { "info": { "name": "Book Transfer", "type": "folder" }, "items": [ { "info": { "name": "Transfer funds within Lithic", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/transfer", "body": { "type": "json", "data": "{}" } }, "docs": "Transfer funds between two financial accounts or between a financial account and card" }, { "info": { "name": "List book transfers", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/book_transfers", "params": [ { "name": "category", "value": "", "type": "query", "description": "Book Transfer category to be returned." }, { "name": "financial_account_token", "value": "", "type": "query", "description": "Globally unique identifier for the financial account or card that will send the funds. Accepted type dependent on the program's use case." }, { "name": "business_account_token", "value": "", "type": "query" }, { "name": "account_token", "value": "", "type": "query" }, { "name": "result", "value": "", "type": "query", "description": "Book transfer result to be returned." }, { "name": "status", "value": "", "type": "query", "description": "Book transfer status to be returned." }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List book transfers" }, { "info": { "name": "Create book transfer", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/book_transfers", "body": { "type": "json", "data": "{}" } }, "docs": "Book transfer funds between two financial accounts or between a financial account and card" }, { "info": { "name": "Get book transfer by token", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/book_transfers/:book_transfer_token", "params": [ { "name": "book_transfer_token", "value": "", "type": "path", "description": "Id of the book transfer to retrieve" } ] }, "docs": "Get book transfer by token" }, { "info": { "name": "Retry book transfer", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/book_transfers/:book_transfer_token/retry", "params": [ { "name": "book_transfer_token", "value": "", "type": "path", "description": "Token of the book transfer to retry" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retry a book transfer that has been declined" }, { "info": { "name": "Reverse book transfer", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/book_transfers/:book_transfer_token/reverse", "params": [ { "name": "book_transfer_token", "value": "", "type": "path", "description": "Id of the book transfer to retrieve" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reverse a book transfer" } ] }, { "info": { "name": "Transfer Limits", "type": "folder" }, "items": [ { "info": { "name": "Get transfer limits", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/transfer_limits", "params": [ { "name": "date", "value": "2025-11-10", "type": "query", "description": "Date for which to retrieve transfer limits (ISO 8601 format)" } ] }, "docs": "Get transfer limits for a specified date" } ] }, { "info": { "name": "External Payments", "type": "folder" }, "items": [ { "info": { "name": "List external payments", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/external_payments", "params": [ { "name": "category", "value": "", "type": "query", "description": "External Payment category to be returned." }, { "name": "financial_account_token", "value": "", "type": "query", "description": "Globally unique identifier for the financial account or card that will send the funds. Accepted type dependent on the program's use case." }, { "name": "business_account_token", "value": "", "type": "query" }, { "name": "result", "value": "", "type": "query", "description": "External Payment result to be returned." }, { "name": "status", "value": "", "type": "query", "description": "Book transfer status to be returned." }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List external payments" }, { "info": { "name": "Create external payment", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/external_payments", "body": { "type": "json", "data": "{}" } }, "docs": "Create external payment" }, { "info": { "name": "Get external payment", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/external_payments/:external_payment_token", "params": [ { "name": "external_payment_token", "value": "", "type": "path", "description": "Globally unique identifier for the external payment" } ] }, "docs": "Get external payment" }, { "info": { "name": "Settle external payment", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/external_payments/:external_payment_token/settle", "params": [ { "name": "external_payment_token", "value": "", "type": "path", "description": "Globally unique identifier for the external payment" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Settle external payment" }, { "info": { "name": "Release external payment", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/external_payments/:external_payment_token/release", "params": [ { "name": "external_payment_token", "value": "", "type": "path", "description": "Globally unique identifier for the external payment" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Release external payment" }, { "info": { "name": "Cancel external payment", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/external_payments/:external_payment_token/cancel", "params": [ { "name": "external_payment_token", "value": "", "type": "path", "description": "Globally unique identifier for the external payment" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel external payment" }, { "info": { "name": "Reverse external payment", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/external_payments/:external_payment_token/reverse", "params": [ { "name": "external_payment_token", "value": "", "type": "path", "description": "Globally unique identifier for the external payment" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reverse external payment" } ] }, { "info": { "name": "Management Operations", "type": "folder" }, "items": [ { "info": { "name": "List management operations", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/management_operations", "params": [ { "name": "category", "value": "", "type": "query", "description": "Management operation category to be returned." }, { "name": "financial_account_token", "value": "", "type": "query", "description": "Globally unique identifier for the financial account. Accepted type dependent on the program's use case." }, { "name": "business_account_token", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query", "description": "Management operation status to be returned." }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "List management operations" }, { "info": { "name": "Create management operation", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/management_operations", "body": { "type": "json", "data": "{}" } }, "docs": "Create management operation" }, { "info": { "name": "Get management operation", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/management_operations/:management_operation_token", "params": [ { "name": "management_operation_token", "value": "", "type": "path", "description": "Globally unique identifier for the management operation" } ] }, "docs": "Get management operation" }, { "info": { "name": "Reverse management operation", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.lithic.com/v1/management_operations/:management_operation_token/reverse", "params": [ { "name": "management_operation_token", "value": "", "type": "path", "description": "Globally unique identifier for the management operation" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reverse a management operation" } ] }, { "info": { "name": "Network Program", "type": "folder" }, "items": [ { "info": { "name": "List network programs", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/network_programs", "params": [ { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "begin", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone." }, { "name": "end", "value": "", "type": "query", "description": "Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone." } ] }, "docs": "List network programs." }, { "info": { "name": "Get network program", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/network_programs/:network_program_token", "params": [ { "name": "network_program_token", "value": "", "type": "path", "description": "Globally unique identifier for the network program." } ] }, "docs": "Get network program." } ] }, { "info": { "name": "Funding Events", "type": "folder" }, "items": [ { "info": { "name": "List funding events", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/funding_events", "params": [ { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (for pagination)." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." } ] }, "docs": "Get all funding events for program" }, { "info": { "name": "Get funding event by ID", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/funding_events/:funding_event_token", "params": [ { "name": "funding_event_token", "value": "", "type": "path", "description": "Globally unique identifier for funding event." } ] }, "docs": "Get funding event for program by id" }, { "info": { "name": "Get funding event details", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v1/funding_events/:funding_event_token/details", "params": [ { "name": "funding_event_token", "value": "", "type": "path", "description": "Globally unique identifier for funding event." } ] }, "docs": "Get funding event details by id" } ] }, { "info": { "name": "Managed Disputes", "type": "folder" }, "items": [ { "info": { "name": "List disputes", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v2/disputes", "params": [ { "name": "begin", "value": "", "type": "query", "description": "RFC 3339 timestamp for filtering by created date, inclusive." }, { "name": "end", "value": "", "type": "query", "description": "RFC 3339 timestamp for filtering by created date, inclusive." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of items to return." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item." }, { "name": "disputed_transaction_token", "value": "", "type": "query", "description": "Filter by the token of the transaction being disputed. Corresponds with transaction_series.related_transaction_token in the Dispute." }, { "name": "card_token", "value": "", "type": "query", "description": "Filter by card token." }, { "name": "account_token", "value": "", "type": "query", "description": "Filter by account token." } ] }, "docs": "Returns a paginated list of disputes." }, { "info": { "name": "Retrieve a dispute", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.lithic.com/v2/disputes/:dispute_token", "params": [ { "name": "dispute_token", "value": "", "type": "path", "description": "Token of the dispute to retrieve." } ] }, "docs": "Retrieves a specific dispute by its token." } ] } ], "bundled": true }