JUjustifi
Sub Accounts

Create a Sub Account (deprecated)

We no longer allow new platforms to use this API. To onboard a customer so they can process payments use Hosted Onboarding or Onboarding via API instead. During the onboarding process a sub account will automatically created for your customer.

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.

post/sub_accounts

Request

Headers

Authorizationstring required

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

Request body

namestring required

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

Example request

{
  "name": "Sub account name"
}

Response

Sub account was created successfully

idstring uuid

the object id, also found in the data object

typestring

the object type, or array of objects

page_infounknown

Example response

{
  "id": "prefix_xyz (same as id of data object)",
  "type": "sub_account",
  "data": {
    "id": "acc_xyz",
    "name": "The Shire Haberdashery",
    "account_type": "live",
    "status": "enabled",
    "currency": "usd",
    "platform_account_id": "acc_xyz",
    "payout_account_id": "ba_xyz",
    "business_id": "biz_xyz",
    "related_accounts": {
      "live_account_id": "acc_xyz",
      "test_account_id": "acc_xyz"
    },
    "payments_activated_on": "2021-01-15T12:00:00Z",
    "created_at": "2021-01-01T12:00:00Z",
    "updated_at": "2021-01-01T12:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.