POST
/
api
/
platform
/
accounts
/
add-payee-account
/
{user_id}
Add payee account
curl --request POST \
  --url https://api.sandbox.paywint.com/api/platform/accounts/add-payee-account/{user_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '{
  "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "account_holder_name": "John A. Doe",
  "account_type": "PERSONAL_CHECKING",
  "bank_nick_name": "Personal Checking - Wells Fargo",
  "account_number": "62**56**90**75",
  "routing_number": "021****21"
}'
{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "account_holder_name": "John A. Doe",
    "account_type": "PERSONAL_CHECKING",
    "bank_nick_name": "Personal Bank",
    "account_number": "62**56**90**75",
    "routing_number": "021****21"
  },
  "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
​
payee_id
string<uuid4>
required

Unique identifier (UUID) of the payee to whom this bank account belongs.

Example:

"f47ac10b-****-****-****-0e02b2c3d479"

​
account_holder_name
string
required

Full name of the account holder as it appears on the bank account.

Maximum length: 100
Example:

"John A. Doe"

​
account_type
enum<string>
required

Type of account used to classify personal or business checking/savings.

Available options:
PERSONAL_SAVINGS,
BUSINESS_SAVINGS,
BUSINESS_CHECKING,
PERSONAL_CHECKING
​
bank_nick_name
string
required

User-defined nickname to help identify this bank account (e.g., 'Payroll Account').

Maximum length: 100
Example:

"Personal Checking - Wells Fargo"

​
account_number
string
required

Actual bank account number. Must be a valid number and stored securely.

Maximum length: 20
Example:

"62**56**90**75"

​
routing_number
string
required

9-digit ABA routing number of the financial institution.

Maximum length: 9
Example:

"021****21"

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
object | null

The main response payload, if applicable

​
queryGeneratedTime
number | null
default:1756883312.350897

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

Example:

1718006400