logo

Sub Accounts

Sub Accounts are the representation of your platform's customers in JustiFi. Payments are processed through sub accounts, each of which is associated with your platform account. To gain approval for payment processing, each sub account must submit the required onboarding information. You may send this to us through either our hosted onboarding or the API, and you'll be able to monitor each sub account's onboarding status along the way.

Status Description
created this sub account has been created (via Sub Accounts API), but we haven't received their onboarding entry yet
submitted we've received this sub account's onboarding entry (via hosted onboarding or API) and we're reviewing their information
information_needed we reviewed this sub account's onboarding entry and found an issue; we need more information before we can enable this account
enabled this sub account is approved to process payments note: test accounts are automatically enabled
rejected this sub account didn't pass approval, so they won't be able to process payments
disabled this sub account was previously approved, but has since become ineligible to process payments (e.g. due to fraud)
archived this sub account has been archived; they won't be able to process payments (but their record will remain for historical reasons)

Create a Sub Account

Create a JustiFi account for your customer, so they can process payments (once approved by JustiFi). The sub account will be created as part of your platform. If you use your test credentials, the sub account you create will have one account with the account_type of test. If you use your live credentials, the sub account you create will have two accounts -- one with the account_type of test and another with the account_type of live. This allows you to perform test operations on your real accounts by using their test account. When viewing the data payload for any sub account, you can reference the related_accounts attribute to get the test_account_id and live_account_id (if present) for that sub account.

Request
header Parameters
Authorization
required
string

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Example: Bearer {access_token}
Request Body schema: application/json
name
required
string

name for the sub account note: the name must be unique in your platform

Responses
201

Sub account was created successfully

post/sub_accounts
Request samples
application/json
{
  • "name": "Sub account name"
}
Response samples
application/json
{
  • "id": 1,
  • "type": "sub_account",
  • "data": {
    },
  • "page_info": "string"
}

List Sub Accounts

List the sub accounts for your platform. This endpoint supports pagination. Note: By default, all sub accounts which are not archived will be returned. To list archived sub accounts, use the optional status parameter set to archived

Request
query Parameters
status
string

Return accounts with specific status

Enum: "created" "submitted" "information_needed" "rejected" "enabled" "disabled" "archived"
Example: status=archived
header Parameters
Authorization
required
string

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Example: Bearer {access_token}
Responses
200

Successfully list sub accounts

get/sub_accounts
Request samples 
Response samples 
application/json
{
  • "id": 1,
  • "type": "array",
  • "data": [
    ],
  • "page_info": {
    }
}
Get a Sub Account
Get information about a sub account.


Request 
path Parameters
id
required
string <uuid> 
 
header Parameters
Authorization
required
string
the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)


 
 Example:  Bearer {access_token}
Responses 
200
Successfully get a sub account


get/sub_accounts/{id}
Request samples 
Response samples 
application/json
{
  • "id": 1,
  • "type": "sub_account",
  • "data": {
    },
  • "page_info": "string"
}
➔ Next to Seller Accounts