> ## 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. # Send an invite > Emails a previously created invite to the merchant. Use this after **Create an invite** when you want to control the timing of delivery. ## OpenAPI ````yaml /openapi.json post /v1/onboardinginvites/send 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/send: post: tags: - Onboarding Invites summary: Send an invite description: >- Emails a previously created invite to the merchant. Use this after **Create an invite** when you want to control the timing of delivery. requestBody: description: '***create an onboarding invite first and get the inviteId***' required: true content: application/json: schema: type: object properties: inviteId: type: string example: '' description: The inviteId of the onboarding invite. required: - inviteId responses: '200': $ref: '#/components/responses/sendOnboardingInvites' '400': description: Bad Request. Invalid input. '401': description: Unauthorized. '500': description: Internal Server Error. components: responses: sendOnboardingInvites: description: Onboarding invite successfully sent. content: application/json: schema: type: object properties: success: type: boolean example: true description: >- Whether the request was processed successfully. Declines return HTTP 200 with `success: false`. code: type: string example: '0' description: Machine-readable result code. See the Error Codes reference. message: type: string example: Invite has been sent description: Human-readable result message. data: type: object properties: notifications: type: object properties: email: type: object properties: enabled: type: boolean example: true description: Whether this setting is enabled. sent: type: boolean example: true description: Whether the notification was sent. sentAt: type: string format: date-time example: '2025-02-07T13:24:53.838Z' description: Timestamp when it was sent (ISO 8601). description: Email notification status. sms: type: object properties: enabled: type: boolean example: false description: Whether this setting is enabled. sent: type: boolean example: false description: Whether the notification was sent. description: SMS notification status. description: Delivery status of invite notifications. identity: type: object properties: owners: type: array items: type: object properties: title: type: string example: Mr. description: Salutation of the owner (`Mr.`, `Ms.`, `Mrs.`). 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 of the owner. 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 example: NY description: Two-letter US state code. postalCode: type: string example: '23434' description: ZIP or postal code. ssnLast4: type: string example: '123123123' description: Last 4 digits of the owner's SSN. ownershipPercentage: type: integer example: 100 description: >- Percentage of the business this owner holds (0-100). email: type: string example: mail_m@asd.com 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 for the business. description: Identity details for the business and its owners. fees: 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 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: 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. billTo: type: string example: submerchant 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 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. billTo: type: string example: submerchant 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 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. billTo: type: string example: submerchant 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 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. billTo: type: string example: submerchant 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 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. billTo: type: string example: submerchant 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 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. billTo: type: string example: submerchant 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 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. billTo: type: string example: submerchant 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 example: 25 description: >- Fixed fee amount charged each time this event occurs. billTo: type: string example: submerchant 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 example: 0 description: >- Fixed fee amount charged each time this event occurs. billTo: type: string example: submerchant 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 example: 0.5 description: >- Fixed fee amount charged each time this event occurs. billTo: type: string example: submerchant 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 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. billTo: type: string example: submerchant 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 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. billTo: type: string example: submerchant 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 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. billTo: type: string example: submerchant 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 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. billTo: type: string example: submerchant 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 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. billTo: type: string example: submerchant 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 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. billTo: type: string example: submerchant 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 description: >- Recurring fees charged on a fixed schedule, such as monthly service fees. items: description: Fee entries. description: Fee configuration at the platform level. spProduct: type: object properties: perTransaction: type: object properties: ccCnpSale: type: object properties: 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 card-not-present sale. ccCnpCapture: type: object properties: 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 card-not-present capture. ccCnpAuth: type: object properties: 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 card-not-present authorization. ccCnpVoid: type: object properties: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: {} 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. _id: type: string example: 67a6098d7151ee56479d1bde description: Internal document identifier. facId: type: string example: JPT description: Facilitator identifier assigned by Jupico. spProductId: type: string example: '255' description: >- Identifier of the Service Provider product the merchant belongs to. inviteId: type: string example: 25754e1d-62b4-479e-a4b9-acd9f57557ea description: Unique identifier of the onboarding invite. name: type: string example: Tech description: Display name. email: type: string example: test@gmail.com description: Email address. phoneNumber: type: string example: '2995318324' description: Phone number. reference: type: string example: '1234' description: Your own reference for this invite. url: type: string format: uri example: >- https://sandbox-payments-onboarding.jupico.com/jpt-sim-demo/get-started?invite=25754e1d-62b4-479e-a4b9-acd9f57557ea description: URL of the hosted page for this object. status: type: string example: sent description: Current status. isDeleted: type: boolean example: false description: Whether the record is soft-deleted. feesTemplateId: type: string example: 415dd627-006f-4477-a2eb-47c6eb7a4534 description: >- UUID of a fees template with predefined pricing. If omitted, the default template is used. onboardingFlowTemplateId: type: string example: 7f10de6b-971c-4ad9-9f09-cdf03c5b303e description: >- UUID of the onboarding flow template that controls which steps the merchant sees. expiresAt: type: string format: date-time example: '2025-03-07T13:24:53.838Z' 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 example: '2025-02-07T13:24:29.237Z' description: Timestamp when the object was created (ISO 8601). updatedAt: type: string format: date-time example: '2025-02-07T13:24:53.840Z' description: Timestamp when the object was last updated (ISO 8601). __v: type: integer example: 0 description: Internal document version. Ignore. description: The response payload. securitySchemes: basicAuth: type: http scheme: basic ````