Skip to main content
POST
/
api
/
platform
/
accounts
/
open-pw-bank-account
/
{user_id}
Open Paywint Bank Account
curl --request POST \
  --url http://localhost:8001/api/platform/accounts/open-pw-bank-account/{user_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '
{
  "bank_nick_name": "Personal Checking"
}
'
{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "account_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "bank_nick_name": "Personal Checking",
    "account_type": "PAYWINT_SAVINGS",
    "checkbook_user_id": "4f32b9e1-6f4a-4d5a-a495-2f7fdf4d4dd1",
    "created_at": "2025-08-07T14:32:00Z"
  },
  "queryGeneratedTime": 1718006400
}

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

Body

application/json
​
bank_nick_name
string
required

Unique nickname to easily identify the bank account.

Example:

"Personal Checking"

Response

Successful Response

​
success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

​
message
string
default:Success

A short, human-readable message describing the result of the request.

Example:

"Operation completed."

​
data
PlatformPaywintBankAccountRequestRead · object

The main response payload, if applicable

​
queryGeneratedTime
number | null
default:1782303609.673092

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

Example:

1718006400