> ## Documentation Index > Fetch the complete documentation index at: https://docs.tesouro.com/llms.txt > Use this file to discover all available pages before exploring further. # Get limit summary > The caller's Bank's open bank accounts rolled up by Business Customer, VSP or Platform, or for the whole Bank, with cursor-based pagination. Readable by the Bank only. Each row counts its bank accounts and sums their Effective Limits, their Usage in the current Limit Day, and what each has left, floored at zero before summing. By VSP or Platform, the bank accounts with none stored share one row without an `organizationId`, so every level sums to the whole Bank. With `organizationId`, only that organization's row, or none when it has no open bank accounts at that level. Send the same `groupBy` and `organizationId` with a pagination token. **Token types:** APP, USER | **Required scopes:** `bank_account:read:org` ## OpenAPI ````yaml /.tooling/schemas/rest/tags/product-embedded-banking.json get /instant-payment-limits/summary openapi: 3.1.0 info: title: Tesouro Partner API version: '2025-06-23' description: The Tesouro REST API, for Tesouro partners to integrate with our solution. termsOfService: https://tesouro.com/terms contact: name: Tesouro team url: https://tesouro.com/about/ email: developers@tesouro.com servers: - url: https://api.sandbox.tesouro.com description: Sandbox security: [] tags: - name: Applications - name: Authorization Controls - name: Bank Accounts - name: Beneficial Owners - name: Checks - name: Debit Cards - name: Departments - name: Disclosures - name: Embedded Banking - name: External Bank Accounts - name: Instant Payment Eligibility - name: Instant Payment Limits - name: Locations - name: Money Movement - name: OIDC applications - name: Organization Summary - name: Organizations - name: Roles - name: Users paths: /instant-payment-limits/summary: servers: - url: https://api.sandbox.tesouro.com/embedded-banking/v1 description: Sandbox get: tags: - Instant Payment Limits - Embedded Banking summary: Get limit summary description: >- The caller's Bank's open bank accounts rolled up by Business Customer, VSP or Platform, or for the whole Bank, with cursor-based pagination. Readable by the Bank only. Each row counts its bank accounts and sums their Effective Limits, their Usage in the current Limit Day, and what each has left, floored at zero before summing. By VSP or Platform, the bank accounts with none stored share one row without an `organizationId`, so every level sums to the whole Bank. With `organizationId`, only that organization's row, or none when it has no open bank accounts at that level. Send the same `groupBy` and `organizationId` with a pagination token. **Token types:** APP, USER | **Required scopes:** `bank_account:read:org` operationId: GetInstantPaymentLimitSummary parameters: - name: groupBy in: query description: The level to roll the bank accounts up to. required: true schema: $ref: '#/components/schemas/InstantPaymentLimitSummaryGroupBy' - name: organizationId in: query description: >- Only this Business Customer's, VSP's or Platform's row, at the level `groupBy` names. Not with `groupBy` BANK. schema: type: string format: uuid - name: limit in: query description: Number of items to return (default 25, max 100). schema: pattern: ^-?(?:0|[1-9]\d*)$ type: - integer - string format: int32 default: 25 - name: pagination_token in: query description: Opaque pagination token from a previous response. schema: type: string responses: '200': description: Returns the rollups. content: application/json: schema: $ref: '#/components/schemas/InstantPaymentLimitSummaryResponse' '400': description: >- The groupBy is missing or not a supported value, or an organizationId is sent with groupBy BANK. content: application/json: schema: $ref: '#/components/schemas/EmbedValidationProblemDetails' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '403': description: The caller is not at a Bank, or may not read bank accounts. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' security: - APPToken: - bank_account:read:org - USERToken: - bank_account:read:org components: schemas: InstantPaymentLimitSummaryGroupBy: enum: - BUSINESS_CUSTOMER - VSP - PLATFORM - BANK type: string description: >- The level the Bank's open bank accounts are rolled up to: each Business Customer, VSP or Platform, or the whole Bank. InstantPaymentLimitSummaryResponse: required: - limitDayEndsAt - data type: object properties: data: type: array items: $ref: '#/components/schemas/InstantPaymentLimitSummaryGroupResponse' description: The items in the current page. limitDayEndsAt: type: string description: When the current Limit Day ends and Usage starts again (UTC). format: date-time nextPaginationToken: type: - 'null' - string description: >- A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. prevPaginationToken: type: - 'null' - string description: >- A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. description: >- A page of the Bank's open bank accounts rolled up to the requested level. EmbedValidationProblemDetails: required: - errorCode type: object properties: detail: type: - 'null' - string errorCode: type: string description: Embed-specific error code for client error handling. errors: type: object additionalProperties: type: array items: type: string instance: type: - 'null' - string questionErrors: type: - 'null' - array items: $ref: '#/components/schemas/QuestionError' description: >- The application questions that failed. Null when the endpoint validates no application questions. requirementsVersion: type: - 'null' - string description: >- The application requirements version the request was validated against. Null when none applies. status: pattern: ^-?(?:0|[1-9]\d*)$ type: - 'null' - integer - string format: int32 title: type: - 'null' - string type: type: - 'null' - string description: >- Problem details for a request the service rejected as invalid. Follows RFC 7807, with the Embed error code and the fields and questions that failed. ProblemDetails: type: object properties: detail: type: - 'null' - string instance: type: - 'null' - string status: pattern: ^-?(?:0|[1-9]\d*)$ type: - 'null' - integer - string format: int32 title: type: - 'null' - string type: type: - 'null' - string InstantPaymentLimitSummaryGroupResponse: required: - bankAccountCount - limitExposure - usage - remaining type: object properties: bankAccountCount: pattern: ^-?(?:0|[1-9]\d*)$ type: - integer - string description: >- How many open bank accounts the row covers, including any whose limit does not resolve. format: int32 limitExposure: $ref: '#/components/schemas/AmountOutput' description: >- The sum of the bank accounts' Effective Limits. A bank account whose limit does not resolve adds nothing. organizationId: type: - 'null' - string description: >- The Business Customer, VSP, Platform or Bank the bank accounts sit beneath. Absent on the one row for the bank accounts with no VSP, or no Platform, as Embed last stored them. format: uuid remaining: $ref: '#/components/schemas/AmountOutput' description: >- The sum of what each bank account has left today, each never below zero, so a bank account over its limit takes nothing from another's. A bank account whose limit does not resolve adds nothing. usage: $ref: '#/components/schemas/AmountOutput' description: >- The Instant Payments counted against the bank accounts' limits in the current Limit Day. description: >- The open bank accounts beneath one organization at the requested level, with their daily Instant Payment limits, shared by RTP and FedNow, summed. QuestionError: required: - code - message type: object properties: code: $ref: '#/components/schemas/QuestionErrorCode' description: Why the question failed. itemPath: type: - 'null' - string description: >- Where inside an array-valued answer the failure is, relative to the question, such as `[0].name`. key: type: - 'null' - string description: >- The question's stable key. Null when no single question owns the failure. message: type: string description: >- A readable description of the failure, for display. Its wording is not part of the contract. ownerId: type: - 'null' - string description: The owner whose answer failed. Present for per-owner questions only. format: uuid description: One application question that failed validation. AmountOutput: required: - value - currencyCode type: object properties: currencyCode: type: string description: The ISO 4217 three-letter currency code (e.g. `"USD"`). value: pattern: ^-?(?:0|[1-9]\d*)$ type: - integer - string description: >- The monetary value in the currency's minor units (e.g. cents for USD). For example, USD $12.34 is represented as `1234`. format: int64 description: >- Output model representing a monetary amount in minor units alongside its ISO 4217 currency. QuestionErrorCode: enum: - REQUIRED - TOO_LONG - TOO_SHORT - OUT_OF_RANGE - BAD_FORMAT - NOT_IN_ENUM - OWNERSHIP_EXCEEDS_100 - KYC_NOT_APPROVED - APPLICATION_ALREADY_PROCESSED - UNKNOWN_OWNER - BUSINESS_OWNERS_NOT_SUPPORTED - OWNER_TYPE_MISMATCH type: string description: >- Why an application question failed validation. Switch on this rather than on the message. securitySchemes: APPToken: type: oauth2 description: Application (M2M) OAuth2 access token (client credentials). flows: clientCredentials: tokenUrl: /connect/token scopes: acceptor:application:read: >- View merchant boarding applications, including business and ownership details. Contains sensitive personally identifiable information. acceptor:application:secondaryapproval: >- Provide a secondary approval on merchant boarding and underwriting applications as part of a multi-step review. acceptor:application:write: >- Edit, approve, and manage merchant boarding and underwriting applications, and attach supporting documents. accounting_config:read:org: >- View ledger accounts, tax rates, cost centers, tags, and projects configured for your organization. accounting_config:write:org: >- Create and update ledger accounts, tax rates, cost centers, tags, and projects for your organization. acquiring:report:read: >- View transaction and settlement reports for your acquiring activity. approval_policy:read:org: >- View approval workflows and spending policies configured for your organization. approval_policy:write:org: >- Create and update approval workflows and spending policies for your organization. approval_request:create:org: >- Submit items for approval within your organization's approval workflows. approval_request:delete:org: Delete approval requests within your organization. approval_request:read:org: >- View pending and completed approval requests across your organization. approval_request:update:org: >- Edit and update existing approval requests within your organization. authorization_control:read:org: Read access to authorization control at the organization level. authorization_control:write:org: Write access to authorization control at the organization level. bank_account_application:read:org: >- View submitted applications to open bank accounts within your organization. bank_account_application:write:org: >- Submit and manage applications to open new bank accounts within your organization. bank_account:read:org: View bank account details and balances within your organization. bank_account:write:org: Create, update, and close bank accounts within your organization. beneficial_owner:read:org: >- View beneficial ownership information, including individuals' ownership stakes and identifying details. check_deposit:write:org: >- Deposit checks into bank accounts within your organization by submitting the check details for processing. comment:read:org: >- View comments and notes added to financial records across your organization. comment:write:org: >- Add and manage comments and notes on financial records across your organization. counterpart:read:org: >- View the suppliers and clients your organization transacts with. Counterparts are required before creating invoices, quotes, and other financial documents. counterpart:write:org: >- Add and update the suppliers and clients your organization transacts with. Counterparts are required before creating invoices, quotes, and other financial documents. credit_card:activate:org: >- Activate newly issued credit cards for use within your organization. credit_card_application:read:org: View credit card applications submitted within your organization. credit_card_application:write:org: >- Submit and manage credit card applications within your organization. credit_card:issue:org: Issue new credit cards for cardholders in your organization. credit_card:read:org: >- View credit card details and status for cards in your organization. debit_card:activate:org: >- Activate newly issued debit cards for use within your organization. debit_card:close:org: Permanently close debit cards in your organization. debit_card:issue:org: Issue new debit cards for cardholders in your organization. debit_card:lock:org: Lock or unlock debit cards in your organization. debit_card:read:org: View debit card details and status for cards in your organization. developer_portal: >- Access the Tesouro Developer Portal to view API documentation and manage developer resources. dispute:read: >- View payment disputes and any supporting documents attached to them. dispute:write: >- Accept or challenge payment disputes by uploading and submitting supporting evidence. email: '' expense:approve:org: >- Review and approve or reject expense reports submitted across your organization. expense:pay:org: Mark expense reimbursements as paid across your organization. expense:read:org: View expense reports and submissions across your organization. expense:read:self: View your own expense submissions and reports. expense:write:org: Create and update expense submissions across your organization. expense:write:self: Submit and update your own expense reports. export:read:org: >- View and download previously generated data exports for your organization. export:read:self: View and download the data exports you generated. export:write:org: Generate and manage data exports for your organization. external_bank_account:micro_deposit:org: >- Initiate micro-deposit verification to confirm ownership of external bank accounts linked to your organization. external_bank_account:read:org: >- View external bank accounts that have been linked to your organization. external_bank_account:set_verification:org: >- Manually set the verification status of linked external bank accounts, bypassing the standard verification process. external_bank_account:write:org: >- Add, update, or remove external bank accounts linked to your organization. instant_payment_limit:write:org: >- Set instant payment limits and limit exposure alerts for your bank and the organizations and bank accounts beneath it. invoice:read:org: View invoices issued and received across your organization. invoice:write:org: Create, edit, and manage invoices across your organization. mailbox:read:org: >- View the email mailboxes configured to automatically capture incoming invoices as payables and collect expense receipts for your organization. mailbox:write:org: >- Configure email mailboxes that automatically capture incoming invoices as payables and collect expense receipts for your organization. notification:subscription:read: >- View active webhook and event notification subscriptions and their configurations. notification:subscription:write: >- Create, update, and delete webhook and event notification subscriptions. ocr_task:read:org: >- View the results and status of automated receipt and invoice scanning tasks. ocr_task:write:org: >- Submit and manage automated receipt and invoice scanning tasks for your organization. offline_access: '' oidc:app:manage: >- Add, edit, and remove access to OIDC applications and their scopes. oidc:app:read: Read only access to the OIDC applications and their scopes oidc:app:write: >- Add and edit - but not remove - access to OIDC applications and their scopes openid: '' organization:read:org: View your organization's profile and general details. organization_settings:read:org: View configuration settings for your organization. organization_settings:write:org: Update configuration settings for your organization. organization:write:org: Update your organization's profile and general details. org:write:all: >- Enable or disable organizations on the platform. This is a high-privilege permission typically reserved for platform administrators. partner_portal: >- Access the Tesouro Partner Portal to manage your partnership settings and sub-merchant configurations. payable:approve:org: >- Review and approve bills and accounts payable before they are paid. payable:pay:org: >- Authorize and submit payments for approved bills and accounts payable. payable:read:org: View bills and accounts payable across your organization. payable:write:org: >- Create and update bills and accounts payable across your organization. payment:collect:org: >- Collect payments for your organization by depositing them and recording them against the invoices they pay. payment_link:write: >- Generate and manage shareable payment links to collect payments from customers. payment_processing: '' payment_rail:ach: Process payments via the ACH (Automated Clearing House) network. payment_rail:fednow: Process instant payments via the FedNow network. payment_rail:rtp: Process real-time payments via the RTP network. payment_record:read:org: >- View payment transaction history and records for your organization. payment_record:write:org: >- Record payments against invoices and manage their status, including marking payments as succeeded, cancelling, or moving them into processing. product:read:org: >- View the product and service catalog used for invoicing within your organization. product:write:org: >- Add and update products and services in your organization's invoicing catalog. profile: '' role:read:org: >- View user roles and their associated permissions within your organization. role:write:org: >- Create and update user roles and permission sets within your organization. transfer:write:org: Create and submit money transfers within your organization. underwriting:account:read: View underwriting accounts and their account event history. underwriting:account:write: >- Open maintenance reviews on underwriting accounts and close underwriting accounts. underwriting:application:approval:escalation: >- Provide a senior-level escalation approval on underwriting applications that require additional review. underwriting:application:approval:secondary: >- Provide a second-level approval on underwriting applications as part of a multi-step review process. underwriting:application:read: >- View underwriting applications, including sensitive business details and personally identifiable information. underwriting:application:write: >- Edit, approve, and manage underwriting applications and decisions, and attach supporting documents. user_profile:write:all: >- Update profile information for any user across all organizations. This is a high-privilege permission typically reserved for platform administrators. user_profile:write:self: >- Update your own user profile, including your name, contact information, and preferences. user:read:org: View user accounts and their details within your organization. user:read:self: >- Read access to the user's own record and the name/email of their direct reports. user:write:all: >- Create and manage user accounts across multiple organizations. This is a high-privilege permission typically reserved for platform administrators. user:write:org: Create, update, and manage user accounts within your organization. USERToken: type: oauth2 description: User OAuth2 access token (authorization code with PKCE). flows: authorizationCode: authorizationUrl: /connect/authorize tokenUrl: /connect/token scopes: acceptor:application:read: >- View merchant boarding applications, including business and ownership details. Contains sensitive personally identifiable information. acceptor:application:secondaryapproval: >- Provide a secondary approval on merchant boarding and underwriting applications as part of a multi-step review. acceptor:application:write: >- Edit, approve, and manage merchant boarding and underwriting applications, and attach supporting documents. accounting_config:read:org: >- View ledger accounts, tax rates, cost centers, tags, and projects configured for your organization. accounting_config:write:org: >- Create and update ledger accounts, tax rates, cost centers, tags, and projects for your organization. acquiring:report:read: >- View transaction and settlement reports for your acquiring activity. approval_policy:read:org: >- View approval workflows and spending policies configured for your organization. approval_policy:write:org: >- Create and update approval workflows and spending policies for your organization. approval_request:create:org: >- Submit items for approval within your organization's approval workflows. approval_request:delete:org: Delete approval requests within your organization. approval_request:read:org: >- View pending and completed approval requests across your organization. approval_request:update:org: >- Edit and update existing approval requests within your organization. authorization_control:read:org: Read access to authorization control at the organization level. authorization_control:write:org: Write access to authorization control at the organization level. bank_account_application:read:org: >- View submitted applications to open bank accounts within your organization. bank_account_application:write:org: >- Submit and manage applications to open new bank accounts within your organization. bank_account:read:org: View bank account details and balances within your organization. bank_account:write:org: Create, update, and close bank accounts within your organization. beneficial_owner:read:org: >- View beneficial ownership information, including individuals' ownership stakes and identifying details. check_deposit:write:org: >- Deposit checks into bank accounts within your organization by submitting the check details for processing. comment:read:org: >- View comments and notes added to financial records across your organization. comment:write:org: >- Add and manage comments and notes on financial records across your organization. counterpart:read:org: >- View the suppliers and clients your organization transacts with. Counterparts are required before creating invoices, quotes, and other financial documents. counterpart:write:org: >- Add and update the suppliers and clients your organization transacts with. Counterparts are required before creating invoices, quotes, and other financial documents. credit_card:activate:org: >- Activate newly issued credit cards for use within your organization. credit_card_application:read:org: View credit card applications submitted within your organization. credit_card_application:write:org: >- Submit and manage credit card applications within your organization. credit_card:issue:org: Issue new credit cards for cardholders in your organization. credit_card:read:org: >- View credit card details and status for cards in your organization. debit_card:activate:org: >- Activate newly issued debit cards for use within your organization. debit_card:close:org: Permanently close debit cards in your organization. debit_card:issue:org: Issue new debit cards for cardholders in your organization. debit_card:lock:org: Lock or unlock debit cards in your organization. debit_card:read:org: View debit card details and status for cards in your organization. developer_portal: >- Access the Tesouro Developer Portal to view API documentation and manage developer resources. dispute:read: >- View payment disputes and any supporting documents attached to them. dispute:write: >- Accept or challenge payment disputes by uploading and submitting supporting evidence. email: '' expense:approve:org: >- Review and approve or reject expense reports submitted across your organization. expense:pay:org: Mark expense reimbursements as paid across your organization. expense:read:org: View expense reports and submissions across your organization. expense:read:self: View your own expense submissions and reports. expense:write:org: Create and update expense submissions across your organization. expense:write:self: Submit and update your own expense reports. export:read:org: >- View and download previously generated data exports for your organization. export:read:self: View and download the data exports you generated. export:write:org: Generate and manage data exports for your organization. external_bank_account:micro_deposit:org: >- Initiate micro-deposit verification to confirm ownership of external bank accounts linked to your organization. external_bank_account:read:org: >- View external bank accounts that have been linked to your organization. external_bank_account:set_verification:org: >- Manually set the verification status of linked external bank accounts, bypassing the standard verification process. external_bank_account:write:org: >- Add, update, or remove external bank accounts linked to your organization. instant_payment_limit:write:org: >- Set instant payment limits and limit exposure alerts for your bank and the organizations and bank accounts beneath it. invoice:read:org: View invoices issued and received across your organization. invoice:write:org: Create, edit, and manage invoices across your organization. mailbox:read:org: >- View the email mailboxes configured to automatically capture incoming invoices as payables and collect expense receipts for your organization. mailbox:write:org: >- Configure email mailboxes that automatically capture incoming invoices as payables and collect expense receipts for your organization. notification:subscription:read: >- View active webhook and event notification subscriptions and their configurations. notification:subscription:write: >- Create, update, and delete webhook and event notification subscriptions. ocr_task:read:org: >- View the results and status of automated receipt and invoice scanning tasks. ocr_task:write:org: >- Submit and manage automated receipt and invoice scanning tasks for your organization. offline_access: '' oidc:app:manage: >- Add, edit, and remove access to OIDC applications and their scopes. oidc:app:read: Read only access to the OIDC applications and their scopes oidc:app:write: >- Add and edit - but not remove - access to OIDC applications and their scopes openid: '' organization:read:org: View your organization's profile and general details. organization_settings:read:org: View configuration settings for your organization. organization_settings:write:org: Update configuration settings for your organization. organization:write:org: Update your organization's profile and general details. org:write:all: >- Enable or disable organizations on the platform. This is a high-privilege permission typically reserved for platform administrators. partner_portal: >- Access the Tesouro Partner Portal to manage your partnership settings and sub-merchant configurations. payable:approve:org: >- Review and approve bills and accounts payable before they are paid. payable:pay:org: >- Authorize and submit payments for approved bills and accounts payable. payable:read:org: View bills and accounts payable across your organization. payable:write:org: >- Create and update bills and accounts payable across your organization. payment:collect:org: >- Collect payments for your organization by depositing them and recording them against the invoices they pay. payment_link:write: >- Generate and manage shareable payment links to collect payments from customers. payment_processing: '' payment_rail:ach: Process payments via the ACH (Automated Clearing House) network. payment_rail:fednow: Process instant payments via the FedNow network. payment_rail:rtp: Process real-time payments via the RTP network. payment_record:read:org: >- View payment transaction history and records for your organization. payment_record:write:org: >- Record payments against invoices and manage their status, including marking payments as succeeded, cancelling, or moving them into processing. product:read:org: >- View the product and service catalog used for invoicing within your organization. product:write:org: >- Add and update products and services in your organization's invoicing catalog. profile: '' role:read:org: >- View user roles and their associated permissions within your organization. role:write:org: >- Create and update user roles and permission sets within your organization. transfer:write:org: Create and submit money transfers within your organization. underwriting:account:read: View underwriting accounts and their account event history. underwriting:account:write: >- Open maintenance reviews on underwriting accounts and close underwriting accounts. underwriting:application:approval:escalation: >- Provide a senior-level escalation approval on underwriting applications that require additional review. underwriting:application:approval:secondary: >- Provide a second-level approval on underwriting applications as part of a multi-step review process. underwriting:application:read: >- View underwriting applications, including sensitive business details and personally identifiable information. underwriting:application:write: >- Edit, approve, and manage underwriting applications and decisions, and attach supporting documents. user_profile:write:all: >- Update profile information for any user across all organizations. This is a high-privilege permission typically reserved for platform administrators. user_profile:write:self: >- Update your own user profile, including your name, contact information, and preferences. user:read:org: View user accounts and their details within your organization. user:read:self: >- Read access to the user's own record and the name/email of their direct reports. user:write:all: >- Create and manage user accounts across multiple organizations. This is a high-privilege permission typically reserved for platform administrators. user:write:org: Create, update, and manage user accounts within your organization. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.