curl --request POST \
--url https://sandbox-platform.jupico.com/v1/onboardinginvites/update \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"inviteId": "",
"name": "Updated",
"reference": "12322",
"identity": {
"business": {
"legalName": "UpdatedtestInvite",
"dbaName": "UpdatedtestDBAInvite",
"federalTaxId": "999999992",
"tinType": "SSN",
"phoneNumber": "2232322322",
"address": {
"streetNum": "1232",
"streetName": "Updated main street",
"city": "Updated ny",
"state": "AZ",
"postalCode": "22229"
},
"websiteUrl": "https://www.Updatedsarasa.com",
"ownershipType": "LLC",
"businessEstablishedDate": "2023-11-22",
"expectedMonthlyVolume": 2002
},
"owners": [
{
"title": "Ms.",
"firstName": "Updated jonny",
"middleName": "eric Updated",
"lastName": "dooeiUpdated",
"birthDate": "2000-08-22",
"phoneNumber": "2232322322",
"streetNum": "792",
"streetName": "Updated clarks",
"city": "Updatedny",
"state": "AZ",
"postalCode": "23432",
"ssn": "123123122",
"ownershipPercentage": 92,
"email": "mail_m@Updatedasd.com",
"position": "OW"
}
]
},
"payoutBankAccounts": [
{
"accountRouting": "123123122",
"accountNumber": "8789545642",
"accountType": "checking",
"nameOnAccount": "Updatedjonnydooeiacc"
}
]
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/onboardinginvites/update"
payload = {
"inviteId": "",
"name": "Updated",
"reference": "12322",
"identity": {
"business": {
"legalName": "UpdatedtestInvite",
"dbaName": "UpdatedtestDBAInvite",
"federalTaxId": "999999992",
"tinType": "SSN",
"phoneNumber": "2232322322",
"address": {
"streetNum": "1232",
"streetName": "Updated main street",
"city": "Updated ny",
"state": "AZ",
"postalCode": "22229"
},
"websiteUrl": "https://www.Updatedsarasa.com",
"ownershipType": "LLC",
"businessEstablishedDate": "2023-11-22",
"expectedMonthlyVolume": 2002
},
"owners": [
{
"title": "Ms.",
"firstName": "Updated jonny",
"middleName": "eric Updated",
"lastName": "dooeiUpdated",
"birthDate": "2000-08-22",
"phoneNumber": "2232322322",
"streetNum": "792",
"streetName": "Updated clarks",
"city": "Updatedny",
"state": "AZ",
"postalCode": "23432",
"ssn": "123123122",
"ownershipPercentage": 92,
"email": "mail_m@Updatedasd.com",
"position": "OW"
}
]
},
"payoutBankAccounts": [
{
"accountRouting": "123123122",
"accountNumber": "8789545642",
"accountType": "checking",
"nameOnAccount": "Updatedjonnydooeiacc"
}
]
}
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: '',
name: 'Updated',
reference: '12322',
identity: {
business: {
legalName: 'UpdatedtestInvite',
dbaName: 'UpdatedtestDBAInvite',
federalTaxId: '999999992',
tinType: 'SSN',
phoneNumber: '2232322322',
address: {
streetNum: '1232',
streetName: 'Updated main street',
city: 'Updated ny',
state: 'AZ',
postalCode: '22229'
},
websiteUrl: 'https://www.Updatedsarasa.com',
ownershipType: 'LLC',
businessEstablishedDate: '2023-11-22',
expectedMonthlyVolume: 2002
},
owners: [
{
title: 'Ms.',
firstName: 'Updated jonny',
middleName: 'eric Updated',
lastName: 'dooeiUpdated',
birthDate: '2000-08-22',
phoneNumber: '2232322322',
streetNum: '792',
streetName: 'Updated clarks',
city: 'Updatedny',
state: 'AZ',
postalCode: '23432',
ssn: '123123122',
ownershipPercentage: 92,
email: 'mail_m@Updatedasd.com',
position: 'OW'
}
]
},
payoutBankAccounts: [
{
accountRouting: '123123122',
accountNumber: '8789545642',
accountType: 'checking',
nameOnAccount: 'Updatedjonnydooeiacc'
}
]
})
};
fetch('https://sandbox-platform.jupico.com/v1/onboardinginvites/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/onboardinginvites/update';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
inviteId: '',
name: 'Updated',
reference: '12322',
identity: {
business: {
legalName: 'UpdatedtestInvite',
dbaName: 'UpdatedtestDBAInvite',
federalTaxId: '999999992',
tinType: 'SSN',
phoneNumber: '2232322322',
address: {
streetNum: '1232',
streetName: 'Updated main street',
city: 'Updated ny',
state: 'AZ',
postalCode: '22229'
},
websiteUrl: 'https://www.Updatedsarasa.com',
ownershipType: 'LLC',
businessEstablishedDate: '2023-11-22',
expectedMonthlyVolume: 2002
},
owners: [
{
title: 'Ms.',
firstName: 'Updated jonny',
middleName: 'eric Updated',
lastName: 'dooeiUpdated',
birthDate: '2000-08-22',
phoneNumber: '2232322322',
streetNum: '792',
streetName: 'Updated clarks',
city: 'Updatedny',
state: 'AZ',
postalCode: '23432',
ssn: '123123122',
ownershipPercentage: 92,
email: 'mail_m@Updatedasd.com',
position: 'OW'
}
]
},
payoutBankAccounts: [
{
accountRouting: '123123122',
accountNumber: '8789545642',
accountType: 'checking',
nameOnAccount: 'Updatedjonnydooeiacc'
}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"code": "<string>",
"message": "<string>",
"data": {
"notifications": {
"email": {
"enabled": true,
"sent": true
},
"sms": {
"enabled": true,
"sent": 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>",
"position": "<string>"
}
],
"business": {
"address": {
"streetNum": "<string>",
"streetName": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"legalName": "<string>",
"dbaName": "<string>",
"federalTaxId": "<string>",
"tinType": "<string>",
"phoneNumber": "<string>",
"websiteUrl": "<string>",
"ownershipType": "<string>",
"businessEstablishedDate": "2023-12-25",
"expectedMonthlyVolume": 123
},
"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": 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>"
}
}
},
"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
}
}
}
},
"facId": "<string>",
"spProductId": "<string>",
"inviteId": "<string>",
"name": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"reference": "<string>",
"url": "<string>",
"status": "<string>",
"isDeleted": true,
"feesTemplateId": "<string>",
"onboardingFlowTemplateId": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"payoutBankAccounts": [
{
"accountRouting": "<string>",
"accountNumber": "<string>",
"accountType": "<string>",
"nameOnAccount": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Update an invite
Updates the details of an existing invite, such as the invitee’s contact information or reference.
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/onboardinginvites/update \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"inviteId": "",
"name": "Updated",
"reference": "12322",
"identity": {
"business": {
"legalName": "UpdatedtestInvite",
"dbaName": "UpdatedtestDBAInvite",
"federalTaxId": "999999992",
"tinType": "SSN",
"phoneNumber": "2232322322",
"address": {
"streetNum": "1232",
"streetName": "Updated main street",
"city": "Updated ny",
"state": "AZ",
"postalCode": "22229"
},
"websiteUrl": "https://www.Updatedsarasa.com",
"ownershipType": "LLC",
"businessEstablishedDate": "2023-11-22",
"expectedMonthlyVolume": 2002
},
"owners": [
{
"title": "Ms.",
"firstName": "Updated jonny",
"middleName": "eric Updated",
"lastName": "dooeiUpdated",
"birthDate": "2000-08-22",
"phoneNumber": "2232322322",
"streetNum": "792",
"streetName": "Updated clarks",
"city": "Updatedny",
"state": "AZ",
"postalCode": "23432",
"ssn": "123123122",
"ownershipPercentage": 92,
"email": "mail_m@Updatedasd.com",
"position": "OW"
}
]
},
"payoutBankAccounts": [
{
"accountRouting": "123123122",
"accountNumber": "8789545642",
"accountType": "checking",
"nameOnAccount": "Updatedjonnydooeiacc"
}
]
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/onboardinginvites/update"
payload = {
"inviteId": "",
"name": "Updated",
"reference": "12322",
"identity": {
"business": {
"legalName": "UpdatedtestInvite",
"dbaName": "UpdatedtestDBAInvite",
"federalTaxId": "999999992",
"tinType": "SSN",
"phoneNumber": "2232322322",
"address": {
"streetNum": "1232",
"streetName": "Updated main street",
"city": "Updated ny",
"state": "AZ",
"postalCode": "22229"
},
"websiteUrl": "https://www.Updatedsarasa.com",
"ownershipType": "LLC",
"businessEstablishedDate": "2023-11-22",
"expectedMonthlyVolume": 2002
},
"owners": [
{
"title": "Ms.",
"firstName": "Updated jonny",
"middleName": "eric Updated",
"lastName": "dooeiUpdated",
"birthDate": "2000-08-22",
"phoneNumber": "2232322322",
"streetNum": "792",
"streetName": "Updated clarks",
"city": "Updatedny",
"state": "AZ",
"postalCode": "23432",
"ssn": "123123122",
"ownershipPercentage": 92,
"email": "mail_m@Updatedasd.com",
"position": "OW"
}
]
},
"payoutBankAccounts": [
{
"accountRouting": "123123122",
"accountNumber": "8789545642",
"accountType": "checking",
"nameOnAccount": "Updatedjonnydooeiacc"
}
]
}
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: '',
name: 'Updated',
reference: '12322',
identity: {
business: {
legalName: 'UpdatedtestInvite',
dbaName: 'UpdatedtestDBAInvite',
federalTaxId: '999999992',
tinType: 'SSN',
phoneNumber: '2232322322',
address: {
streetNum: '1232',
streetName: 'Updated main street',
city: 'Updated ny',
state: 'AZ',
postalCode: '22229'
},
websiteUrl: 'https://www.Updatedsarasa.com',
ownershipType: 'LLC',
businessEstablishedDate: '2023-11-22',
expectedMonthlyVolume: 2002
},
owners: [
{
title: 'Ms.',
firstName: 'Updated jonny',
middleName: 'eric Updated',
lastName: 'dooeiUpdated',
birthDate: '2000-08-22',
phoneNumber: '2232322322',
streetNum: '792',
streetName: 'Updated clarks',
city: 'Updatedny',
state: 'AZ',
postalCode: '23432',
ssn: '123123122',
ownershipPercentage: 92,
email: 'mail_m@Updatedasd.com',
position: 'OW'
}
]
},
payoutBankAccounts: [
{
accountRouting: '123123122',
accountNumber: '8789545642',
accountType: 'checking',
nameOnAccount: 'Updatedjonnydooeiacc'
}
]
})
};
fetch('https://sandbox-platform.jupico.com/v1/onboardinginvites/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/onboardinginvites/update';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
inviteId: '',
name: 'Updated',
reference: '12322',
identity: {
business: {
legalName: 'UpdatedtestInvite',
dbaName: 'UpdatedtestDBAInvite',
federalTaxId: '999999992',
tinType: 'SSN',
phoneNumber: '2232322322',
address: {
streetNum: '1232',
streetName: 'Updated main street',
city: 'Updated ny',
state: 'AZ',
postalCode: '22229'
},
websiteUrl: 'https://www.Updatedsarasa.com',
ownershipType: 'LLC',
businessEstablishedDate: '2023-11-22',
expectedMonthlyVolume: 2002
},
owners: [
{
title: 'Ms.',
firstName: 'Updated jonny',
middleName: 'eric Updated',
lastName: 'dooeiUpdated',
birthDate: '2000-08-22',
phoneNumber: '2232322322',
streetNum: '792',
streetName: 'Updated clarks',
city: 'Updatedny',
state: 'AZ',
postalCode: '23432',
ssn: '123123122',
ownershipPercentage: 92,
email: 'mail_m@Updatedasd.com',
position: 'OW'
}
]
},
payoutBankAccounts: [
{
accountRouting: '123123122',
accountNumber: '8789545642',
accountType: 'checking',
nameOnAccount: 'Updatedjonnydooeiacc'
}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"code": "<string>",
"message": "<string>",
"data": {
"notifications": {
"email": {
"enabled": true,
"sent": true
},
"sms": {
"enabled": true,
"sent": 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>",
"position": "<string>"
}
],
"business": {
"address": {
"streetNum": "<string>",
"streetName": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"legalName": "<string>",
"dbaName": "<string>",
"federalTaxId": "<string>",
"tinType": "<string>",
"phoneNumber": "<string>",
"websiteUrl": "<string>",
"ownershipType": "<string>",
"businessEstablishedDate": "2023-12-25",
"expectedMonthlyVolume": 123
},
"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": 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>"
}
}
},
"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
}
}
}
},
"facId": "<string>",
"spProductId": "<string>",
"inviteId": "<string>",
"name": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"reference": "<string>",
"url": "<string>",
"status": "<string>",
"isDeleted": true,
"feesTemplateId": "<string>",
"onboardingFlowTemplateId": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"payoutBankAccounts": [
{
"accountRouting": "<string>",
"accountNumber": "<string>",
"accountType": "<string>",
"nameOnAccount": "<string>"
}
],
"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
create an onboarding invite first and get the inviteId
The invite ID associated with the invite.
The name of the individual or entity being invited.
"Updated"
A reference identifier for the invite.
"12322"
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.
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.
""
Response
Successfully updated onboarding invite.
Was this page helpful?

