Update Account

Updates an existing account's properties, including its name, default flag, and status. Returns the updated account details.

Endpoint

PATCH/v2/account/{id}

Link

Gateway APIstagep.tst-apidmndelss.com

Request

Path Parameters

Parameter	Type	Description	Required	Example
id	string	Account ID to update.	Yes	"UhcPVBEpjmtR"

Headers

Key	Value	Required
Authorization	Bearer <JWT>	Yes
Content-Type	application/json	Yes
Accept	application/json	Yes

Request Body (JSON)

All fields are optional - only include the fields you want to update.

Field	Type	Description & Values	Example
name	string	New account name.	"New Account Name"
currencyIso	string	New currency code (ISO 4217, e.g., USD).	"EUR"
isDefault	boolean	Set as default account (true/false).	true
status	string	New account status: - NEW - PRE_MODERATION - MODERATION - ACCEPTED - REJECTED - BANNED - PROCESSING	"ACCEPTED"

Example Request Body:

json

{
  "name": "Updated Business Account",
  "isDefault": true,
  "status": "ACCEPTED"
}

---

Response (200 OK)

Returns the updated Account entity v2 object in JSON format (same structure as Get Account by ID).

Key Response Fields

• name: Updated account name
• currencyIso: Updated currency (if changed)
• isDefault: New default status
• status: Updated account status
• updatedAt: New timestamp reflecting update time

Example Response:

json

{
  "item": {
    "id": "UhcPVBEpjmtR",
    "name": "Updated Business Account",
    "isDefault": true,
    "status": "ACCEPTED",
    "currencyIso": "USD",
    "updatedAt": "2024-05-21T09:15:00Z",
    // Other fields unchanged...
  }
}

Error Cases

1. Invalid Status Transition:

   json

   { "error": "Cannot change status from REJECTED to ACCEPTED" }

2. Currency Change Restrictions:

   json

   { "error": "Currency cannot be modified after account creation" }

3. Account Not Found:

   json

   { "error": "Account ID not found" }

---

Notes

• Partial Updates: Only included fields are modified; omitted fields remain unchanged.
• Immutable Fields: Some fields (e.g., customerId) cannot be updated.
• Status Flow: Ensure valid status transitions (e.g., NEW → ACCEPTED is valid, but BANNED → ACCEPTED may be blocked).

Examples

Real request

Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjE2NCwiZXhwIjoxNzYzNTQ3ODk4LCJrZXkiOiI1Y2ZiOGZjN2RmYjk4ZjVkYmIyZTgwNTVkZWFhN2U2Zjk4MzEyYmE3Iiwib3RwX3ZlcmlmaWVkIjpmYWxzZX0.p4m7Y6i9wSCYm6iVUsqMWD1-idNinUgqDiMn-4E9Uts
accountId*: UrpI6jMzHnsP

{
  "customerId": "D7k3xbc-ERrj-lde9k1t3XuaE",
  "name": "USDT ERC20 1",
  "currencyCode": "USDT_ERC20",
  "isDefault": true,
  "status": "NEW"
}

Real response

200 OK

{
  "item": {
    "accountId": "UrpI6jMzHnsP",
    "customer": {
      "id": "",
      "name": "",
      "email": "",
      "phone": "",
      "status": "NEW",
      "customerType": "CORPORATE"
    },
    "isDefault": true,
    "name": "USDT ERC20 1",
    "status": "NEW",
    "balance": {
      "balance": {
        "money": {
          "currencyCode": "USDT_ERC20",
          "units": "0",
          "nanos": 0
        },
        "default": {
          "currencyCode": "USD",
          "units": "0",
          "nanos": 0
        }
      },
      "hold": {
        "money": {
          "currencyCode": "USDT_ERC20",
          "units": "0",
          "nanos": 0
        },
        "default": {
          "currencyCode": "USD",
          "units": "0",
          "nanos": 0
        }
      }
    },
    "currencyCode": "USDT_ERC20",
    "requisites": [],
    "createdAt": "0001-01-01T00:00:00Z",
    "updatedAt": "0001-01-01T00:00:00Z"
  }
}