Create and send an invite
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/onboardinginvites/createandsend \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Tech",
"email": "test@gmail.com"
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/onboardinginvites/createandsend"
payload = {
"name": "Tech",
"email": "test@gmail.com"
}
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({name: 'Tech', email: 'test@gmail.com'})
};
fetch('https://sandbox-platform.jupico.com/v1/onboardinginvites/createandsend', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/onboardinginvites/createandsend';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Tech', email: 'test@gmail.com'})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"code": "0",
"message": "Invites Tech successfully created and sent",
"data": {
"notifications": {
"email": {
"enabled": true,
"sent": true,
"sentAt": "2025-02-06T18:59:39.643Z"
},
"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": true,
"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": [
"<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": "67a5069a7151ee56479a9366",
"facId": "JPT",
"spProductId": "255",
"inviteId": "1dfaab8f-2927-4c58-8ba3-91aec2ec5a56",
"name": "Tech",
"email": "test@gmail.com",
"phoneNumber": "2995318324",
"reference": "1234",
"url": "https://sandbox-payments-onboarding.jupico.com/jpt-sim-demo/get-started?invite=1dfaab8f-2927-4c58-8ba3-91aec2ec5a56",
"status": "sent",
"isDeleted": false,
"feesTemplateId": "415dd627-006f-4477-a2eb-47c6eb7a4534",
"onboardingFlowTemplateId": "7f10de6b-971c-4ad9-9f09-cdf03c5b303e",
"expiresAt": "2025-03-06T18:59:39.643Z",
"payoutBankAccounts": [
"<unknown>"
],
"createdAt": "2025-02-06T18:59:38.944Z",
"updatedAt": "2025-02-06T18:59:39.649Z",
"__v": 0
}
}Onboarding Invites
Create and send an invite
Creates an onboarding invite and immediately emails it to the merchant. Equivalent to Create an invite followed by Send an invite in a single call.
POST
https://sandbox-platform.jupico.com
/
v1
/
onboardinginvites
/
createandsend
Create and send an invite
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/onboardinginvites/createandsend \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Tech",
"email": "test@gmail.com"
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/onboardinginvites/createandsend"
payload = {
"name": "Tech",
"email": "test@gmail.com"
}
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({name: 'Tech', email: 'test@gmail.com'})
};
fetch('https://sandbox-platform.jupico.com/v1/onboardinginvites/createandsend', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/onboardinginvites/createandsend';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Tech', email: 'test@gmail.com'})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"code": "0",
"message": "Invites Tech successfully created and sent",
"data": {
"notifications": {
"email": {
"enabled": true,
"sent": true,
"sentAt": "2025-02-06T18:59:39.643Z"
},
"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": true,
"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": [
"<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": "67a5069a7151ee56479a9366",
"facId": "JPT",
"spProductId": "255",
"inviteId": "1dfaab8f-2927-4c58-8ba3-91aec2ec5a56",
"name": "Tech",
"email": "test@gmail.com",
"phoneNumber": "2995318324",
"reference": "1234",
"url": "https://sandbox-payments-onboarding.jupico.com/jpt-sim-demo/get-started?invite=1dfaab8f-2927-4c58-8ba3-91aec2ec5a56",
"status": "sent",
"isDeleted": false,
"feesTemplateId": "415dd627-006f-4477-a2eb-47c6eb7a4534",
"onboardingFlowTemplateId": "7f10de6b-971c-4ad9-9f09-cdf03c5b303e",
"expiresAt": "2025-03-06T18:59:39.643Z",
"payoutBankAccounts": [
"<unknown>"
],
"createdAt": "2025-02-06T18:59:38.944Z",
"updatedAt": "2025-02-06T18:59:39.649Z",
"__v": 0
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
The name of the person being invited.
Example:
"John Doe"
The email of the person being invited.
Example:
"example@example.com"
The phone number of the person being invited.
Example:
"2232322323"
The invite reference.
Example:
"Reference 123"
The identity object containing data about the business and its representatives
Show child attributes
Show child attributes
Bank accounts where the merchant receives payouts.
Show child attributes
Show child attributes
UUID of the fees template with predefined fees. If no value is passed, the id of the default template will be used.
Example:
""
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.
Show child attributes
Show child attributes
UUID of the onboarding flow template to be used for the onboarding experience.
Example:
""
Response
Successfully fetched onboarding invites.
Whether the request was processed successfully. Declines return HTTP 200 with success: false.
Example:
true
Machine-readable result code. See the Error Codes reference.
Example:
"0"
Human-readable result message.
Example:
"Invites Tech successfully created and sent"
The response payload.
Show child attributes
Show child attributes
Last modified on July 14, 2026
Was this page helpful?
⌘I