> ## 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. # Create an additional-MID invite > Creates an invite that adds a new submerchant for an existing applicant — an additional MID request. Optionally scope the invite to an existing application with `invitedToSmAppId`. ## OpenAPI ````yaml /openapi.json post /v1/onboardinginvites/addsubmerchant 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/onboardinginvites/addsubmerchant: post: tags: - Onboarding Invites summary: Create an additional-MID invite description: >- Creates an invite that adds a new submerchant for an existing applicant — an additional MID request. Optionally scope the invite to an existing application with `invitedToSmAppId`. requestBody: required: true content: application/json: schema: type: object properties: spProductId: type: string example: '255' description: The Service provider product reference. maxLength: 100 reference: type: string example: Reference 123 description: The invite reference. maxLength: 100 applicantId: type: string example: 682e0ef81da12ab7229dbf64 description: The aplicant reference invitedToSmAppId: type: string example: 682e176bbee4495f337a0464 description: Application reference to filter in the invite identity: type: object properties: owners: $ref: '#/components/schemas/Owner' business: $ref: '#/components/schemas/Business' contact: $ref: '#/components/schemas/Contact' description: >- The identity object containing data about the business and its representatives payoutBankAccounts: type: array items: type: object properties: accountRouting: type: string example: '123123122' maxLength: 9 description: 9-digit ABA routing number. accountNumber: type: string example: '8789545642' minLength: 6 maxLength: 17 description: Bank account number. accountType: type: string enum: - checking example: checking maxLength: 20 description: Bank account type, such as `checking`. nameOnAccount: type: string example: Updatedjonnydooeiacc maxLength: 50 description: Name on the bank account. description: Bank accounts where the merchant receives payouts. feesTemplateId: description: >- UUID of the fees template with predefined fees. If no value is passed, the id of the default template will be used. type: string example: '' fees: description: >- The fees object will overwrite the values set on the fees template, as specified by the feesTemplateId. This allows for customization of fees at the invite overriding any defaults defined in the template. type: object properties: platform: type: object properties: interchange: type: object properties: enabled: type: boolean example: false description: Whether this setting is enabled. billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Interchange pass-through fee settings. perTransaction: type: object properties: ccCnpSale: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). discountRate: type: number example: 2 description: Percentage fee charged on the event amount. fixed: type: number example: 0.3 description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each card-not-present sale. ccCnpCapture: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). discountRate: type: number example: 2 description: Percentage fee charged on the event amount. fixed: type: number example: 0.3 description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each card-not-present capture. ccCnpAuth: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). discountRate: type: number example: 2 description: Percentage fee charged on the event amount. fixed: type: number example: 0.25 description: >- Fixed fee amount charged each time this event occurs. description: >- Fee applied to each card-not-present authorization. ccCnpVoid: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0 description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean example: true description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean example: true description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each card-not-present void. ccCnpRefund: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0.75 description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean example: false description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean example: true description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each card-not-present refund. ccCnpCredit: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0.75 description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean example: false description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean example: true description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each card-not-present credit. ccCnpReversal: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0.75 description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean example: false description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean example: true description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each card-not-present reversal. ccCnpChargeback: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 25 description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each chargeback. ccCnpAvsOnly: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0 description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each AVS-only verification. ccCnpDeclined: type: object properties: billTo: type: string example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0.5 description: >- Fixed fee amount charged each time this event occurs. description: >- Fee applied to each declined card-not-present attempt. checkSale: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). discountRate: type: number example: 2.9 description: Percentage fee charged on the event amount. fixed: type: number example: 0.3 description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each eCheck sale. checkVerification: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). discountRate: type: number example: 0 description: Percentage fee charged on the event amount. fixed: type: number example: 0 description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each eCheck verification. checkVoid: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0 description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean example: true description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean example: true description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each eCheck void. checkRefund: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0.75 description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean example: false description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean example: true description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each eCheck refund. checkCredit: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0.75 description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean example: false description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean example: true description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each eCheck credit. checkReversal: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0.75 description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean example: false description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean example: true description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each eCheck reversal. description: >- Event-based fees, one entry per transaction event type. perPeriod: type: array items: type: object properties: period: type: string example: daily enum: - today - yesterday - last-7-days - this-month - this-year - last-6-months - one-time - daily - weekly - monthly - quarterly - per-semester - annually description: Billing period for this recurring fee. fixed: type: number example: 3 description: >- Fixed fee amount charged each time this event occurs. since: type: string format: date-time example: '2025-08-01T03:00:00.000Z' description: >- Start of the window during which this fee applies (ISO 8601). until: type: string format: date-time example: '2025-08-23T03:00:00.000Z' description: >- End of the window during which this fee applies (ISO 8601). status: type: string example: enabled description: >- Whether this recurring fee is currently active. isTriggerFirstTx: type: boolean example: false description: >- When true, the recurring fee starts only after the merchant processes their first transaction. isProrated: type: boolean example: true description: Whether the first billing period is prorated. description: >- Recurring fees charged on a fixed schedule, such as monthly service fees. description: Fee configuration at the platform level. spProduct: type: object properties: interchange: type: object properties: enabled: type: boolean example: false description: Whether this setting is enabled. billTo: type: string example: submerchant description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Interchange pass-through fee settings. perTransaction: type: object properties: ccCnpSale: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). discountRate: type: number example: 2 description: Percentage fee charged on the event amount. fixed: type: number example: 0.3 description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each card-not-present sale. ccCnpCapture: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). discountRate: type: number example: 2 description: Percentage fee charged on the event amount. fixed: type: number example: 0.3 description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each card-not-present capture. ccCnpAuth: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). discountRate: type: number example: 2 description: Percentage fee charged on the event amount. fixed: type: number example: 0.25 description: >- Fixed fee amount charged each time this event occurs. description: >- Fee applied to each card-not-present authorization. ccCnpVoid: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0 description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean example: true description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean example: true description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each card-not-present void. ccCnpRefund: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0.75 description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean example: false description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean example: true description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each card-not-present refund. ccCnpCredit: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0.75 description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean example: false description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean example: true description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each card-not-present credit. ccCnpReversal: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0.75 description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean example: false description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean example: true description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each card-not-present reversal. ccCnpChargeback: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 25 description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each chargeback. ccCnpAvsOnly: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0 description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each AVS-only verification. ccCnpDeclined: type: object properties: billTo: type: string example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0.5 description: >- Fixed fee amount charged each time this event occurs. description: >- Fee applied to each declined card-not-present attempt. checkSale: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). discountRate: type: number example: 2.9 description: Percentage fee charged on the event amount. fixed: type: number example: 0.3 description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each eCheck sale. checkVerification: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). discountRate: type: number example: 0 description: Percentage fee charged on the event amount. fixed: type: number example: 0 description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each eCheck verification. checkVoid: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0 description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean example: true description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean example: true description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each eCheck void. checkRefund: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0.75 description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean example: false description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean example: true description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each eCheck refund. checkCredit: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0.75 description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean example: false description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean example: true description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each eCheck credit. checkReversal: type: object properties: billTo: type: string enum: - spProduct - submerchant example: spProduct description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). fixed: type: number example: 0.75 description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean example: false description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean example: true description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each eCheck reversal. description: >- Event-based fees, one entry per transaction event type. perPeriod: type: array items: type: object properties: period: type: string example: daily enum: - today - yesterday - last-7-days - this-month - this-year - last-6-months - one-time - daily - weekly - monthly - quarterly - per-semester - annually description: Billing period for this recurring fee. fixed: type: number example: 3 description: >- Fixed fee amount charged each time this event occurs. since: type: string format: date-time example: '2025-08-01T03:00:00.000Z' description: >- Start of the window during which this fee applies (ISO 8601). until: type: string format: date-time example: '2025-08-23T03:00:00.000Z' description: >- End of the window during which this fee applies (ISO 8601). status: type: string example: enabled description: >- Whether this recurring fee is currently active. isTriggerFirstTx: type: boolean example: false description: >- When true, the recurring fee starts only after the merchant processes their first transaction. isProrated: type: boolean example: true description: Whether the first billing period is prorated. description: >- Recurring fees charged on a fixed schedule, such as monthly service fees. description: Fee configuration at the Service Provider product level. onboardingFlowTemplateId: type: string description: >- UUID of the onboarding flow template to be used for the onboarding experience. example: '' example: spProductId: '255' reference: '1234' applicantId: 256cb1d53111090100000123 invitedToSmAppId: 643ef0424e44b4f361999487 identity: owners: - title: Mr. firstName: jonny middleName: eric lastName: dooei birthDate: '2000-08-01' phoneNumber: '2232322323' streetNum: '79' streetName: clarks city: ny state: NY postalCode: '23434' ssn: '123123123' ownershipPercentage: 100 email: mail_m@asd.com required: - name - email responses: '201': $ref: '#/components/responses/createOnboardingInvite' '400': description: Bad Request. Invalid input. '401': description: Unauthorized. '500': description: Internal Server Error. components: schemas: Owner: type: array items: type: object properties: title: type: string enum: - Mr. - Ms. - Mrs. example: Mr. description: Title. firstName: type: string example: jonny description: First name. middleName: type: string example: eric description: Middle name. lastName: type: string example: dooei description: Last name. birthDate: type: string format: date example: '2000-08-01' description: Date of birth (YYYY-MM-DD). phoneNumber: type: string example: '2232322323' description: Phone number. streetNum: type: string example: '79' description: Street number. streetName: type: string example: clarks description: Street name. city: type: string example: ny description: City name. state: type: string enum: - AK - AL - AR - AZ - CA - CO - CT - DE - FL - GA - HI - IA - ID - IL - IN - KS - KY - LA - MA - ME - MD - MI - MN - MS - MO - MT - NC - ND - NE - NH - NJ - NM - NV - NY - OH - OK - OR - PA - RI - SC - SD - TN - TX - UT - VA - VT - WA - WI - WV - WY example: NY description: Two-letter US state code. postalCode: type: string example: '23434' description: ZIP or postal code. ssn: type: string example: '123123123' description: Social Security number, 9 digits. position: type: string enum: - OW - CEO - CFO - COO - PRESIDENT - VICE PRESIDENT - DIR - TR - SEC - PA - MEMBER LLC - OTH - SP description: | The position of the owner. Possible values are: - OW: Owner - CEO: Chief Executive Officer - CFO: Chief Financial Officer - COO: Chief Operating Officer - PRESIDENT: President - VICE PRESIDENT: Vice President - DIR: Director - TR: Treasurer - SEC: Secretary - PA: Partner - MEMBER LLC: Member of LLC - OTH: Other - SP: Sole Proprietorship example: CEO ownershipPercentage: type: integer example: 100 description: Percentage of the business this owner holds (0-100). email: type: string format: email example: mail_m@asd.com description: Email address. Business: type: object properties: legalName: type: string example: testInvite description: Registered legal name of the business. dbaName: type: string example: testDBAInvite description: >- The merchant's doing-business-as name. Appears on customer statements unless overridden. federalTaxId: type: string example: '999999999' description: Federal tax ID, 9 digits. tinType: type: string enum: - SSN - EIN - Other example: SSN description: | The type of Tax Identification Number (TIN): - SSN (Social Security Number) - EIN (Employer Identification Number) - Other mccCode: type: string example: '5812' description: >- Four-digit merchant category code (MCC) that classifies the business. phoneNumber: type: string example: '2232322323' description: Phone number. address: type: object properties: streetNum: type: string example: '123' description: Street number. streetName: type: string example: main street description: Street name. city: type: string example: ny description: City name. state: type: string enum: - AK - AL - AR - AZ - CA - CO - CT - DE - FL - GA - HI - IA - ID - IL - IN - KS - KY - LA - MA - ME - MD - MI - MN - MS - MO - MT - NC - ND - NE - NH - NJ - NM - NV - NY - OH - OK - OR - PA - RI - SC - SD - TN - TX - UT - VA - VT - WA - WI - WV - WY example: NY description: Two-letter US state code. postalCode: type: string example: '22222' description: ZIP or postal code. description: Address details. websiteUrl: type: string format: uri example: https://www.sarasa.com description: Business website URL. ownershipType: type: string enum: - PublicCorporation - Government - PrivateCorporation - SoleProprietorship - LLC - Partnership - NonProfit - Trust example: PrivateCorporation description: Legal structure of the business. businessEstablishedDate: format: date-time example: '2023-11-02' description: 'Format: YYYY-MM-DD' expectedMonthlyVolume: type: integer example: 200 description: Expected monthly processing volume, used in underwriting. Contact: type: object properties: firstName: type: string example: John description: First name. middleName: type: string example: Michael description: Middle name. lastName: type: string example: Doe description: Last name. birthDate: type: string format: date example: '1990-01-15' description: 'Format: YYYY-MM-DD' position: type: string example: CEO description: Role of the owner in the business. ssn: type: string example: 123-45-6789 description: Social Security Number phoneNumber: type: string example: '5551234567' description: Phone number. email: type: string format: email example: john.doe@example.com description: Email address. responses: createOnboardingInvite: description: Onboarding invite successfully created. content: application/json: schema: type: object properties: success: type: boolean description: >- Whether the request was processed successfully. Declines return HTTP 200 with `success: false`. code: type: string description: Machine-readable result code. See the Error Codes reference. message: type: string description: Human-readable result message. data: type: object properties: facId: type: string description: Facilitator identifier assigned by Jupico. spProductId: type: string description: >- Identifier of the Service Provider product the merchant belongs to. inviteId: type: string description: Unique identifier of the onboarding invite. name: type: string description: Display name. email: type: string description: Email address. phoneNumber: type: string description: Phone number. reference: type: string description: Your own reference for this invite. url: type: string format: uri description: URL of the hosted page for this object. notifications: type: object properties: email: type: object properties: enabled: type: boolean description: Whether this setting is enabled. sent: type: boolean description: Whether the notification was sent. description: Email notification status. sms: type: object properties: enabled: type: boolean description: Whether this setting is enabled. sent: type: boolean description: Whether the notification was sent. description: SMS notification status. description: Delivery status of invite notifications. status: type: string description: Current status. isDeleted: type: boolean description: Whether the record is soft-deleted. identity: type: object properties: owners: type: array items: type: object properties: title: type: string description: Salutation of the owner (`Mr.`, `Ms.`, `Mrs.`). firstName: type: string description: First name. middleName: type: string description: Middle name. lastName: type: string description: Last name. birthDate: type: string format: date description: Date of birth (YYYY-MM-DD). phoneNumber: type: string description: Phone number of the owner. streetNum: type: string description: Street number. streetName: type: string description: Street name. city: type: string description: City name. state: type: string description: Two-letter US state code. postalCode: type: string description: ZIP or postal code. ssnLast4: type: string description: Last 4 digits of the owner's SSN. ownershipPercentage: type: integer description: >- Percentage of the business this owner holds (0-100). email: type: string description: Email address of the owner. description: >- Business owners. Required for individual and business entity types. business: type: object properties: {} description: Business identity details. Contact: type: object properties: firstName: type: string example: John description: First name. middleName: type: string example: Michael description: Middle name. lastName: type: string example: Doe description: Last name. birthDate: type: string format: date example: '1990-01-15' description: 'Format: YYYY-MM-DD' position: type: string example: CEO description: Role of the owner in the business. ssn: type: string example: 123-45-6789 description: Social Security Number phoneNumber: type: string example: '5551234567' description: Phone number. email: type: string format: email example: john.doe@example.com description: Email address. description: Primary contact details. description: Identity details for the business and its owners. feesTemplateId: type: string description: >- UUID of a fees template with predefined pricing. If omitted, the default template is used. fees: type: object properties: platform: type: object properties: interchange: type: object properties: enabled: type: boolean description: Whether this setting is enabled. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Interchange pass-through fee settings. perTransaction: type: object properties: ccCnpSale: type: object properties: discountRate: type: number description: >- Percentage fee charged on the event amount. fixed: type: number description: >- Fixed fee amount charged each time this event occurs. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Fee applied to each card-not-present sale. ccCnpCapture: type: object properties: discountRate: type: number description: >- Percentage fee charged on the event amount. fixed: type: number description: >- Fixed fee amount charged each time this event occurs. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Fee applied to each card-not-present capture. ccCnpAuth: type: object properties: discountRate: type: number description: >- Percentage fee charged on the event amount. fixed: type: number description: >- Fixed fee amount charged each time this event occurs. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: >- Fee applied to each card-not-present authorization. ccCnpVoid: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean description: >- Whether the percentage fee is returned when the underlying transaction is reversed. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Fee applied to each card-not-present void. ccCnpRefund: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean description: >- Whether the percentage fee is returned when the underlying transaction is reversed. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Fee applied to each card-not-present refund. ccCnpCredit: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean description: >- Whether the percentage fee is returned when the underlying transaction is reversed. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Fee applied to each card-not-present credit. ccCnpReversal: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean description: >- Whether the percentage fee is returned when the underlying transaction is reversed. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Fee applied to each card-not-present reversal. ccCnpChargeback: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Fee applied to each chargeback. ccCnpAvsOnly: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Fee applied to each AVS-only verification. ccCnpDeclined: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: >- Fee applied to each declined card-not-present attempt. checkSale: type: object properties: discountRate: type: number description: >- Percentage fee charged on the event amount. fixed: type: number description: >- Fixed fee amount charged each time this event occurs. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Fee applied to each eCheck sale. checkVerification: type: object properties: discountRate: type: number description: >- Percentage fee charged on the event amount. fixed: type: number description: >- Fixed fee amount charged each time this event occurs. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Fee applied to each eCheck verification. checkVoid: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean description: >- Whether the percentage fee is returned when the underlying transaction is reversed. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Fee applied to each eCheck void. checkRefund: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean description: >- Whether the percentage fee is returned when the underlying transaction is reversed. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Fee applied to each eCheck refund. checkCredit: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean description: >- Whether the percentage fee is returned when the underlying transaction is reversed. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Fee applied to each eCheck credit. checkReversal: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean description: >- Whether the percentage fee is returned when the underlying transaction is reversed. billTo: type: string description: >- Which party is billed for this fee: `spProduct` (the Service Provider) or `submerchant` (the merchant). description: Fee applied to each eCheck reversal. description: >- Event-based fees, one entry per transaction event type. perPeriod: type: array items: {} description: >- Recurring fees charged on a fixed schedule, such as monthly service fees. description: Fee configuration at the platform level. spProduct: type: object properties: perTransaction: type: object properties: ccCnpSale: type: object properties: discountRate: type: number description: >- Percentage fee charged on the event amount. fixed: type: number description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each card-not-present sale. ccCnpCapture: type: object properties: discountRate: type: number description: >- Percentage fee charged on the event amount. fixed: type: number description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each card-not-present capture. ccCnpAuth: type: object properties: discountRate: type: number description: >- Percentage fee charged on the event amount. fixed: type: number description: >- Fixed fee amount charged each time this event occurs. description: >- Fee applied to each card-not-present authorization. ccCnpVoid: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each card-not-present void. ccCnpRefund: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each card-not-present refund. ccCnpCredit: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each card-not-present credit. ccCnpReversal: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each card-not-present reversal. ccCnpChargeback: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each chargeback. ccCnpAvsOnly: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each AVS-only verification. ccCnpDeclined: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. description: >- Fee applied to each declined card-not-present attempt. checkSale: type: object properties: discountRate: type: number description: >- Percentage fee charged on the event amount. fixed: type: number description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each eCheck sale. checkVerification: type: object properties: discountRate: type: number description: >- Percentage fee charged on the event amount. fixed: type: number description: >- Fixed fee amount charged each time this event occurs. description: Fee applied to each eCheck verification. checkVoid: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each eCheck void. checkRefund: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each eCheck refund. checkCredit: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each eCheck credit. checkReversal: type: object properties: fixed: type: number description: >- Fixed fee amount charged each time this event occurs. reverseFixed: type: boolean description: >- Whether the fixed fee is returned when the underlying transaction is reversed. reverseDiscountRate: type: boolean description: >- Whether the percentage fee is returned when the underlying transaction is reversed. description: Fee applied to each eCheck reversal. description: >- Event-based fees, one entry per transaction event type. perPeriod: type: array items: {} description: >- Recurring fees charged on a fixed schedule, such as monthly service fees. description: >- Fee configuration at the Service Provider product level. description: >- Fee configuration. Overrides values from the fees template. onboardingFlowTemplateId: type: string description: >- UUID of the onboarding flow template that controls which steps the merchant sees. expiresAt: type: string format: date-time description: Timestamp when this object expires (ISO 8601). payoutBankAccounts: type: array items: {} description: Bank accounts where the merchant receives payouts. createdAt: type: string format: date-time description: Timestamp when the object was created (ISO 8601). updatedAt: type: string format: date-time description: Timestamp when the object was last updated (ISO 8601). description: The response payload. securitySchemes: basicAuth: type: http scheme: basic ````