> ## Documentation Index > Fetch the complete documentation index at: https://docs.jupico.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a submerchant > Updates an existing submerchant. The submerchant must be in `review` status; once activated, it cannot be modified. All `identity.business` fields are optional. `feesTemplateId` and `payoutBankAccounts` are optional, but if `payoutBankAccounts` is provided, `accountRouting`, `accountNumber`, `accountType`, and `nameOnAccount` are required. ## OpenAPI ````yaml /openapi.json post /v1/provisioning/submerchant/update openapi: 3.0.0 info: title: Jupico - OpenAPI 3.0 description: >- The Jupico API lets Service Providers onboard merchants, process card and eCheck (ACH) payments, run hosted payment pages, manage recurring billing, send payouts, and query every resource. All endpoints use HTTPS with Basic authentication and accept and return JSON. Endpoints are grouped by workflow: onboard merchants first, then accept payments, then move funds and report. termsOfService: https://help.jupico.com/references-and-resources/legal contact: email: support@jupico.com license: name: Jupico License url: https://jupico.com version: 1.0.5 servers: - url: https://sandbox-platform.jupico.com security: - basicAuth: [] tags: - name: Status description: Health check for the Jupico API. - name: Onboarding Invites description: >- Create and send invites that onboard merchants through the Jupico-hosted flow, with optional pre-filled identity, fees, and payout bank account data. - name: Provisioning description: >- Onboard merchants from your own UI. Collect onboarding data and submit it through the provisioning chain: applicant → application → submerchant. - name: Session description: >- Create browser authorization sessions for the Jupico web components, so card and bank account data is tokenized client-side and never touches your servers. - name: Tokenization description: >- Convert one-time tokens from the web components into permanent Jupico tokens, or tokenize raw card data if your systems are PCI DSS compliant. - name: Customer description: >- Create and manage customer records that payments, subscriptions, installments, and invoices link to. - name: Card Transactions description: >- Process credit and debit card transactions using tokenized card data: sale, authorization, capture, void, refund, and rollback. - name: eCheck Transactions description: >- Debit customer bank accounts via eCheck (ACH): sale, void, refund, rollback, and bank account tokenization. - name: Checkouts description: >- Hosted checkout sessions where customers complete payment on a Jupico-hosted page. - name: Payment Links description: >- Shareable links that open a Jupico-hosted payment page — no integration code needed at the point of sharing. - name: Invoices description: Create and email invoices that customers pay online. - name: Subscriptions description: >- Recurring billing. Plans define billing schedules and pricing models; subscriptions enroll customers against a stored payment token. - name: Installments description: Split a fixed total into scheduled payments with an optional deposit. - name: Payouts description: >- Send funds from a submerchant's available balance to a tokenized bank account with on-demand payout instructions. - name: Query description: >- Search and report across every resource: transactions, merchants, settlements, balances, disputes, fees, and more. All query endpoints accept the same filter, sort, and pagination envelope — see the Query Capabilities guide. paths: /v1/provisioning/submerchant/update: post: tags: - Provisioning summary: Update a submerchant description: >- Updates an existing submerchant. The submerchant must be in `review` status; once activated, it cannot be modified. All `identity.business` fields are optional. `feesTemplateId` and `payoutBankAccounts` are optional, but if `payoutBankAccounts` is provided, `accountRouting`, `accountNumber`, `accountType`, and `nameOnAccount` are required. operationId: updateSubmerchant requestBody: required: true content: application/json: schema: type: object required: - subMerchantId properties: subMerchantId: type: string description: Submerchant identifier example: 854738f390 identity: type: object properties: business: type: object properties: legalName: type: string maxLength: 150 example: Smith Enterprises LLC description: Registered legal name of the business. dbaName: type: string maxLength: 100 example: DBA description: >- The merchant's doing-business-as name. Appears on customer statements unless overridden. billingDescriptor: type: string maxLength: 25 example: SMITHS STORE description: >- Overrides the descriptor that appears on the cardholder's statement. federalTaxId: type: string description: 9 digits example: '234123456' tinType: type: string enum: - SSN - EIN - OTHER example: EIN description: >- Type of tax identification number: `SSN`, `EIN`, or `Other`. phoneNumber: type: string maxLength: 15 example: '2304923049' description: Business phone number. address: type: object properties: streetNum: type: string maxLength: 9 example: '234' description: Street number. streetName: type: string maxLength: 40 example: asdw street description: Street name. city: type: string maxLength: 30 example: ny description: City name. state: type: string example: NY description: Two-letter US state code. postalCode: type: string maxLength: 5 example: '23435' description: ZIP or postal code. description: Registered business address. websiteUrl: type: string maxLength: 70 example: https://www.web.test description: Business website URL. ownershipType: type: string enum: - SoleProprietorship - PrivateCorporation - Partnership - LLC - Trust - Government - NonProfit - LimitedPartnership - LimitedLiabilityPartnership - PublicCorporation example: SoleProprietorship description: Legal structure of the business. businessEstablishedDate: type: string format: date example: '2015-05-01' description: Date the business was established (YYYY-MM-DD). expectedMonthlyVolume: type: integer example: 2343 description: >- Expected monthly processing volume, used in underwriting. mccCode: type: string description: 4 digits example: '5812' description: Business identity details. description: Identity details for the business and its owners. payoutBankAccounts: type: array items: type: object required: - accountRouting - accountNumber - accountType - nameOnAccount properties: accountRouting: type: string example: '026726656' description: 9-digit ABA routing number. accountNumber: type: string example: '12345678901234567' description: Bank account number. accountType: type: string enum: - checking example: checking description: Bank account type, such as `checking`. nameOnAccount: type: string example: testname description: Name on the bank account. isPreferred: type: boolean example: true description: Whether this is the preferred account for payouts. description: Bank accounts where the merchant receives payouts. feesTemplateId: type: string format: uuid nullable: true example: 415dd627-006f-4477-a2eb-47c6eb7a4534 description: >- UUID of a fees template with predefined pricing. If omitted, the default template is used. responses: '200': description: Submerchant updated successfully content: application/json: schema: type: object properties: code: type: string description: >- Machine-readable result code. See the Error Codes reference. success: type: boolean description: >- Whether the request was processed successfully. Declines return HTTP 200 with `success: false`. message: type: string description: Human-readable result message. data: type: object properties: subMerchantId: type: string description: Unique identifier for the submerchant status: type: string enum: - review - approved - rejected example: review description: Current status. description: The response payload. security: - basicAuth: [] components: securitySchemes: basicAuth: type: http scheme: basic ````