Account
Confirm your credentials and read your account status, balance and order prefix
Base URL
https://partners-api.mobisim.com1 GET1 total
⚠All requests require
X-Merchant-Id and X-Api-Key headers. Use the Try it panel on each endpoint to set them. Learn more →Response
The account behind the supplied credentials. A 200 here is the confirmation that your key pair works, so call this before anything else. `orderPrefix` is the string every order id from this account begins with. isActive is always true in a 200: a suspended company is refused by the credential check before this action runs, so the suspension arrives as a 401 rather than as a field on a successful response. This previously documented a reads-still-work behaviour the API has never had.
Example 200GET /api/Account/Me
{
"success": true,
"message": null,
"data": {
"merchantId": "3f8a1c9e42b74d6fa0e5c7b21d934e80",
"companyId": 42,
"companyName": "Nomad Home IP",
"countryCode": "NL",
"orderPrefix": "NOMAD",
"isActive": true,
"balance": 1284.5,
"lifetimeCredited": 5000,
"sellablePackages": 1873
},
"totalCount": 0,
"page": 0,
"pageSize": 0,
"totalPages": 0,
"stats": {}
}dataMerchantAccountDto
| Field | Type | Description |
|---|---|---|
merchantId | string | Your public identity, the value sent as `X-Merchant-Id`. |
companyId | integer | |
companyName | string | |
countryCode | stringnullable | ISO 3166-1 alpha-2 country the company is registered in. |
orderPrefix | stringnullable | The prefix every order id from this account begins with. Match on it when reconciling our records against yours. |
isActive | boolean | False means the account is suspended: reads keep working and purchases are refused. Surfaced so a suspension is distinguishable from a transient failure. |
balance | number | Spendable balance. Orders settle against this. |
lifetimeCredited | number | Everything ever credited to the wallet, before spending. |
sellablePackages | integer | How many packages this account can currently sell. |