v1

latestOpenAPI 3.0.02026-07-14866188.2 KB

SubAccount

Interledger

Create a new sub-account.

post/v0.2.4/sub-account/create

Request body

namestring required

Name of owner of Wallet.

emailstring

Email of owner of Wallet.

firstNamestring

First Name of owner.

lastNamestring

Last Name of owner.

phoneNumberstring

Phone Number with country code starting with a +.

metaobject

Metadata to store about the account.

Example request

{
  "name": "Mide Jones",
  "email": "user@mail.com",
  "firstName": "Mide",
  "lastName": "Jones",
  "phoneNumber": "+16471234567"
}

Response

Success.

statusstring

messagestring

Message indicating the result of the operation.

Example response

{
  "status": "success",
  "message": "Sub-account created successfully",
  "data": {
    "id": "907b90ef-d723-4b07-9f74-480afb5f09ef",
    "lastName": "Okeeke",
    "parent": "qP3P6bjbjLZUMxVfxgEqzOF0hNM2",
    "verified": true,
    "subscription": {
      "subscription_end_timestamp": {
        "_seconds": 1883676344,
        "_nanoseconds": 773000000
      },
      "subscription_start_timestamp": {
        "_seconds": 1725909944,
        "_nanoseconds": 773000000
      },
      "id": "partner-white-glove"
    },
    "subAccount": true,
    "firstName": "Madueke",
    "uid": "907b90ef-d723-4b07-9f74-480afb5f09ef",
    "approved": true,
    "createdDate": "2024-09-09T19:25:44.773Z",
    "joinDate": "2024-09-09T19:25:44.773Z",
    "phoneNumber": "+2348139955333",
    "tier": {
      "id": "tier-3"
    },
    "meta": {
      "email": "Okyson@mail.com"
    },
    "approvals": [
      {
        "changedFields": [
          "all"
        ],
        "deviceTime": "9/9/2024",
        "timestamp": "2024-09-09T19:25:33.918Z"
      }
    ],
    "name": "Madueke Okeeke",
    "apiUseEnabled": true,
    "email": "Okyson@mail.com",
    "p_id": 60250680,
    "verification": {
      "status": "completed"
    }
  }
}