curl --request POST \
--url https://sandbox-platform.jupico.com/v1/onboardinginvites/createmany \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"invites": [
{
"name": "Tech",
"email": "test@gmail.com",
"phoneNumber": "2995318324",
"reference": "1234",
"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",
"ssn": "123123123",
"ownershipPercentage": 100,
"email": "mail_m@asd.com"
}
]
}
},
{
"name": "Tech2",
"email": "test2@gmail.com",
"phoneNumber": "2995318325",
"reference": "1235",
"identity": {
"business": {
"legalName": "testInvite",
"dbaName": "testDBAInvite",
"federalTaxId": "999999999",
"tinType": "SSN",
"phoneNumber": "2232322323",
"address": {
"streetNum": "123",
"streetName": "main street",
"city": "ny",
"state": "NY",
"postalCode": "22222"
},
"websiteUrl": "https://www.sarasa.com",
"ownershipType": "SoleProprietorship",
"businessEstablishedDate": "2023-11-02",
"expectedMonthlyVolume": 200
}
}
}
],
"payoutBankAccounts": [
{
"accountRouting": "123123122",
"accountNumber": "8789545642",
"accountType": "checking",
"nameOnAccount": "Updatedjonnydooeiacc"
}
],
"dryRun": true
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/onboardinginvites/createmany"
payload = {
"invites": [
{
"name": "Tech",
"email": "test@gmail.com",
"phoneNumber": "2995318324",
"reference": "1234",
"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",
"ssn": "123123123",
"ownershipPercentage": 100,
"email": "mail_m@asd.com"
}
] }
},
{
"name": "Tech2",
"email": "test2@gmail.com",
"phoneNumber": "2995318325",
"reference": "1235",
"identity": { "business": {
"legalName": "testInvite",
"dbaName": "testDBAInvite",
"federalTaxId": "999999999",
"tinType": "SSN",
"phoneNumber": "2232322323",
"address": {
"streetNum": "123",
"streetName": "main street",
"city": "ny",
"state": "NY",
"postalCode": "22222"
},
"websiteUrl": "https://www.sarasa.com",
"ownershipType": "SoleProprietorship",
"businessEstablishedDate": "2023-11-02",
"expectedMonthlyVolume": 200
} }
}
],
"payoutBankAccounts": [
{
"accountRouting": "123123122",
"accountNumber": "8789545642",
"accountType": "checking",
"nameOnAccount": "Updatedjonnydooeiacc"
}
],
"dryRun": True
}
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({
invites: [
{
name: 'Tech',
email: 'test@gmail.com',
phoneNumber: '2995318324',
reference: '1234',
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',
ssn: '123123123',
ownershipPercentage: 100,
email: 'mail_m@asd.com'
}
]
}
},
{
name: 'Tech2',
email: 'test2@gmail.com',
phoneNumber: '2995318325',
reference: '1235',
identity: {
business: {
legalName: 'testInvite',
dbaName: 'testDBAInvite',
federalTaxId: '999999999',
tinType: 'SSN',
phoneNumber: '2232322323',
address: {
streetNum: '123',
streetName: 'main street',
city: 'ny',
state: 'NY',
postalCode: '22222'
},
websiteUrl: 'https://www.sarasa.com',
ownershipType: 'SoleProprietorship',
businessEstablishedDate: '2023-11-02',
expectedMonthlyVolume: 200
}
}
}
],
payoutBankAccounts: [
{
accountRouting: '123123122',
accountNumber: '8789545642',
accountType: 'checking',
nameOnAccount: 'Updatedjonnydooeiacc'
}
],
dryRun: true
})
};
fetch('https://sandbox-platform.jupico.com/v1/onboardinginvites/createmany', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/onboardinginvites/createmany';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
invites: [
{
name: 'Tech',
email: 'test@gmail.com',
phoneNumber: '2995318324',
reference: '1234',
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',
ssn: '123123123',
ownershipPercentage: 100,
email: 'mail_m@asd.com'
}
]
}
},
{
name: 'Tech2',
email: 'test2@gmail.com',
phoneNumber: '2995318325',
reference: '1235',
identity: {
business: {
legalName: 'testInvite',
dbaName: 'testDBAInvite',
federalTaxId: '999999999',
tinType: 'SSN',
phoneNumber: '2232322323',
address: {
streetNum: '123',
streetName: 'main street',
city: 'ny',
state: 'NY',
postalCode: '22222'
},
websiteUrl: 'https://www.sarasa.com',
ownershipType: 'SoleProprietorship',
businessEstablishedDate: '2023-11-02',
expectedMonthlyVolume: 200
}
}
}
],
payoutBankAccounts: [
{
accountRouting: '123123122',
accountNumber: '8789545642',
accountType: 'checking',
nameOnAccount: 'Updatedjonnydooeiacc'
}
],
dryRun: true
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"code": "<string>",
"message": "<string>",
"data": {
"total": 123,
"succeeded": {
"count": 123,
"results": [
{
"inviteId": "<string>",
"name": "<string>",
"email": "<string>"
}
]
},
"failed": {
"count": 123,
"results": [
{}
]
},
"dryRun": true
}
}Create multiple invites
Creates multiple onboarding invites in a single request, for bulk merchant migrations. Set dryRun to true to validate the batch without creating any invites.
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/onboardinginvites/createmany \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"invites": [
{
"name": "Tech",
"email": "test@gmail.com",
"phoneNumber": "2995318324",
"reference": "1234",
"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",
"ssn": "123123123",
"ownershipPercentage": 100,
"email": "mail_m@asd.com"
}
]
}
},
{
"name": "Tech2",
"email": "test2@gmail.com",
"phoneNumber": "2995318325",
"reference": "1235",
"identity": {
"business": {
"legalName": "testInvite",
"dbaName": "testDBAInvite",
"federalTaxId": "999999999",
"tinType": "SSN",
"phoneNumber": "2232322323",
"address": {
"streetNum": "123",
"streetName": "main street",
"city": "ny",
"state": "NY",
"postalCode": "22222"
},
"websiteUrl": "https://www.sarasa.com",
"ownershipType": "SoleProprietorship",
"businessEstablishedDate": "2023-11-02",
"expectedMonthlyVolume": 200
}
}
}
],
"payoutBankAccounts": [
{
"accountRouting": "123123122",
"accountNumber": "8789545642",
"accountType": "checking",
"nameOnAccount": "Updatedjonnydooeiacc"
}
],
"dryRun": true
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/onboardinginvites/createmany"
payload = {
"invites": [
{
"name": "Tech",
"email": "test@gmail.com",
"phoneNumber": "2995318324",
"reference": "1234",
"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",
"ssn": "123123123",
"ownershipPercentage": 100,
"email": "mail_m@asd.com"
}
] }
},
{
"name": "Tech2",
"email": "test2@gmail.com",
"phoneNumber": "2995318325",
"reference": "1235",
"identity": { "business": {
"legalName": "testInvite",
"dbaName": "testDBAInvite",
"federalTaxId": "999999999",
"tinType": "SSN",
"phoneNumber": "2232322323",
"address": {
"streetNum": "123",
"streetName": "main street",
"city": "ny",
"state": "NY",
"postalCode": "22222"
},
"websiteUrl": "https://www.sarasa.com",
"ownershipType": "SoleProprietorship",
"businessEstablishedDate": "2023-11-02",
"expectedMonthlyVolume": 200
} }
}
],
"payoutBankAccounts": [
{
"accountRouting": "123123122",
"accountNumber": "8789545642",
"accountType": "checking",
"nameOnAccount": "Updatedjonnydooeiacc"
}
],
"dryRun": True
}
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({
invites: [
{
name: 'Tech',
email: 'test@gmail.com',
phoneNumber: '2995318324',
reference: '1234',
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',
ssn: '123123123',
ownershipPercentage: 100,
email: 'mail_m@asd.com'
}
]
}
},
{
name: 'Tech2',
email: 'test2@gmail.com',
phoneNumber: '2995318325',
reference: '1235',
identity: {
business: {
legalName: 'testInvite',
dbaName: 'testDBAInvite',
federalTaxId: '999999999',
tinType: 'SSN',
phoneNumber: '2232322323',
address: {
streetNum: '123',
streetName: 'main street',
city: 'ny',
state: 'NY',
postalCode: '22222'
},
websiteUrl: 'https://www.sarasa.com',
ownershipType: 'SoleProprietorship',
businessEstablishedDate: '2023-11-02',
expectedMonthlyVolume: 200
}
}
}
],
payoutBankAccounts: [
{
accountRouting: '123123122',
accountNumber: '8789545642',
accountType: 'checking',
nameOnAccount: 'Updatedjonnydooeiacc'
}
],
dryRun: true
})
};
fetch('https://sandbox-platform.jupico.com/v1/onboardinginvites/createmany', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/onboardinginvites/createmany';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
invites: [
{
name: 'Tech',
email: 'test@gmail.com',
phoneNumber: '2995318324',
reference: '1234',
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',
ssn: '123123123',
ownershipPercentage: 100,
email: 'mail_m@asd.com'
}
]
}
},
{
name: 'Tech2',
email: 'test2@gmail.com',
phoneNumber: '2995318325',
reference: '1235',
identity: {
business: {
legalName: 'testInvite',
dbaName: 'testDBAInvite',
federalTaxId: '999999999',
tinType: 'SSN',
phoneNumber: '2232322323',
address: {
streetNum: '123',
streetName: 'main street',
city: 'ny',
state: 'NY',
postalCode: '22222'
},
websiteUrl: 'https://www.sarasa.com',
ownershipType: 'SoleProprietorship',
businessEstablishedDate: '2023-11-02',
expectedMonthlyVolume: 200
}
}
}
],
payoutBankAccounts: [
{
accountRouting: '123123122',
accountNumber: '8789545642',
accountType: 'checking',
nameOnAccount: 'Updatedjonnydooeiacc'
}
],
dryRun: true
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"code": "<string>",
"message": "<string>",
"data": {
"total": 123,
"succeeded": {
"count": 123,
"results": [
{
"inviteId": "<string>",
"name": "<string>",
"email": "<string>"
}
]
},
"failed": {
"count": 123,
"results": [
{}
]
},
"dryRun": true
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
Invites to create. Each entry follows the create-invite schema.
Hide child attributes
Hide child attributes
The name of the individual or entity being invited.
"John Doe"
The email address of the invitee.
"example@example.com"
The phone number of the invitee.
"2232322323"
A reference identifier for the invite.
"Reference 123"
The identity object containing data about the business and its representatives
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Title.
Mr., Ms., Mrs. "Mr."
First name.
"jonny"
Middle name.
"eric"
Last name.
"dooei"
Date of birth (YYYY-MM-DD).
"2000-08-01"
Phone number.
"2232322323"
Street number.
"79"
Street name.
"clarks"
City name.
"ny"
Two-letter US state code.
AK, AL, AR, AZ, CA, CO, CT, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, ME, MD, MI, MN, MS, MO, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY "NY"
ZIP or postal code.
"23434"
Social Security number, 9 digits.
"123123123"
The position of the owner. Possible values are:
- OW: Owner
- CEO: Chief Executive Officer
- CFO: Chief Financial Officer
- COO: Chief Operating Officer
- PRESIDENT: President
- VICE PRESIDENT: Vice President
- DIR: Director
- TR: Treasurer
- SEC: Secretary
- PA: Partner
- MEMBER LLC: Member of LLC
- OTH: Other
- SP: Sole Proprietorship
OW, CEO, CFO, COO, PRESIDENT, VICE PRESIDENT, DIR, TR, SEC, PA, MEMBER LLC, OTH, SP "CEO"
Percentage of the business this owner holds (0-100).
100
Email address.
"mail_m@asd.com"
Hide child attributes
Hide child attributes
Registered legal name of the business.
"testInvite"
The merchant's doing-business-as name. Appears on customer statements unless overridden.
"testDBAInvite"
Federal tax ID, 9 digits.
"999999999"
The type of Tax Identification Number (TIN):
- SSN (Social Security Number)
- EIN (Employer Identification Number)
- Other
SSN, EIN, Other "SSN"
Four-digit merchant category code (MCC) that classifies the business.
"5812"
Phone number.
"2232322323"
Address details.
Hide child attributes
Hide child attributes
Street number.
"123"
Street name.
"main street"
City name.
"ny"
Two-letter US state code.
AK, AL, AR, AZ, CA, CO, CT, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, ME, MD, MI, MN, MS, MO, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY "NY"
ZIP or postal code.
"22222"
Business website URL.
"https://www.sarasa.com"
Legal structure of the business.
PublicCorporation, Government, PrivateCorporation, SoleProprietorship, LLC, Partnership, NonProfit, Trust "PrivateCorporation"
Format: YYYY-MM-DD
"2023-11-02"
Expected monthly processing volume, used in underwriting.
200
Hide child attributes
Hide child attributes
First name.
"John"
Middle name.
"Michael"
Last name.
"Doe"
Format: YYYY-MM-DD
"1990-01-15"
Role of the owner in the business.
"CEO"
Social Security Number
"123-45-6789"
Phone number.
"5551234567"
Email address.
"john.doe@example.com"
Bank accounts where the merchant receives payouts.
Hide child attributes
Hide child attributes
9-digit ABA routing number.
"123123122"
Bank account number.
"8789545642"
Bank account type, such as checking.
checking "checking"
Name on the bank account.
"Updatedjonnydooeiacc"
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.
Hide child attributes
Hide child attributes
Fee configuration at the platform level.
Hide child attributes
Hide child attributes
Interchange pass-through fee settings.
Hide child attributes
Hide child attributes
Whether this setting is enabled.
false
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Event-based fees, one entry per transaction event type.
Hide child attributes
Hide child attributes
Fee applied to each card-not-present sale.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Percentage fee charged on the event amount.
2
Fixed fee amount charged each time this event occurs.
0.3
Fee applied to each card-not-present capture.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Percentage fee charged on the event amount.
2
Fixed fee amount charged each time this event occurs.
0.3
Fee applied to each card-not-present authorization.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Percentage fee charged on the event amount.
2
Fixed fee amount charged each time this event occurs.
0.25
Fee applied to each card-not-present void.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0
Whether the fixed fee is returned when the underlying transaction is reversed.
true
Whether the percentage fee is returned when the underlying transaction is reversed.
true
Fee applied to each card-not-present refund.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0.75
Whether the fixed fee is returned when the underlying transaction is reversed.
false
Whether the percentage fee is returned when the underlying transaction is reversed.
true
Fee applied to each card-not-present credit.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0.75
Whether the fixed fee is returned when the underlying transaction is reversed.
false
Whether the percentage fee is returned when the underlying transaction is reversed.
true
Fee applied to each card-not-present reversal.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0.75
Whether the fixed fee is returned when the underlying transaction is reversed.
false
Whether the percentage fee is returned when the underlying transaction is reversed.
true
Fee applied to each chargeback.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
25
Fee applied to each AVS-only verification.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0
Fee applied to each declined card-not-present attempt.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
"spProduct"
Fixed fee amount charged each time this event occurs.
0.5
Fee applied to each eCheck sale.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Percentage fee charged on the event amount.
2.9
Fixed fee amount charged each time this event occurs.
0.3
Fee applied to each eCheck verification.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Percentage fee charged on the event amount.
0
Fixed fee amount charged each time this event occurs.
0
Fee applied to each eCheck void.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0
Whether the fixed fee is returned when the underlying transaction is reversed.
true
Whether the percentage fee is returned when the underlying transaction is reversed.
true
Fee applied to each eCheck refund.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0.75
Whether the fixed fee is returned when the underlying transaction is reversed.
false
Whether the percentage fee is returned when the underlying transaction is reversed.
true
Fee applied to each eCheck credit.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0.75
Whether the fixed fee is returned when the underlying transaction is reversed.
false
Whether the percentage fee is returned when the underlying transaction is reversed.
true
Fee applied to each eCheck reversal.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0.75
Whether the fixed fee is returned when the underlying transaction is reversed.
false
Whether the percentage fee is returned when the underlying transaction is reversed.
true
Recurring fees charged on a fixed schedule, such as monthly service fees.
Hide child attributes
Hide child attributes
Billing period for this recurring fee.
today, yesterday, last-7-days, this-month, this-year, last-6-months, one-time, daily, weekly, monthly, quarterly, per-semester, annually "daily"
Fixed fee amount charged each time this event occurs.
3
Start of the window during which this fee applies (ISO 8601).
"2025-08-01T03:00:00.000Z"
End of the window during which this fee applies (ISO 8601).
"2025-08-23T03:00:00.000Z"
Whether this recurring fee is currently active.
"enabled"
When true, the recurring fee starts only after the merchant processes their first transaction.
false
Whether the first billing period is prorated.
true
Fee configuration at the Service Provider product level.
Hide child attributes
Hide child attributes
Interchange pass-through fee settings.
Event-based fees, one entry per transaction event type.
Hide child attributes
Hide child attributes
Fee applied to each card-not-present sale.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Percentage fee charged on the event amount.
2
Fixed fee amount charged each time this event occurs.
0.3
Fee applied to each card-not-present capture.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Percentage fee charged on the event amount.
2
Fixed fee amount charged each time this event occurs.
0.3
Fee applied to each card-not-present authorization.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Percentage fee charged on the event amount.
2
Fixed fee amount charged each time this event occurs.
0.25
Fee applied to each card-not-present void.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0
Whether the fixed fee is returned when the underlying transaction is reversed.
true
Whether the percentage fee is returned when the underlying transaction is reversed.
true
Fee applied to each card-not-present refund.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0.75
Whether the fixed fee is returned when the underlying transaction is reversed.
false
Whether the percentage fee is returned when the underlying transaction is reversed.
true
Fee applied to each card-not-present credit.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0.75
Whether the fixed fee is returned when the underlying transaction is reversed.
false
Whether the percentage fee is returned when the underlying transaction is reversed.
true
Fee applied to each card-not-present reversal.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0.75
Whether the fixed fee is returned when the underlying transaction is reversed.
false
Whether the percentage fee is returned when the underlying transaction is reversed.
true
Fee applied to each chargeback.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
25
Fee applied to each AVS-only verification.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0
Fee applied to each declined card-not-present attempt.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
"spProduct"
Fixed fee amount charged each time this event occurs.
0.5
Fee applied to each eCheck sale.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Percentage fee charged on the event amount.
2.9
Fixed fee amount charged each time this event occurs.
0.3
Fee applied to each eCheck verification.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Percentage fee charged on the event amount.
0
Fixed fee amount charged each time this event occurs.
0
Fee applied to each eCheck void.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0
Whether the fixed fee is returned when the underlying transaction is reversed.
true
Whether the percentage fee is returned when the underlying transaction is reversed.
true
Fee applied to each eCheck refund.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0.75
Whether the fixed fee is returned when the underlying transaction is reversed.
false
Whether the percentage fee is returned when the underlying transaction is reversed.
true
Fee applied to each eCheck credit.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0.75
Whether the fixed fee is returned when the underlying transaction is reversed.
false
Whether the percentage fee is returned when the underlying transaction is reversed.
true
Fee applied to each eCheck reversal.
Hide child attributes
Hide child attributes
Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).
spProduct, submerchant "spProduct"
Fixed fee amount charged each time this event occurs.
0.75
Whether the fixed fee is returned when the underlying transaction is reversed.
false
Whether the percentage fee is returned when the underlying transaction is reversed.
true
Recurring fees charged on a fixed schedule, such as monthly service fees.
Hide child attributes
Hide child attributes
Billing period for this recurring fee.
today, yesterday, last-7-days, this-month, this-year, last-6-months, one-time, daily, weekly, monthly, quarterly, per-semester, annually "daily"
Fixed fee amount charged each time this event occurs.
3
Start of the window during which this fee applies (ISO 8601).
"2025-08-01T03:00:00.000Z"
End of the window during which this fee applies (ISO 8601).
"2025-08-23T03:00:00.000Z"
Whether this recurring fee is currently active.
"enabled"
When true, the recurring fee starts only after the merchant processes their first transaction.
false
Whether the first billing period is prorated.
true
UUID of the onboarding flow template to be used for the onboarding experience.
""
A flag indicating whether the operation should be run in dry run mode (true) or not (false).
Response
Successfully fetched onboarding invites.
Whether the request was processed successfully. Declines return HTTP 200 with success: false.
Machine-readable result code. See the Error Codes reference.
Human-readable result message.
The response payload.
Hide child attributes
Hide child attributes
Total number of records processed.
The subset that succeeded, with count and results.
Hide child attributes
Hide child attributes
When true, validates the request without creating invites.
Was this page helpful?

