Add Bank Account

Create Bank

curl --request POST \
  --url https://api.paywint.com/api/platform/accounts/add-account \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '
{
  "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "account_holder_name": "John D. Doe",
  "bank_name": "Bank of America",
  "nick_name": "Business Wallet Account",
  "account_number": "1234567890",
  "routing_number": "021000021",
  "bank_address": "123 Bank Street",
  "city": "New York",
  "state": "NY",
  "zip": "10001",
  "country": "US",
  "account_type": "CHECKING",
  "account_holder_address": "123 Main Street",
  "account_holder_city": "New York",
  "account_holder_state": "NY",
  "account_holder_zip": "10001",
  "account_holder_country": "US",
  "is_default": true
}
'

import requests

url = "https://api.paywint.com/api/platform/accounts/add-account"

payload = {
    "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "account_holder_name": "John D. Doe",
    "bank_name": "Bank of America",
    "nick_name": "Business Wallet Account",
    "account_number": "1234567890",
    "routing_number": "021000021",
    "bank_address": "123 Bank Street",
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "US",
    "account_type": "CHECKING",
    "account_holder_address": "123 Main Street",
    "account_holder_city": "New York",
    "account_holder_state": "NY",
    "account_holder_zip": "10001",
    "account_holder_country": "US",
    "is_default": True
}
headers = {
    "X-Platform-ID": "<x-platform-id>",
    "X-Signature": "<x-signature>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Platform-ID': '<x-platform-id>',
    'X-Signature': '<x-signature>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    user_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    account_holder_name: 'John D. Doe',
    bank_name: 'Bank of America',
    nick_name: 'Business Wallet Account',
    account_number: '1234567890',
    routing_number: '021000021',
    bank_address: '123 Bank Street',
    city: 'New York',
    state: 'NY',
    zip: '10001',
    country: 'US',
    account_type: 'CHECKING',
    account_holder_address: '123 Main Street',
    account_holder_city: 'New York',
    account_holder_state: 'NY',
    account_holder_zip: '10001',
    account_holder_country: 'US',
    is_default: true
  })
};

fetch('https://api.paywint.com/api/platform/accounts/add-account', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paywint.com/api/platform/accounts/add-account",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'user_id' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    'account_holder_name' => 'John D. Doe',
    'bank_name' => 'Bank of America',
    'nick_name' => 'Business Wallet Account',
    'account_number' => '1234567890',
    'routing_number' => '021000021',
    'bank_address' => '123 Bank Street',
    'city' => 'New York',
    'state' => 'NY',
    'zip' => '10001',
    'country' => 'US',
    'account_type' => 'CHECKING',
    'account_holder_address' => '123 Main Street',
    'account_holder_city' => 'New York',
    'account_holder_state' => 'NY',
    'account_holder_zip' => '10001',
    'account_holder_country' => 'US',
    'is_default' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Platform-ID: <x-platform-id>",
    "X-Signature: <x-signature>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paywint.com/api/platform/accounts/add-account"

	payload := strings.NewReader("{\n  \"user_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"account_holder_name\": \"John D. Doe\",\n  \"bank_name\": \"Bank of America\",\n  \"nick_name\": \"Business Wallet Account\",\n  \"account_number\": \"1234567890\",\n  \"routing_number\": \"021000021\",\n  \"bank_address\": \"123 Bank Street\",\n  \"city\": \"New York\",\n  \"state\": \"NY\",\n  \"zip\": \"10001\",\n  \"country\": \"US\",\n  \"account_type\": \"CHECKING\",\n  \"account_holder_address\": \"123 Main Street\",\n  \"account_holder_city\": \"New York\",\n  \"account_holder_state\": \"NY\",\n  \"account_holder_zip\": \"10001\",\n  \"account_holder_country\": \"US\",\n  \"is_default\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Platform-ID", "<x-platform-id>")
	req.Header.Add("X-Signature", "<x-signature>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.paywint.com/api/platform/accounts/add-account")
  .header("X-Platform-ID", "<x-platform-id>")
  .header("X-Signature", "<x-signature>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"account_holder_name\": \"John D. Doe\",\n  \"bank_name\": \"Bank of America\",\n  \"nick_name\": \"Business Wallet Account\",\n  \"account_number\": \"1234567890\",\n  \"routing_number\": \"021000021\",\n  \"bank_address\": \"123 Bank Street\",\n  \"city\": \"New York\",\n  \"state\": \"NY\",\n  \"zip\": \"10001\",\n  \"country\": \"US\",\n  \"account_type\": \"CHECKING\",\n  \"account_holder_address\": \"123 Main Street\",\n  \"account_holder_city\": \"New York\",\n  \"account_holder_state\": \"NY\",\n  \"account_holder_zip\": \"10001\",\n  \"account_holder_country\": \"US\",\n  \"is_default\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paywint.com/api/platform/accounts/add-account")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Platform-ID"] = '<x-platform-id>'
request["X-Signature"] = '<x-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"account_holder_name\": \"John D. Doe\",\n  \"bank_name\": \"Bank of America\",\n  \"nick_name\": \"Business Wallet Account\",\n  \"account_number\": \"1234567890\",\n  \"routing_number\": \"021000021\",\n  \"bank_address\": \"123 Bank Street\",\n  \"city\": \"New York\",\n  \"state\": \"NY\",\n  \"zip\": \"10001\",\n  \"country\": \"US\",\n  \"account_type\": \"CHECKING\",\n  \"account_holder_address\": \"123 Main Street\",\n  \"account_holder_city\": \"New York\",\n  \"account_holder_state\": \"NY\",\n  \"account_holder_zip\": \"10001\",\n  \"account_holder_country\": \"US\",\n  \"is_default\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "account_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"
  },
  "queryGeneratedTime": 1718006400
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

api

platform

accounts

add-account

Create Bank

curl --request POST \
  --url https://api.paywint.com/api/platform/accounts/add-account \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '
{
  "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "account_holder_name": "John D. Doe",
  "bank_name": "Bank of America",
  "nick_name": "Business Wallet Account",
  "account_number": "1234567890",
  "routing_number": "021000021",
  "bank_address": "123 Bank Street",
  "city": "New York",
  "state": "NY",
  "zip": "10001",
  "country": "US",
  "account_type": "CHECKING",
  "account_holder_address": "123 Main Street",
  "account_holder_city": "New York",
  "account_holder_state": "NY",
  "account_holder_zip": "10001",
  "account_holder_country": "US",
  "is_default": true
}
'

import requests

url = "https://api.paywint.com/api/platform/accounts/add-account"

payload = {
    "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "account_holder_name": "John D. Doe",
    "bank_name": "Bank of America",
    "nick_name": "Business Wallet Account",
    "account_number": "1234567890",
    "routing_number": "021000021",
    "bank_address": "123 Bank Street",
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "US",
    "account_type": "CHECKING",
    "account_holder_address": "123 Main Street",
    "account_holder_city": "New York",
    "account_holder_state": "NY",
    "account_holder_zip": "10001",
    "account_holder_country": "US",
    "is_default": True
}
headers = {
    "X-Platform-ID": "<x-platform-id>",
    "X-Signature": "<x-signature>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Platform-ID': '<x-platform-id>',
    'X-Signature': '<x-signature>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    user_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    account_holder_name: 'John D. Doe',
    bank_name: 'Bank of America',
    nick_name: 'Business Wallet Account',
    account_number: '1234567890',
    routing_number: '021000021',
    bank_address: '123 Bank Street',
    city: 'New York',
    state: 'NY',
    zip: '10001',
    country: 'US',
    account_type: 'CHECKING',
    account_holder_address: '123 Main Street',
    account_holder_city: 'New York',
    account_holder_state: 'NY',
    account_holder_zip: '10001',
    account_holder_country: 'US',
    is_default: true
  })
};

fetch('https://api.paywint.com/api/platform/accounts/add-account', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paywint.com/api/platform/accounts/add-account",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'user_id' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    'account_holder_name' => 'John D. Doe',
    'bank_name' => 'Bank of America',
    'nick_name' => 'Business Wallet Account',
    'account_number' => '1234567890',
    'routing_number' => '021000021',
    'bank_address' => '123 Bank Street',
    'city' => 'New York',
    'state' => 'NY',
    'zip' => '10001',
    'country' => 'US',
    'account_type' => 'CHECKING',
    'account_holder_address' => '123 Main Street',
    'account_holder_city' => 'New York',
    'account_holder_state' => 'NY',
    'account_holder_zip' => '10001',
    'account_holder_country' => 'US',
    'is_default' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Platform-ID: <x-platform-id>",
    "X-Signature: <x-signature>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paywint.com/api/platform/accounts/add-account"

	payload := strings.NewReader("{\n  \"user_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"account_holder_name\": \"John D. Doe\",\n  \"bank_name\": \"Bank of America\",\n  \"nick_name\": \"Business Wallet Account\",\n  \"account_number\": \"1234567890\",\n  \"routing_number\": \"021000021\",\n  \"bank_address\": \"123 Bank Street\",\n  \"city\": \"New York\",\n  \"state\": \"NY\",\n  \"zip\": \"10001\",\n  \"country\": \"US\",\n  \"account_type\": \"CHECKING\",\n  \"account_holder_address\": \"123 Main Street\",\n  \"account_holder_city\": \"New York\",\n  \"account_holder_state\": \"NY\",\n  \"account_holder_zip\": \"10001\",\n  \"account_holder_country\": \"US\",\n  \"is_default\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Platform-ID", "<x-platform-id>")
	req.Header.Add("X-Signature", "<x-signature>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.paywint.com/api/platform/accounts/add-account")
  .header("X-Platform-ID", "<x-platform-id>")
  .header("X-Signature", "<x-signature>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"account_holder_name\": \"John D. Doe\",\n  \"bank_name\": \"Bank of America\",\n  \"nick_name\": \"Business Wallet Account\",\n  \"account_number\": \"1234567890\",\n  \"routing_number\": \"021000021\",\n  \"bank_address\": \"123 Bank Street\",\n  \"city\": \"New York\",\n  \"state\": \"NY\",\n  \"zip\": \"10001\",\n  \"country\": \"US\",\n  \"account_type\": \"CHECKING\",\n  \"account_holder_address\": \"123 Main Street\",\n  \"account_holder_city\": \"New York\",\n  \"account_holder_state\": \"NY\",\n  \"account_holder_zip\": \"10001\",\n  \"account_holder_country\": \"US\",\n  \"is_default\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paywint.com/api/platform/accounts/add-account")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Platform-ID"] = '<x-platform-id>'
request["X-Signature"] = '<x-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"account_holder_name\": \"John D. Doe\",\n  \"bank_name\": \"Bank of America\",\n  \"nick_name\": \"Business Wallet Account\",\n  \"account_number\": \"1234567890\",\n  \"routing_number\": \"021000021\",\n  \"bank_address\": \"123 Bank Street\",\n  \"city\": \"New York\",\n  \"state\": \"NY\",\n  \"zip\": \"10001\",\n  \"country\": \"US\",\n  \"account_type\": \"CHECKING\",\n  \"account_holder_address\": \"123 Main Street\",\n  \"account_holder_city\": \"New York\",\n  \"account_holder_state\": \"NY\",\n  \"account_holder_zip\": \"10001\",\n  \"account_holder_country\": \"US\",\n  \"is_default\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "account_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"
  },
  "queryGeneratedTime": 1718006400
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Headers

Idempotency-Key

string | null

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.

Body

application/json

user_id

string<uuid>

required

UUID of the user to whom this bank account belongs

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

account_holder_name

string

required

Name of the account holder (optional, will use user name if not provided)

Maximum string length: 100

Example:

"John D. Doe"

bank_name

string

required

Full name of the bank

Maximum string length: 100

Example:

"Bank of America"

nick_name

string

required

Optional nickname to identify the account (e.g., 'Personal Checking')

Maximum string length: 100

Example:

"Business Wallet Account"

account_number

string

required

Bank account number

Maximum string length: 20

Example:

"1234567890"

routing_number

string

required

Bank routing number for ACH transactions

Maximum string length: 9

Example:

"021000021"

bank_address

string

required

Street address of the bank

Maximum string length: 300

Example:

"123 Bank Street"

city

string

required

City of the bank

Maximum string length: 50

Example:

"New York"

state

string

required

State of the bank

Maximum string length: 50

Example:

"NY"

zip

string

required

Postal code of the bank

Maximum string length: 10

Example:

"10001"

country

string

required

Country of the bank

Maximum string length: 50

Example:

"US"

account_type

enum<string>

required

Type of the bank account (e.g., CHECKING, SAVINGS, BUSINESS)

Available options:

PERSONAL_SAVINGS,

BUSINESS_SAVINGS,

BUSINESS_CHECKING,

PERSONAL_CHECKING,

PAYWINT_SAVINGS,

PAYWINT_BUSINESS

Example:

"CHECKING"

account_holder_address

string | null

Street address of the account holder

Maximum string length: 500

Example:

"123 Main Street"

account_holder_city

string | null

City of the account holder

Maximum string length: 50

Example:

"New York"

account_holder_state

string | null

State of the account holder

Maximum string length: 50

Example:

"NY"

account_holder_zip

string | null

Postal code of the account holder

Maximum string length: 50

Example:

"10001"

account_holder_country

string | null

Country of the account holder

Maximum string length: 50

Example:

"US"

is_default

boolean

default:true

Set this account as user's default

Example:

true

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

PlatformBankAccountRead · object | null

The main response payload, if applicable

Show child attributes

queryGeneratedTime

number | null

default:1783679844.273462

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

Example:

1718006400

Users

KYC & KYB

Wallet

Payments

Accept Payments

Cross Border Payments

Bank Accounts

Paywint Bank Accounts

Cards

Check

Payee Management

Payee Bank Accounts

Payee Cards

Payee Addresses

Headers

Body

Response