Open Lockbox Financial Account

This endpoint opens a special restricted financial account—called a lockbox—for a specific customer profile. Funds transferred into a lockbox account cannot be withdrawn by the customer, making it suitable for fund holds, compliance restrictions, or escrow-like scenarios. Only the partner or system administrator can move funds in or out of the lockbox; the customer retains visibility of the balance but cannot initiate withdrawals.

Endpoint

POST /netevia/lockboxfinancialAccount/{profileId}

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when a partner needs to create a restricted-access account to temporarily freeze or safeguard customer funds. Common scenarios include fraud investigations, active disputes, regulatory compliance holds, or any business rule that requires limiting a customer's access to specific funds. The lockbox model ensures the customer can see the balance but cannot independently move the money.

Path Parameters

Query Parameters

Response

200 OK

{
  "financialAccountId": "fa_abc123def456",
  "userProfileId": 78901,
  "name": "Compliance Hold Account",
  "accountNumber": "XXXXXXXXXX",
  "routingNumber": "021000021",
  "status": "ACTIVE",
  "availableCash": 0,
  "created": "2026-06-09T10:30:00Z",
  "cardProfileSets": [],
  "cardProduct": {
    "name": "Netevia Business Card",
    "id": "cp_xyz789",
    "usage": "DEBIT"
  },
  "isLockBoxAccount": true
}

Error Codes

Common Mistakes

• Passing a non-integer value for profileId in the path — it must be a valid int32.
• Attempting to withdraw funds from a lockbox account as the customer — only the partner or administrator can initiate fund movements.
• Expecting the customer to have transfer rights on the returned account — they have view-only access to the balance.
• Omitting the Authorization: Bearer header or using an expired token, resulting in a 401 response.

Related Endpoints

• POST /netevia/financialAccount/{profileId} — Opens a standard (withdrawable) financial account for a customer profile.
• GET /netevia/financialAccount/{profileId} — Retrieves all financial accounts, including lockbox accounts, for a customer profile.
• POST /api/auth/v2 — Obtain a Bearer token for authentication.
• POST /api/auth/refresh — Refresh an expiring Bearer token.

Example

curl -X POST "https://api.banking.netevia.dev/netevia/lockboxfinancialAccount/78901?name=Compliance%20Hold%20Account" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"