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
}
}Onboarding Invites
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.
POST
https://sandbox-platform.jupico.com
/
v1
/
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
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
The inviteId of the onboarding invite.
Example:
""
Response
Onboarding invite successfully sent.
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:
"Invite has been sent"
The response payload.
Show child attributes
Show child attributes
Last modified on July 14, 2026
Was this page helpful?
⌘I

