Bank Accounts

Manage the bank accounts used for slip verification matching.

All endpoints are authenticated with your branch API key and scoped to the calling branch: a branch can only see and manage its own bank accounts (an account is auto-linked to the branch that creates it). Accessing an account that is not linked to your branch returns 404.

Base URL

https://api.easyslip.com/v2

Authentication

Required. Uses the same branch API key as the slip verification endpoints. See Authentication Guide.

Authorization: Bearer YOUR_API_KEY

Scope

Rule	Behaviour
Per-branch visibility	A branch only sees its own accounts (auto-linked on create)
Cross-branch access	Accessing an account not linked to your branch returns 404
Service isolation	Accounts always belong to your own service
serviceId	Set server-side from the API key — you cannot set it in requests

Response Format

All responses follow the standard v2 envelope.

Success:

{
  "success": true,
  "data": { }
}

Error:

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message"
  }
}

Endpoints

Endpoint	Method	Description
/banks	GET	List supported banks
/bank-accounts	POST	Create a bank account
/bank-accounts	GET	List your branch's bank accounts
/bank-accounts/all	GET	List all accounts in your service
/bank-accounts/:id	GET	Get one bank account
/bank-accounts/:id	PATCH	Update a bank account
/bank-accounts/:id/link	POST	Link an account to your branch
/bank-accounts/:id/link	DELETE	Unlink an account from your branch

No delete-account endpoint

There is intentionally no endpoint to delete a bank account. Accounts are soft-managed.

Typical Flow

1. Call GET /banks to pick a valid bankCode.
2. Call POST /bank-accounts to create an account — it is auto-linked to the calling branch and visible immediately.
3. Use GET /bank-accounts and GET /bank-accounts/:id to read them back.
4. Unlink an account to remove it from your branch's list; find it again later with GET /bank-accounts/all and link it back.

Error Codes

Code	HTTP Status	Description
VALIDATION_ERROR	400	Invalid request body or query parameters
INVALID_BANK_CODE	400	bankCode is not in the supported bank list
INVALID_EXTRA_VERIFY	400	extraVerify is not a valid option for the bank (or is required by the new bank on a bankCode change but was not provided)
BANK_ACCOUNT_NOT_FOUND	404	Account does not exist or is not linked to your branch
BANK_ACCOUNT_DUPLICATE	409	An active account with the same bankCode + bankNumber already exists for your service

Standard authentication errors (MISSING_API_KEY, INVALID_API_KEY, SERVICE_EXPIRED, IP_NOT_ALLOWED, …) also apply. See Error Codes Reference.