Updated on June 9, 2023

Get Sub-Account

Use GET method to inquire the existing Sub-Account parameters packet.
Use this packet to Create (POST method) and/or update existing Sub-Account (PUT method). Use Get Sub-Account Configurations method to inquire all the available Sub-Account settings from your Service Provider. Endpoint: GET Sandbox: https://sandbox.4levers.com/managementapi/api/accounts/{accountId}/subaccounts/{subAccountId} Production: https://managementapi.4levers.com/api/accounts/{accountId}/subaccounts/{subAccountId} The Values indicated in the URL are the target Platform Account identifier {accountId} and the target Sub-Account identifier {subAccountId} that you want to inquire.

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).
apiKey string API key. Required parameter for Tokenization API.
applicationId integer Underwriting application identifier.
accountName string Max250 Platform Account Name.
signUpDate datetime
approvalDate datetime
boardingDate 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/accounts/{accountId}/subaccounts/{subAccountId}
Response

{
  "accountId": 0,
  "subAccountId": 0,
  "merchantId": "string",
  "externalId": "string",
  "mcc": "string",
  "applicationId": 0,
  "apiKey": "string",
  "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,
    "importPayout": false,
    "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,
      "creditCardTypes": [
        "Visa"
      ],
      "threeDSecure": false,
      "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
    },
    "bnplEnabled": true,
    "transactionMode": "Processing"
  },
  "serviceProviderId": 0,
  "subAccountName": "string",
  "payoutCutOffHour": 0,
  "sumUpCutOffHour": 0,
  "merchantStatement": {
    "merchantNumber": "string",
    "merchantName": "string",
    "merchantDBA": "string",
    "autoDeliveryContactEmail": "string"
  },
  "isTemplate": true
}