Get Sub-Account Configurations
Use GET Sub-Account Configurations method to inquire all the possible Sub-Account configurations offered by your Service Provider.
Specify (change or pick) necessary parameters, remove what you do not need and use this data packet with POST (Create Sub-Account) method to create a new Sub-Account.
Use GET Sub-Account method to inquire parameters of an existing Sub-Account.
In this case you will receive a limited set of parameters that belong to a specific Sub-Account.
You can take this data and use in POST (Create Sub-Account) method to create a Sub-Account with the same parameters or change it and create a new Sub-Account.
Endpoint:
GET
Sandbox:
https://sandbox.4levers.com/managementapi/api/serviceproviders/{serviceProviderId}/template
Production: https://managementapi.4levers.com/api/serviceproviders/{serviceProviderId}/template
In the request URL you enter a target {serviceProviderId} you wish to inquire Sub-Account settings from.
Response Parameters
| Name | Type | Description | |
| accountId | integer | Platform Account identifier. | |
| subAccountId | integer | Sub-Account identifier. | |
| merchantId | string | Merchant identifier (MID). | |
| externalId | string | Merchant external identifier. | |
| mcc | string | Merchant Category Code (MCC). | |
| applicationId | integer | Underwriting application identifier. | |
| accountName | string | Max250 Platform Account Name. | |
| signUpDate | datetime | ||
| approvalDate | datetime | ||
| boardingDate | datetime | ||
| modificationDate | datetime | ||
| billing | object | Sub-Account billing settings. Only for Fees, that have feeSource=Sub-Account. | |
| payouts | object | Sub-Account payouts settings. | |
| processing | object | Sub-Account processing settings. | |
| serviceProviderId | integer | Service Provider identifier. Serves as SkinID for user authorization purposes. | |
| subAccountName | string | Sub-Account name. varchar(50) | |
| sumUpCutOffHour | integer | Auto cut-off value. | |
| payoutCutOffHour | integer | Payout cut-off value. | |
| merchantStatement | object | Merchant statement settings. | |
| isTemplate | boolean | Defines a template account |
Response Codes
| Response Code | Description |
|---|---|
| 400 | Bad Request — Your request is invalid. |
| 401 | Unauthorized — Authorization failed. |
| 403 | Forbidden — Access denied. |
| 404 | Not Found — Wrong URL. |
| 415 | Unsupported Media Type — Wrong request format. |
| 500 | Internal Server Error— We had a problem with our server. Try again later. |
| 503 | Service Unavailable — We’re temporarily offline for maintenance. Please try again later. |
.../api/serviceproviders/{serviceProviderId}/template
Response
{
"accountId": 0,
"subAccountId": 0,
"merchantId": "string",
"externalId": "string",
"mcc": "string",
"applicationId": 0,
"accountName": "string",
"signUpDate": "2021-04-07T04:44:58.6666666",
"approvalDate": "2021-04-08T04:44:58.7777777",
"boardingDate": "2021-04-09T04:44:58.8888888",
"modificationDate": "2021-04-09T05:44:58.9999999",
"billing": {
"interchangeFeesRegions": [
0
],
"interchangeFeesReversalEnabled": [
"Void"
],
"interchangeFeesOverride": {
"source": "SubAccount",
"target": "Platform",
"sourceSubAccountId": 0,
"targetSubAccountId": 0,
"sourceAgentId": 0,
"targetAgentId": 0
},
"interchangeFeeSeason": {
"dateFrom": "2021-04-07T04:44:58.6666666",
"dateTo": "2021-04-12T04:44:58.6666666",
"offSeasonMonth": [
0
]
},
"scheduledFees": [
{
"id": 0,
"amount": 0,
"dayNumber": 0,
"endDate": "2021-04-12T04:44:58.6666666",
"expiration": "UntilDate",
"interval": "Daily",
"intervalCount": 0,
"monthNumber": 0,
"name": "string",
"occurrencesQuantity": 0,
"override": {
"source": "SubAccount",
"target": "Platform",
"sourceSubAccountId": 0,
"targetSubAccountId": 0,
"sourceAgentId": 0,
"targetAgentId": 0
},
"feeSeason": {
"dateFrom": "2021-04-07T04:44:58.6666666",
"dateTo": "2021-04-12T04:44:58.6666666",
"offSeasonMonth": [
0
]
}
}
],
"slidingScaleFees": [
{
"feePriorityLevel": 0,
"id": 0,
"name": "string",
"ranges": [
{
"amount": 0,
"maxCount": 0,
"minCount": 0,
"percentage": 0
}
],
"reversalEnabled": [
"Void"
],
"feeSeason": {
"dateFrom": "2021-04-07T04:44:58.6666666",
"dateTo": "2021-04-12T04:44:58.6666666",
"offSeasonMonth": [
0
]
},
"override": {
"source": "SubAccount",
"target": "Platform",
"sourceSubAccountId": 0,
"targetSubAccountId": 0,
"sourceAgentId": 0,
"targetAgentId": 0
},
"buyrate": {
"amount": 0,
"percentage": 0,
"source": "SubAccount",
"target": "Platform",
"sourceSubAccountId": 0,
"targetSubAccountId": 0,
"sourceAgentId": 0,
"targetAgentId": 0,
"buyrateGapPayer":"Agent",
"buyrateGapPayerAgentId":0,
"buyrateGapPayerSubAccountId": 0
},
"split": [
{
"priorityLevel": 0,
"percentage": 0,
"source": "SubAccount",
"target": "Platform",
"sourceSubAccountId": 0,
"targetSubAccountId": 0,
"sourceAgentId": 0,
"targetAgentId": 0
}
]
}
],
"transactionFees": [
{
"feePriorityLevel": 0,
"amount": 0,
"typeId": 0,
"name": "string",
"percentage": 0,
"buyrate": {
"amount": 0,
"percentage": 0,
"source": "SubAccount",
"target": "Platform",
"sourceSubAccountId": 0,
"targetSubAccountId": 0,
"sourceAgentId": 0,
"targetAgentId": 0,
"buyrateGapPayer":"Agent",
"buyrateGapPayerAgentId":0,
"buyrateGapPayerSubAccountId": 0
},
"split": [
{
"priorityLevel": 0,
"percentage": 0,
"source": "SubAccount",
"target": "Platform",
"sourceSubAccountId": 0,
"targetSubAccountId": 0,
"sourceAgentId": 0,
"targetAgentId": 0
}
],
"reversalEnabled": [
"Void"
],
"feeSeason": {
"dateFrom": "2021-04-07T04:44:58.6666666",
"dateTo": "2021-04-12T04:44:58.6666666",
"offSeasonMonth": [
0
]
},
"override": {
"source": "SubAccount",
"target": "Platform",
"sourceSubAccountId": 0,
"targetSubAccountId": 0,
"sourceAgentId": 0,
"targetAgentId": 0
}
}
],
"slidingScaleCounterReset": {
"timeInterval": "Weekly",
"numberOfIntervals": 0
}
},
"payouts": {
"manualPayout": true,
"negativePayout": true,
"payouts": [
{
"payoutMethodAch": {
"accountNumber": "string",
"accountType": "None",
"entityType": "Personal",
"nameOnAccount": "string",
"routingNumber": "string"
},
"calculation": {
"fixedAmount": 0,
"intervalCount": 0,
"intervalGap": 0,
"payoutType": "Fixed",
"percentageAmount": 0
},
"name": "string",
"scheduler": {
"id": 0,
"isSchedulerDisabled": false,
"dayNumber": 0,
"endDate": "2021-04-12T04:44:58.6666666",
"expiration": "UntilDate",
"interval": "Daily",
"intervalCount": 0,
"monthNumber": 0,
"occurrencesQuantity": 0
},
"twoStepApproval": true
}
],
"processor": {
"id": 0,
"parameters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"processor": "NoAcquirer"
},
"cardOnFileProcessorConfiguration": {
"id": 0,
"parameters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"processor": "NoAcquirer"
},
"payoutMethodCreditCard": {
"creditCardNumber": "string",
"creditCardNameOnCard": "string",
"creditCardExpirationDate": "string",
"creditCardCVV": "string"
},
"skipBalanceCheck": true
},
"processing": {
"ach": {
"processors": {
"id": 0,
"parameters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"processor": "NoAcquirer"
}
},
"creditCards": {
"autoCapture": true,
"giftCardsEnabled": true,
"threeDSecure": false,
"creditCardTypes": [
"Visa"
],
"processors": {
"id": 0,
"parameters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"processor": "NoAcquirer"
},
"tokenization": [
"External"
]
},
"currency": "USD",
"fraudPreventionEnabled": true,
"recurringBilling": {
"autoRenewalEnabled": true,
"recurringEngineEnabled": true,
"subscriptionsEnabled": true
},
"transactionMode": "Processing"
},
"serviceProviderId": 0,
"subAccountName": "string",
"payoutCutOffHour": 0,
"sumUpCutOffHour": 0,
"merchantStatement": {
"merchantNumber": "string",
"merchantName": "string",
"merchantDBA": "string",
"autoDeliveryContactEmail": "string"
},
"isTemplate": true
}