Send an invite

curl --request POST \
  --url https://sandbox-platform.jupico.com/v1/onboardinginvites/send \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "inviteId": ""
}'

import requests

url = "https://sandbox-platform.jupico.com/v1/onboardinginvites/send"

payload = { "inviteId": "" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({inviteId: ''})
};

fetch('https://sandbox-platform.jupico.com/v1/onboardinginvites/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://sandbox-platform.jupico.com/v1/onboardinginvites/send';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({inviteId: ''})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "success": true,
  "code": "0",
  "message": "Invite has been sent",
  "data": {
    "notifications": {
      "email": {
        "enabled": true,
        "sent": true,
        "sentAt": "2025-02-07T13:24:53.838Z"
      },
      "sms": {
        "enabled": false,
        "sent": false
      }
    },
    "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",
          "ssnLast4": "123123123",
          "ownershipPercentage": 100,
          "email": "mail_m@asd.com"
        }
      ],
      "business": {},
      "contact": {
        "firstName": "John",
        "middleName": "Michael",
        "lastName": "Doe",
        "birthDate": "1990-01-15",
        "position": "CEO",
        "ssn": "123-45-6789",
        "phoneNumber": "5551234567",
        "email": "john.doe@example.com"
      }
    },
    "fees": {
      "platform": {
        "interchange": {
          "enabled": false,
          "billTo": "submerchant"
        },
        "perTransaction": {
          "ccCnpSale": {
            "discountRate": 2.9,
            "fixed": 0.3,
            "billTo": "submerchant"
          },
          "ccCnpCapture": {
            "discountRate": 2.9,
            "fixed": 0.3,
            "billTo": "submerchant"
          },
          "ccCnpAuth": {
            "discountRate": 0,
            "fixed": 0,
            "billTo": "submerchant"
          },
          "ccCnpVoid": {
            "fixed": 0,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "submerchant"
          },
          "ccCnpRefund": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true,
            "billTo": "submerchant"
          },
          "ccCnpCredit": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true,
            "billTo": "submerchant"
          },
          "ccCnpReversal": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true,
            "billTo": "submerchant"
          },
          "ccCnpChargeback": {
            "fixed": 25,
            "billTo": "submerchant"
          },
          "ccCnpAvsOnly": {
            "fixed": 0,
            "billTo": "submerchant"
          },
          "ccCnpDeclined": {
            "fixed": 0.5,
            "billTo": "submerchant"
          },
          "checkSale": {
            "discountRate": 2.9,
            "fixed": 0.3,
            "billTo": "submerchant"
          },
          "checkVerification": {
            "discountRate": 0,
            "fixed": 0,
            "billTo": "submerchant"
          },
          "checkVoid": {
            "fixed": 0,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "submerchant"
          },
          "checkRefund": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true,
            "billTo": "submerchant"
          },
          "checkCredit": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true,
            "billTo": "submerchant"
          },
          "checkReversal": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true,
            "billTo": "submerchant"
          }
        },
        "perPeriod": "<array>",
        "items": "<unknown>"
      },
      "spProduct": {
        "perTransaction": {
          "ccCnpSale": {
            "discountRate": 2.9,
            "fixed": 0.3
          },
          "ccCnpCapture": {
            "discountRate": 2.9,
            "fixed": 0.3
          },
          "ccCnpAuth": {
            "discountRate": 0,
            "fixed": 0
          },
          "ccCnpVoid": {
            "fixed": 0,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "ccCnpRefund": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true
          },
          "ccCnpCredit": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true
          },
          "ccCnpReversal": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true
          },
          "ccCnpChargeback": {
            "fixed": 25
          },
          "ccCnpAvsOnly": {
            "fixed": 0
          },
          "ccCnpDeclined": {
            "fixed": 0.5
          },
          "checkSale": {
            "discountRate": 2.9,
            "fixed": 0.3
          },
          "checkVerification": {
            "discountRate": 0,
            "fixed": 0
          },
          "checkVoid": {
            "fixed": 0,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "checkRefund": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true
          },
          "checkCredit": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true
          },
          "checkReversal": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true
          }
        },
        "perPeriod": [
          "<unknown>"
        ]
      }
    },
    "_id": "67a6098d7151ee56479d1bde",
    "facId": "JPT",
    "spProductId": "255",
    "inviteId": "25754e1d-62b4-479e-a4b9-acd9f57557ea",
    "name": "Tech",
    "email": "test@gmail.com",
    "phoneNumber": "2995318324",
    "reference": "1234",
    "url": "https://sandbox-payments-onboarding.jupico.com/jpt-sim-demo/get-started?invite=25754e1d-62b4-479e-a4b9-acd9f57557ea",
    "status": "sent",
    "isDeleted": false,
    "feesTemplateId": "415dd627-006f-4477-a2eb-47c6eb7a4534",
    "onboardingFlowTemplateId": "7f10de6b-971c-4ad9-9f09-cdf03c5b303e",
    "expiresAt": "2025-03-07T13:24:53.838Z",
    "payoutBankAccounts": [
      "<unknown>"
    ],
    "createdAt": "2025-02-07T13:24:29.237Z",
    "updatedAt": "2025-02-07T13:24:53.840Z",
    "__v": 0
  }
}

POST

https://sandbox-platform.jupico.com

onboardinginvites

send

Send an invite

curl --request POST \
  --url https://sandbox-platform.jupico.com/v1/onboardinginvites/send \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "inviteId": ""
}'

import requests

url = "https://sandbox-platform.jupico.com/v1/onboardinginvites/send"

payload = { "inviteId": "" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({inviteId: ''})
};

fetch('https://sandbox-platform.jupico.com/v1/onboardinginvites/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://sandbox-platform.jupico.com/v1/onboardinginvites/send';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({inviteId: ''})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "success": true,
  "code": "0",
  "message": "Invite has been sent",
  "data": {
    "notifications": {
      "email": {
        "enabled": true,
        "sent": true,
        "sentAt": "2025-02-07T13:24:53.838Z"
      },
      "sms": {
        "enabled": false,
        "sent": false
      }
    },
    "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",
          "ssnLast4": "123123123",
          "ownershipPercentage": 100,
          "email": "mail_m@asd.com"
        }
      ],
      "business": {},
      "contact": {
        "firstName": "John",
        "middleName": "Michael",
        "lastName": "Doe",
        "birthDate": "1990-01-15",
        "position": "CEO",
        "ssn": "123-45-6789",
        "phoneNumber": "5551234567",
        "email": "john.doe@example.com"
      }
    },
    "fees": {
      "platform": {
        "interchange": {
          "enabled": false,
          "billTo": "submerchant"
        },
        "perTransaction": {
          "ccCnpSale": {
            "discountRate": 2.9,
            "fixed": 0.3,
            "billTo": "submerchant"
          },
          "ccCnpCapture": {
            "discountRate": 2.9,
            "fixed": 0.3,
            "billTo": "submerchant"
          },
          "ccCnpAuth": {
            "discountRate": 0,
            "fixed": 0,
            "billTo": "submerchant"
          },
          "ccCnpVoid": {
            "fixed": 0,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "submerchant"
          },
          "ccCnpRefund": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true,
            "billTo": "submerchant"
          },
          "ccCnpCredit": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true,
            "billTo": "submerchant"
          },
          "ccCnpReversal": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true,
            "billTo": "submerchant"
          },
          "ccCnpChargeback": {
            "fixed": 25,
            "billTo": "submerchant"
          },
          "ccCnpAvsOnly": {
            "fixed": 0,
            "billTo": "submerchant"
          },
          "ccCnpDeclined": {
            "fixed": 0.5,
            "billTo": "submerchant"
          },
          "checkSale": {
            "discountRate": 2.9,
            "fixed": 0.3,
            "billTo": "submerchant"
          },
          "checkVerification": {
            "discountRate": 0,
            "fixed": 0,
            "billTo": "submerchant"
          },
          "checkVoid": {
            "fixed": 0,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "submerchant"
          },
          "checkRefund": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true,
            "billTo": "submerchant"
          },
          "checkCredit": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true,
            "billTo": "submerchant"
          },
          "checkReversal": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true,
            "billTo": "submerchant"
          }
        },
        "perPeriod": "<array>",
        "items": "<unknown>"
      },
      "spProduct": {
        "perTransaction": {
          "ccCnpSale": {
            "discountRate": 2.9,
            "fixed": 0.3
          },
          "ccCnpCapture": {
            "discountRate": 2.9,
            "fixed": 0.3
          },
          "ccCnpAuth": {
            "discountRate": 0,
            "fixed": 0
          },
          "ccCnpVoid": {
            "fixed": 0,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "ccCnpRefund": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true
          },
          "ccCnpCredit": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true
          },
          "ccCnpReversal": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true
          },
          "ccCnpChargeback": {
            "fixed": 25
          },
          "ccCnpAvsOnly": {
            "fixed": 0
          },
          "ccCnpDeclined": {
            "fixed": 0.5
          },
          "checkSale": {
            "discountRate": 2.9,
            "fixed": 0.3
          },
          "checkVerification": {
            "discountRate": 0,
            "fixed": 0
          },
          "checkVoid": {
            "fixed": 0,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "checkRefund": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true
          },
          "checkCredit": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true
          },
          "checkReversal": {
            "fixed": 0.75,
            "reverseFixed": false,
            "reverseDiscountRate": true
          }
        },
        "perPeriod": [
          "<unknown>"
        ]
      }
    },
    "_id": "67a6098d7151ee56479d1bde",
    "facId": "JPT",
    "spProductId": "255",
    "inviteId": "25754e1d-62b4-479e-a4b9-acd9f57557ea",
    "name": "Tech",
    "email": "test@gmail.com",
    "phoneNumber": "2995318324",
    "reference": "1234",
    "url": "https://sandbox-payments-onboarding.jupico.com/jpt-sim-demo/get-started?invite=25754e1d-62b4-479e-a4b9-acd9f57557ea",
    "status": "sent",
    "isDeleted": false,
    "feesTemplateId": "415dd627-006f-4477-a2eb-47c6eb7a4534",
    "onboardingFlowTemplateId": "7f10de6b-971c-4ad9-9f09-cdf03c5b303e",
    "expiresAt": "2025-03-07T13:24:53.838Z",
    "payoutBankAccounts": [
      "<unknown>"
    ],
    "createdAt": "2025-02-07T13:24:29.237Z",
    "updatedAt": "2025-02-07T13:24:53.840Z",
    "__v": 0
  }
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

create an onboarding invite first and get the inviteId

inviteId

string

required

The inviteId of the onboarding invite.

Example:

""

Response

Onboarding invite successfully sent.

success

boolean

Whether the request was processed successfully. Declines return HTTP 200 with success: false.

Example:

true

code

string

Machine-readable result code. See the Error Codes reference.

Example:

"0"

message

string

Human-readable result message.

Example:

"Invite has been sent"

data

object

The response payload.

Hide child attributes

data.notifications

object

Delivery status of invite notifications.

Hide child attributes

data.notifications.email

object

Email notification status.

Hide child attributes

data.notifications.email.enabled

boolean

Whether this setting is enabled.

Example:

true

data.notifications.email.sent

boolean

Whether the notification was sent.

Example:

true

data.notifications.email.sentAt

string<date-time>

Timestamp when it was sent (ISO 8601).

Example:

"2025-02-07T13:24:53.838Z"

data.notifications.sms

object

SMS notification status.

Hide child attributes

data.notifications.sms.enabled

boolean

Whether this setting is enabled.

Example:

false

data.notifications.sms.sent

boolean

Whether the notification was sent.

Example:

false

data.identity

object

Identity details for the business and its owners.

Hide child attributes

data.identity.owners

object[]

Business owners. Required for individual and business entity types.

Hide child attributes

data.identity.owners.title

string

Salutation of the owner (Mr., Ms., Mrs.).

Example:

"Mr."

data.identity.owners.firstName

string

First name.

Example:

"jonny"

data.identity.owners.middleName

string

Middle name.

Example:

"eric"

data.identity.owners.lastName

string

Last name.

Example:

"dooei"

data.identity.owners.birthDate

string<date>

Date of birth (YYYY-MM-DD).

Example:

"2000-08-01"

data.identity.owners.phoneNumber

string

Phone number of the owner.

Example:

"2232322323"

data.identity.owners.streetNum

string

Street number.

Example:

"79"

data.identity.owners.streetName

string

Street name.

Example:

"clarks"

data.identity.owners.city

string

City name.

Example:

"ny"

data.identity.owners.state

string

Two-letter US state code.

Example:

"NY"

data.identity.owners.postalCode

string

ZIP or postal code.

Example:

"23434"

data.identity.owners.ssnLast4

string

Last 4 digits of the owner's SSN.

Example:

"123123123"

data.identity.owners.ownershipPercentage

integer

Percentage of the business this owner holds (0-100).

Example:

100

data.identity.owners.email

string

Email address of the owner.

Example:

"mail_m@asd.com"

data.identity.business

object

Business identity details.

data.identity.contact

object

Primary contact for the business.

Hide child attributes

data.identity.contact.firstName

string

First name.

Example:

"John"

data.identity.contact.middleName

string

Middle name.

Example:

"Michael"

data.identity.contact.lastName

string

Last name.

Example:

"Doe"

data.identity.contact.birthDate

string<date>

Format: YYYY-MM-DD

Example:

"1990-01-15"

data.identity.contact.position

string

Role of the owner in the business.

Example:

"CEO"

data.identity.contact.ssn

string

Social Security Number

Example:

"123-45-6789"

data.identity.contact.phoneNumber

string

Phone number.

Example:

"5551234567"

data.identity.contact.email

string<email>

Email address.

Example:

"john.doe@example.com"

data.fees

object

Fee configuration. Overrides values from the fees template.

Hide child attributes

data.fees.platform

object

Fee configuration at the platform level.

Hide child attributes

data.fees.platform.interchange

object

Interchange pass-through fee settings.

Hide child attributes

data.fees.platform.interchange.enabled

boolean

Whether this setting is enabled.

Example:

false

data.fees.platform.interchange.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perTransaction

object

Event-based fees, one entry per transaction event type.

Hide child attributes

data.fees.platform.perTransaction.ccCnpSale

object

Fee applied to each card-not-present sale.

Hide child attributes

data.fees.platform.perTransaction.ccCnpSale.discountRate

number

Percentage fee charged on the event amount.

Example:

2.9

data.fees.platform.perTransaction.ccCnpSale.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.3

data.fees.platform.perTransaction.ccCnpSale.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perTransaction.ccCnpCapture

object

Fee applied to each card-not-present capture.

Hide child attributes

data.fees.platform.perTransaction.ccCnpCapture.discountRate

number

Percentage fee charged on the event amount.

Example:

2.9

data.fees.platform.perTransaction.ccCnpCapture.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.3

data.fees.platform.perTransaction.ccCnpCapture.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perTransaction.ccCnpAuth

object

Fee applied to each card-not-present authorization.

Hide child attributes

data.fees.platform.perTransaction.ccCnpAuth.discountRate

number

Percentage fee charged on the event amount.

Example:

0

data.fees.platform.perTransaction.ccCnpAuth.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

data.fees.platform.perTransaction.ccCnpAuth.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perTransaction.ccCnpVoid

object

Fee applied to each card-not-present void.

Hide child attributes

data.fees.platform.perTransaction.ccCnpVoid.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

data.fees.platform.perTransaction.ccCnpVoid.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.platform.perTransaction.ccCnpVoid.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.platform.perTransaction.ccCnpVoid.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perTransaction.ccCnpRefund

object

Fee applied to each card-not-present refund.

Hide child attributes

data.fees.platform.perTransaction.ccCnpRefund.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

data.fees.platform.perTransaction.ccCnpRefund.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

data.fees.platform.perTransaction.ccCnpRefund.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.platform.perTransaction.ccCnpRefund.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perTransaction.ccCnpCredit

object

Fee applied to each card-not-present credit.

Hide child attributes

data.fees.platform.perTransaction.ccCnpCredit.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

data.fees.platform.perTransaction.ccCnpCredit.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

data.fees.platform.perTransaction.ccCnpCredit.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.platform.perTransaction.ccCnpCredit.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perTransaction.ccCnpReversal

object

Fee applied to each card-not-present reversal.

Hide child attributes

data.fees.platform.perTransaction.ccCnpReversal.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

data.fees.platform.perTransaction.ccCnpReversal.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

data.fees.platform.perTransaction.ccCnpReversal.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.platform.perTransaction.ccCnpReversal.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perTransaction.ccCnpChargeback

object

Fee applied to each chargeback.

Hide child attributes

data.fees.platform.perTransaction.ccCnpChargeback.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

25

data.fees.platform.perTransaction.ccCnpChargeback.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perTransaction.ccCnpAvsOnly

object

Fee applied to each AVS-only verification.

Hide child attributes

data.fees.platform.perTransaction.ccCnpAvsOnly.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

data.fees.platform.perTransaction.ccCnpAvsOnly.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perTransaction.ccCnpDeclined

object

Fee applied to each declined card-not-present attempt.

Hide child attributes

data.fees.platform.perTransaction.ccCnpDeclined.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.5

data.fees.platform.perTransaction.ccCnpDeclined.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perTransaction.checkSale

object

Fee applied to each eCheck sale.

Hide child attributes

data.fees.platform.perTransaction.checkSale.discountRate

number

Percentage fee charged on the event amount.

Example:

2.9

data.fees.platform.perTransaction.checkSale.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.3

data.fees.platform.perTransaction.checkSale.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perTransaction.checkVerification

object

Fee applied to each eCheck verification.

Hide child attributes

data.fees.platform.perTransaction.checkVerification.discountRate

number

Percentage fee charged on the event amount.

Example:

0

data.fees.platform.perTransaction.checkVerification.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

data.fees.platform.perTransaction.checkVerification.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perTransaction.checkVoid

object

Fee applied to each eCheck void.

Hide child attributes

data.fees.platform.perTransaction.checkVoid.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

data.fees.platform.perTransaction.checkVoid.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.platform.perTransaction.checkVoid.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.platform.perTransaction.checkVoid.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perTransaction.checkRefund

object

Fee applied to each eCheck refund.

Hide child attributes

data.fees.platform.perTransaction.checkRefund.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

data.fees.platform.perTransaction.checkRefund.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

data.fees.platform.perTransaction.checkRefund.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.platform.perTransaction.checkRefund.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perTransaction.checkCredit

object

Fee applied to each eCheck credit.

Hide child attributes

data.fees.platform.perTransaction.checkCredit.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

data.fees.platform.perTransaction.checkCredit.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

data.fees.platform.perTransaction.checkCredit.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.platform.perTransaction.checkCredit.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perTransaction.checkReversal

object

Fee applied to each eCheck reversal.

Hide child attributes

data.fees.platform.perTransaction.checkReversal.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

data.fees.platform.perTransaction.checkReversal.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

data.fees.platform.perTransaction.checkReversal.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.platform.perTransaction.checkReversal.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

data.fees.platform.perPeriod

array

Recurring fees charged on a fixed schedule, such as monthly service fees.

data.fees.platform.items

any

Fee entries.

data.fees.spProduct

object

Fee configuration at the Service Provider product level.

Hide child attributes

data.fees.spProduct.perTransaction

object

Event-based fees, one entry per transaction event type.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpSale

object

Fee applied to each card-not-present sale.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpSale.discountRate

number

Percentage fee charged on the event amount.

Example:

2.9

data.fees.spProduct.perTransaction.ccCnpSale.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.3

data.fees.spProduct.perTransaction.ccCnpCapture

object

Fee applied to each card-not-present capture.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpCapture.discountRate

number

Percentage fee charged on the event amount.

Example:

2.9

data.fees.spProduct.perTransaction.ccCnpCapture.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.3

data.fees.spProduct.perTransaction.ccCnpAuth

object

Fee applied to each card-not-present authorization.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpAuth.discountRate

number

Percentage fee charged on the event amount.

Example:

0

data.fees.spProduct.perTransaction.ccCnpAuth.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

data.fees.spProduct.perTransaction.ccCnpVoid

object

Fee applied to each card-not-present void.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpVoid.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

data.fees.spProduct.perTransaction.ccCnpVoid.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.spProduct.perTransaction.ccCnpVoid.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.spProduct.perTransaction.ccCnpRefund

object

Fee applied to each card-not-present refund.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpRefund.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

data.fees.spProduct.perTransaction.ccCnpRefund.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

data.fees.spProduct.perTransaction.ccCnpRefund.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.spProduct.perTransaction.ccCnpCredit

object

Fee applied to each card-not-present credit.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpCredit.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

data.fees.spProduct.perTransaction.ccCnpCredit.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

data.fees.spProduct.perTransaction.ccCnpCredit.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.spProduct.perTransaction.ccCnpReversal

object

Fee applied to each card-not-present reversal.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpReversal.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

data.fees.spProduct.perTransaction.ccCnpReversal.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

data.fees.spProduct.perTransaction.ccCnpReversal.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.spProduct.perTransaction.ccCnpChargeback

object

Fee applied to each chargeback.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpChargeback.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

25

data.fees.spProduct.perTransaction.ccCnpAvsOnly

object

Fee applied to each AVS-only verification.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpAvsOnly.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

data.fees.spProduct.perTransaction.ccCnpDeclined

object

Fee applied to each declined card-not-present attempt.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpDeclined.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.5

data.fees.spProduct.perTransaction.checkSale

object

Fee applied to each eCheck sale.

Hide child attributes

data.fees.spProduct.perTransaction.checkSale.discountRate

number

Percentage fee charged on the event amount.

Example:

2.9

data.fees.spProduct.perTransaction.checkSale.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.3

data.fees.spProduct.perTransaction.checkVerification

object

Fee applied to each eCheck verification.

Hide child attributes

data.fees.spProduct.perTransaction.checkVerification.discountRate

number

Percentage fee charged on the event amount.

Example:

0

data.fees.spProduct.perTransaction.checkVerification.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

data.fees.spProduct.perTransaction.checkVoid

object

Fee applied to each eCheck void.

Hide child attributes

data.fees.spProduct.perTransaction.checkVoid.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

data.fees.spProduct.perTransaction.checkVoid.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.spProduct.perTransaction.checkVoid.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.spProduct.perTransaction.checkRefund

object

Fee applied to each eCheck refund.

Hide child attributes

data.fees.spProduct.perTransaction.checkRefund.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

data.fees.spProduct.perTransaction.checkRefund.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

data.fees.spProduct.perTransaction.checkRefund.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.spProduct.perTransaction.checkCredit

object

Fee applied to each eCheck credit.

Hide child attributes

data.fees.spProduct.perTransaction.checkCredit.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

data.fees.spProduct.perTransaction.checkCredit.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

data.fees.spProduct.perTransaction.checkCredit.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.spProduct.perTransaction.checkReversal

object

Fee applied to each eCheck reversal.

Hide child attributes

data.fees.spProduct.perTransaction.checkReversal.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

data.fees.spProduct.perTransaction.checkReversal.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

data.fees.spProduct.perTransaction.checkReversal.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

data.fees.spProduct.perPeriod

any[]

Recurring fees charged on a fixed schedule, such as monthly service fees.

data._id

string

Internal document identifier.

Example:

"67a6098d7151ee56479d1bde"

data.facId

string

Facilitator identifier assigned by Jupico.

Example:

"JPT"

data.spProductId

string

Identifier of the Service Provider product the merchant belongs to.

Example:

"255"

data.inviteId

string

Unique identifier of the onboarding invite.

Example:

"25754e1d-62b4-479e-a4b9-acd9f57557ea"

data.name

string

Display name.

Example:

"Tech"

data.email

string

Email address.

Example:

"test@gmail.com"

data.phoneNumber

string

Phone number.

Example:

"2995318324"

data.reference

string

Your own reference for this invite.

Example:

"1234"

data.url

string<uri>

URL of the hosted page for this object.

Example:

"https://sandbox-payments-onboarding.jupico.com/jpt-sim-demo/get-started?invite=25754e1d-62b4-479e-a4b9-acd9f57557ea"

data.status

string

Current status.

Example:

"sent"

data.isDeleted

boolean

Whether the record is soft-deleted.

Example:

false

data.feesTemplateId

string

UUID of a fees template with predefined pricing. If omitted, the default template is used.

Example:

"415dd627-006f-4477-a2eb-47c6eb7a4534"

data.onboardingFlowTemplateId

string

UUID of the onboarding flow template that controls which steps the merchant sees.

Example:

"7f10de6b-971c-4ad9-9f09-cdf03c5b303e"

data.expiresAt

string<date-time>

Timestamp when this object expires (ISO 8601).

Example:

"2025-03-07T13:24:53.838Z"

data.payoutBankAccounts

any[]

Bank accounts where the merchant receives payouts.

data.createdAt

string<date-time>

Timestamp when the object was created (ISO 8601).

Example:

"2025-02-07T13:24:29.237Z"

data.updatedAt

string<date-time>

Timestamp when the object was last updated (ISO 8601).

Example:

"2025-02-07T13:24:53.840Z"

data.__v

integer

Internal document version. Ignore.

Example:

0

API Overview

API Reference

Resources

Send an invite

Authorizations

Body

Response