---
updatedAt: 2026-03-05T09:17:30.000Z
agentTools:
  projectIndex: https://neutronpay.readme.io/llms.txt
---

# Retrieve account information

Retrieve the account information

Retrieve details for an account or subaccount, including display name, status, country, and configuration.

### Example Request

```bash
curl https://api.neutron.me/api/v2/account/YOUR_ACCOUNT_ID \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

### Example Response

```json
{
  "data": {
    "id": "ne01-abc123def456",
    "displayName": "My Company",
    "accountStatus": "active",
    "autoUserConfirm": false,
    "countryCode": "CA",
    "timezone": "America/Toronto",
    "createdAt": "2025-01-15T10:00:00.000Z",
    "updatedAt": "2026-02-01T08:30:00.000Z"
  }
}
```

### Response Fields

| Field             | Type    | Description                                               |
| ----------------- | ------- | --------------------------------------------------------- |
| `id`              | string  | Unique account identifier (e.g., `ne01-...`)              |
| `parentId`        | string  | Present if this is a subaccount — the parent account's ID |
| `extId`           | string  | External reference ID for subaccounts (set by parent)     |
| `displayName`     | string  | Account display name                                      |
| `accountStatus`   | string  | Current status (e.g., `active`)                           |
| `autoUserConfirm` | boolean | If `true`, transactions skip the manual confirm step      |
| `countryCode`     | string  | Account's country code (e.g., `CA`, `VN`)                 |
| `timezone`        | string  | Account timezone                                          |
| `createdAt`       | string  | Account creation timestamp                                |
| `updatedAt`       | string  | Last update timestamp                                     |

### Access Control

* Works for both **accounts** and **subaccounts**
* Subaccount info can be retrieved by the **subaccount itself** or its **parent account**
* Requesting another account's info returns **401 Unauthorized**

### Subaccounts

If the account has a `parentId`, it's a subaccount. Subaccounts are useful for:

* **Marketplaces** — each seller gets a subaccount
* **Platforms** — each user gets isolated wallets
* **Multi-entity businesses** — separate accounting per entity

The `extId` field lets you map subaccounts to your own system's user/entity IDs.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Neutronpay API",
    "version": "2.2.6",
    "description": "Neutron API Reference"
  },
  "servers": [
    {
      "url": "https://api.neutron.me",
      "description": "Development environment"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "JWT Authorization header using the Bearer scheme. Example: 'Authorization: Bearer {token}'"
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Account management",
      "description": "Account and wallet management endpoints"
    }
  ],
  "paths": {
    "/api/v2/account/{accountId}": {
      "get": {
        "summary": "Retrieve account information",
        "description": "Retrieve the account information",
        "tags": [
          "Account management"
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Unique identifier of the account"
                        },
                        "parentId": {
                          "type": "string",
                          "description": "If present, indicates this is a sub-account that belongs to another parent account"
                        },
                        "extId": {
                          "type": "string",
                          "description": "For sub-accounts, this field allows using as a reference ID in external systems"
                        },
                        "displayName": {
                          "type": "string",
                          "description": "The display name of the account"
                        },
                        "accountStatus": {
                          "type": "string",
                          "description": "The current status of the account"
                        },
                        "autoUserConfirm": {
                          "type": "boolean",
                          "description": "If set to true, all transactions will skip the auto confirmation step"
                        },
                        "countryCode": {
                          "type": "string",
                          "description": "Country that the account belongs to (e.g., 'CA')"
                        },
                        "timezone": {
                          "type": "string",
                          "description": "Timezone of the account"
                        },
                        "createdAt": {
                          "type": "string",
                          "format": "date-time",
                          "description": "Timestamp when the account was created"
                        },
                        "updatedAt": {
                          "type": "string",
                          "format": "date-time",
                          "description": "Timestamp when the account was last updated"
                        }
                      }
                    }
                  }
                },
                "examples": {
                  "Success": {
                    "summary": "Success",
                    "value": {
                      "data": {
                        "id": "ne01-abc123",
                        "parentId": "ne01-root001",
                        "extId": "external-xyz",
                        "displayName": "Neutron Wallet VN",
                        "accountStatus": "active",
                        "autoUserConfirm": true,
                        "countryCode": "VN",
                        "timezone": "Asia/Ho_Chi_Minh",
                        "createdAt": "2024-03-01T08:00:00Z",
                        "updatedAt": "2025-04-20T12:34:56Z"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "examples": {
                  "Bad Request": {
                    "value": {
                      "error": "failed to get account"
                    },
                    "summary": "Bad Request"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "examples": {
                  "Unauthorized": {
                    "value": {
                      "error": "you are not authorized to view this account"
                    },
                    "summary": "Unauthorized"
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found"
          }
        },
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "required": true,
            "description": "The unique identifier of the account to retrieve",
            "schema": {
              "type": "string",
              "default": ""
            }
          }
        ],
        "operationId": "getAccountInfo"
      }
    }
  },
  "x-readme": {}
}
```