curl --request POST \
--url https://sandbox-platform.jupico.com/v1/provisioning/submerchant \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"smApplicationId": "507f1f77bcf86cd799439012",
"services": {
"card": {
"enabled": true
},
"ach": {
"enabled": false
}
},
"identity": {},
"payoutBankAccounts": [
{
"accountRouting": "021000021",
"accountNumber": "1234567890",
"accountType": "checking",
"nameOnAccount": "Smith Enterprises LLC",
"isPreferred": true
}
]
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/provisioning/submerchant"
payload = {
"smApplicationId": "507f1f77bcf86cd799439012",
"services": {
"card": { "enabled": True },
"ach": { "enabled": False }
},
"identity": {},
"payoutBankAccounts": [
{
"accountRouting": "021000021",
"accountNumber": "1234567890",
"accountType": "checking",
"nameOnAccount": "Smith Enterprises LLC",
"isPreferred": 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({
smApplicationId: '507f1f77bcf86cd799439012',
services: {card: {enabled: true}, ach: {enabled: false}},
identity: {},
payoutBankAccounts: [
{
accountRouting: '021000021',
accountNumber: '1234567890',
accountType: 'checking',
nameOnAccount: 'Smith Enterprises LLC',
isPreferred: true
}
]
})
};
fetch('https://sandbox-platform.jupico.com/v1/provisioning/submerchant', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/provisioning/submerchant';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
smApplicationId: '507f1f77bcf86cd799439012',
services: {card: {enabled: true}, ach: {enabled: false}},
identity: {},
payoutBankAccounts: [
{
accountRouting: '021000021',
accountNumber: '1234567890',
accountType: 'checking',
nameOnAccount: 'Smith Enterprises LLC',
isPreferred: true
}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"code": "<string>",
"success": true,
"message": "<string>",
"data": {
"subMerchantId": "507f1f77bcf86cd799439013",
"status": "review"
}
}Create a submerchant
Creates a submerchant linked to an application, with the service selection, business identity, fee configuration, and payout bank accounts. The submerchant is the entity that processes transactions once approved.
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/provisioning/submerchant \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"smApplicationId": "507f1f77bcf86cd799439012",
"services": {
"card": {
"enabled": true
},
"ach": {
"enabled": false
}
},
"identity": {},
"payoutBankAccounts": [
{
"accountRouting": "021000021",
"accountNumber": "1234567890",
"accountType": "checking",
"nameOnAccount": "Smith Enterprises LLC",
"isPreferred": true
}
]
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/provisioning/submerchant"
payload = {
"smApplicationId": "507f1f77bcf86cd799439012",
"services": {
"card": { "enabled": True },
"ach": { "enabled": False }
},
"identity": {},
"payoutBankAccounts": [
{
"accountRouting": "021000021",
"accountNumber": "1234567890",
"accountType": "checking",
"nameOnAccount": "Smith Enterprises LLC",
"isPreferred": 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({
smApplicationId: '507f1f77bcf86cd799439012',
services: {card: {enabled: true}, ach: {enabled: false}},
identity: {},
payoutBankAccounts: [
{
accountRouting: '021000021',
accountNumber: '1234567890',
accountType: 'checking',
nameOnAccount: 'Smith Enterprises LLC',
isPreferred: true
}
]
})
};
fetch('https://sandbox-platform.jupico.com/v1/provisioning/submerchant', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/provisioning/submerchant';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
smApplicationId: '507f1f77bcf86cd799439012',
services: {card: {enabled: true}, ach: {enabled: false}},
identity: {},
payoutBankAccounts: [
{
accountRouting: '021000021',
accountNumber: '1234567890',
accountType: 'checking',
nameOnAccount: 'Smith Enterprises LLC',
isPreferred: true
}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"code": "<string>",
"success": true,
"message": "<string>",
"data": {
"subMerchantId": "507f1f77bcf86cd799439013",
"status": "review"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
Must be exactly 24 characters
"507f1f77bcf86cd799439012"
The services this merchant is applying to process. Enable at least one.
Send both card and ach on every request, using enabled: false for a service the merchant is not applying for.
Each service you enable must also be enabled on the service provider product identified by spProductId. Enabling a service the product does not offer is rejected with provisioning_service_not_available, and enabling neither service is rejected with provisioning_no_service_selected.
Hide child attributes
Hide child attributes
Identity details for the business and its owners.
Hide child attributes
Hide child attributes
Business identity details.
Hide child attributes
Hide child attributes
The merchant’s doing-business-as name. This value appears on the cardholder’s statement if no billing descriptor is provided.
100"Smith's Store"
9 digits
"123456789"
Type of tax identification number: SSN, EIN, or Other.
SSN, EIN, OTHER "EIN"
Business phone number.
15"1234567890"
Registered business address.
Hide child attributes
Hide child attributes
Street number.
9"456"
Street name.
40"Business Avenue"
City name.
30"Los Angeles"
Two-letter US state code.
"CA"
ZIP or postal code.
5"90210"
Business website URL.
70"https://www.smithsstore.com"
Legal structure of the business.
SoleProprietorship, PrivateCorporation, Partnership, LLC, Trust, Government, NonProfit, LimitedPartnership, LimitedLiabilityPartnership, PublicCorporation "LLC"
Date the business was established (YYYY-MM-DD).
"2020-01-15"
Expected monthly processing volume, used in underwriting.
50000
4 digits
"5999"
Registered legal name of the business.
150"Smith Enterprises LLC"
The text that appears on the cardholder’s statement, overriding the default business name.
25"SMITHS STORE"
Bank accounts where the merchant receives payouts.
1Hide child attributes
Hide child attributes
9-digit ABA routing number.
"021000021"
Bank account number.
"1234567890"
Bank account type, such as checking.
checking "checking"
Name on the bank account.
"Smith Enterprises LLC"
Whether this is the preferred account for payouts.
true
Service provider product ID
4"SP01"
UUID of a fees template with predefined pricing. If omitted, the default template is used.
"550e8400-e29b-41d4-a716-446655440000"
Response
Submerchant created successfully
Machine-readable result code. See the Error Codes reference.
Whether the request was processed successfully. Declines return HTTP 200 with success: false.
Human-readable result message.
Was this page helpful?