Create an additional-MID invite
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/onboardinginvites/addsubmerchant \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/onboardinginvites/addsubmerchant"
payload = {}
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({})
};
fetch('https://sandbox-platform.jupico.com/v1/onboardinginvites/addsubmerchant', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/onboardinginvites/addsubmerchant';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"code": "<string>",
"message": "<string>",
"data": {
"facId": "<string>",
"spProductId": "<string>",
"inviteId": "<string>",
"name": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"reference": "<string>",
"url": "<string>",
"notifications": {
"email": {
"enabled": true,
"sent": true
},
"sms": {
"enabled": true,
"sent": true
}
},
"status": "<string>",
"isDeleted": true,
"identity": {
"owners": [
{
"title": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"birthDate": "2023-12-25",
"phoneNumber": "<string>",
"streetNum": "<string>",
"streetName": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"ssnLast4": "<string>",
"ownershipPercentage": 123,
"email": "<string>"
}
],
"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"
}
},
"feesTemplateId": "<string>",
"fees": {
"platform": {
"interchange": {
"enabled": true,
"billTo": "<string>"
},
"perTransaction": {
"ccCnpSale": {
"discountRate": 123,
"fixed": 123,
"billTo": "<string>"
},
"ccCnpCapture": {
"discountRate": 123,
"fixed": 123,
"billTo": "<string>"
},
"ccCnpAuth": {
"discountRate": 123,
"fixed": 123,
"billTo": "<string>"
},
"ccCnpVoid": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true,
"billTo": "<string>"
},
"ccCnpRefund": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true,
"billTo": "<string>"
},
"ccCnpCredit": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true,
"billTo": "<string>"
},
"ccCnpReversal": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true,
"billTo": "<string>"
},
"ccCnpChargeback": {
"fixed": 123,
"billTo": "<string>"
},
"ccCnpAvsOnly": {
"fixed": 123,
"billTo": "<string>"
},
"ccCnpDeclined": {
"fixed": 123,
"billTo": "<string>"
},
"checkSale": {
"discountRate": 123,
"fixed": 123,
"billTo": "<string>"
},
"checkVerification": {
"discountRate": 123,
"fixed": 123,
"billTo": "<string>"
},
"checkVoid": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true,
"billTo": "<string>"
},
"checkRefund": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true,
"billTo": "<string>"
},
"checkCredit": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true,
"billTo": "<string>"
},
"checkReversal": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true,
"billTo": "<string>"
}
},
"perPeriod": [
"<unknown>"
]
},
"spProduct": {
"perTransaction": {
"ccCnpSale": {
"discountRate": 123,
"fixed": 123
},
"ccCnpCapture": {
"discountRate": 123,
"fixed": 123
},
"ccCnpAuth": {
"discountRate": 123,
"fixed": 123
},
"ccCnpVoid": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true
},
"ccCnpRefund": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true
},
"ccCnpCredit": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true
},
"ccCnpReversal": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true
},
"ccCnpChargeback": {
"fixed": 123
},
"ccCnpAvsOnly": {
"fixed": 123
},
"ccCnpDeclined": {
"fixed": 123
},
"checkSale": {
"discountRate": 123,
"fixed": 123
},
"checkVerification": {
"discountRate": 123,
"fixed": 123
},
"checkVoid": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true
},
"checkRefund": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true
},
"checkCredit": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true
},
"checkReversal": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true
}
},
"perPeriod": [
"<unknown>"
]
}
},
"onboardingFlowTemplateId": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"payoutBankAccounts": [
"<unknown>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Onboarding Invites
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.
POST
https://sandbox-platform.jupico.com
/
v1
/
onboardinginvites
/
addsubmerchant
Create an additional-MID invite
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/onboardinginvites/addsubmerchant \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/onboardinginvites/addsubmerchant"
payload = {}
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({})
};
fetch('https://sandbox-platform.jupico.com/v1/onboardinginvites/addsubmerchant', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/onboardinginvites/addsubmerchant';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"code": "<string>",
"message": "<string>",
"data": {
"facId": "<string>",
"spProductId": "<string>",
"inviteId": "<string>",
"name": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"reference": "<string>",
"url": "<string>",
"notifications": {
"email": {
"enabled": true,
"sent": true
},
"sms": {
"enabled": true,
"sent": true
}
},
"status": "<string>",
"isDeleted": true,
"identity": {
"owners": [
{
"title": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"birthDate": "2023-12-25",
"phoneNumber": "<string>",
"streetNum": "<string>",
"streetName": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"ssnLast4": "<string>",
"ownershipPercentage": 123,
"email": "<string>"
}
],
"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"
}
},
"feesTemplateId": "<string>",
"fees": {
"platform": {
"interchange": {
"enabled": true,
"billTo": "<string>"
},
"perTransaction": {
"ccCnpSale": {
"discountRate": 123,
"fixed": 123,
"billTo": "<string>"
},
"ccCnpCapture": {
"discountRate": 123,
"fixed": 123,
"billTo": "<string>"
},
"ccCnpAuth": {
"discountRate": 123,
"fixed": 123,
"billTo": "<string>"
},
"ccCnpVoid": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true,
"billTo": "<string>"
},
"ccCnpRefund": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true,
"billTo": "<string>"
},
"ccCnpCredit": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true,
"billTo": "<string>"
},
"ccCnpReversal": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true,
"billTo": "<string>"
},
"ccCnpChargeback": {
"fixed": 123,
"billTo": "<string>"
},
"ccCnpAvsOnly": {
"fixed": 123,
"billTo": "<string>"
},
"ccCnpDeclined": {
"fixed": 123,
"billTo": "<string>"
},
"checkSale": {
"discountRate": 123,
"fixed": 123,
"billTo": "<string>"
},
"checkVerification": {
"discountRate": 123,
"fixed": 123,
"billTo": "<string>"
},
"checkVoid": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true,
"billTo": "<string>"
},
"checkRefund": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true,
"billTo": "<string>"
},
"checkCredit": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true,
"billTo": "<string>"
},
"checkReversal": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true,
"billTo": "<string>"
}
},
"perPeriod": [
"<unknown>"
]
},
"spProduct": {
"perTransaction": {
"ccCnpSale": {
"discountRate": 123,
"fixed": 123
},
"ccCnpCapture": {
"discountRate": 123,
"fixed": 123
},
"ccCnpAuth": {
"discountRate": 123,
"fixed": 123
},
"ccCnpVoid": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true
},
"ccCnpRefund": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true
},
"ccCnpCredit": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true
},
"ccCnpReversal": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true
},
"ccCnpChargeback": {
"fixed": 123
},
"ccCnpAvsOnly": {
"fixed": 123
},
"ccCnpDeclined": {
"fixed": 123
},
"checkSale": {
"discountRate": 123,
"fixed": 123
},
"checkVerification": {
"discountRate": 123,
"fixed": 123
},
"checkVoid": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true
},
"checkRefund": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true
},
"checkCredit": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true
},
"checkReversal": {
"fixed": 123,
"reverseFixed": true,
"reverseDiscountRate": true
}
},
"perPeriod": [
"<unknown>"
]
}
},
"onboardingFlowTemplateId": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"payoutBankAccounts": [
"<unknown>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
The Service provider product reference.
Maximum string length:
100Example:
"255"
The invite reference.
Maximum string length:
100Example:
"Reference 123"
The aplicant reference
Example:
"682e0ef81da12ab7229dbf64"
Application reference to filter in the invite
Example:
"682e176bbee4495f337a0464"
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
Onboarding invite successfully created.
Last modified on July 14, 2026
Was this page helpful?
⌘I