GET
/
api
/
platform
/
accounts
/
list
/
{user_id}
List all bank accounts
curl --request GET \
  --url https://api.sandbox.paywint.com/api/platform/accounts/list/{user_id} \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>'
{
  "success": true,
  "status_code": 123,
  "message": "<string>",
  "records": [
    {
      "id": "5bf6f0d6-0677-4607-9541-68ef7faecbdb",
      "bank_nick_name": "Personal Checking",
      "account_number": "6789",
      "account_balance": 1000,
      "routing_number": "011000015",
      "account_type": "CHECKING",
      "bank_name": "First National Bank",
      "account_holder_name": "John Doe",
      "verification_status": "not_applied",
      "verification_type": "MD",
      "is_verified": false,
      "is_default": true,
      "created_at": "2025-06-16T12:03:48.726826Z"
    }
  ],
  "totalRecords": 123,
  "queryGeneratedTime": 123
}

Headers

X-Platform-ID
string<uuid>
required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

X-Signature
string
required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Path Parameters

user_id
string<uuid>
required

Unique identifier (UUID) of the user whose bank accounts are being retrieved.

Response

Successful Response

success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

status_code
integer | null
default:200

HTTP status code representing the result of the request.

message
string | null
default:Success

Short, human-readable message describing the outcome of the request.

records
PlatformBankAccountRead · object[] | null

List of result items returned for the current page.

totalRecords
integer | null
default:0

Total number of matching records in the database, useful for paginating the full dataset.

queryGeneratedTime
integer | null
default:1756883312

Unix timestamp (in seconds) indicating when this response was generated.