Add Payee Bank Account

Add payee account

curl --request POST \
  --url https://api.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",
  "account_holder_address": "123 Main St",
  "account_holder_city": "New York",
  "account_holder_state": "NY",
  "account_holder_zip": "10001",
  "account_holder_country": "US"
}
'

import requests

url = "https://api.paywint.com/api/platform/accounts/add-payee-account/{user_id}"

payload = {
    "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",
    "account_holder_address": "123 Main St",
    "account_holder_city": "New York",
    "account_holder_state": "NY",
    "account_holder_zip": "10001",
    "account_holder_country": "US"
}
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({
    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',
    account_holder_address: '123 Main St',
    account_holder_city: 'New York',
    account_holder_state: 'NY',
    account_holder_zip: '10001',
    account_holder_country: 'US'
  })
};

fetch('https://api.paywint.com/api/platform/accounts/add-payee-account/{user_id}', 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-payee-account/{user_id}",
  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([
    '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',
    'account_holder_address' => '123 Main St',
    'account_holder_city' => 'New York',
    'account_holder_state' => 'NY',
    'account_holder_zip' => '10001',
    'account_holder_country' => 'US'
  ]),
  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-payee-account/{user_id}"

	payload := strings.NewReader("{\n  \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"account_holder_name\": \"John A. Doe\",\n  \"account_type\": \"PERSONAL_CHECKING\",\n  \"bank_nick_name\": \"Personal Checking - Wells Fargo\",\n  \"account_number\": \"62**56**90**75\",\n  \"routing_number\": \"021****21\",\n  \"account_holder_address\": \"123 Main St\",\n  \"account_holder_city\": \"New York\",\n  \"account_holder_state\": \"NY\",\n  \"account_holder_zip\": \"10001\",\n  \"account_holder_country\": \"US\"\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-payee-account/{user_id}")
  .header("X-Platform-ID", "<x-platform-id>")
  .header("X-Signature", "<x-signature>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"account_holder_name\": \"John A. Doe\",\n  \"account_type\": \"PERSONAL_CHECKING\",\n  \"bank_nick_name\": \"Personal Checking - Wells Fargo\",\n  \"account_number\": \"62**56**90**75\",\n  \"routing_number\": \"021****21\",\n  \"account_holder_address\": \"123 Main St\",\n  \"account_holder_city\": \"New York\",\n  \"account_holder_state\": \"NY\",\n  \"account_holder_zip\": \"10001\",\n  \"account_holder_country\": \"US\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"account_holder_name\": \"John A. Doe\",\n  \"account_type\": \"PERSONAL_CHECKING\",\n  \"bank_nick_name\": \"Personal Checking - Wells Fargo\",\n  \"account_number\": \"62**56**90**75\",\n  \"routing_number\": \"021****21\",\n  \"account_holder_address\": \"123 Main St\",\n  \"account_holder_city\": \"New York\",\n  \"account_holder_state\": \"NY\",\n  \"account_holder_zip\": \"10001\",\n  \"account_holder_country\": \"US\"\n}"

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

{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "payee_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",
    "account_holder_address": "123 Main St",
    "account_holder_city": "New York",
    "account_holder_state": "NY",
    "account_holder_zip": "10001",
    "account_holder_country": "US"
  },
  "queryGeneratedTime": 1718006400
}

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

POST

api

platform

accounts

add-payee-account

{user_id}

Add payee account

curl --request POST \
  --url https://api.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",
  "account_holder_address": "123 Main St",
  "account_holder_city": "New York",
  "account_holder_state": "NY",
  "account_holder_zip": "10001",
  "account_holder_country": "US"
}
'

import requests

url = "https://api.paywint.com/api/platform/accounts/add-payee-account/{user_id}"

payload = {
    "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",
    "account_holder_address": "123 Main St",
    "account_holder_city": "New York",
    "account_holder_state": "NY",
    "account_holder_zip": "10001",
    "account_holder_country": "US"
}
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({
    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',
    account_holder_address: '123 Main St',
    account_holder_city: 'New York',
    account_holder_state: 'NY',
    account_holder_zip: '10001',
    account_holder_country: 'US'
  })
};

fetch('https://api.paywint.com/api/platform/accounts/add-payee-account/{user_id}', 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-payee-account/{user_id}",
  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([
    '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',
    'account_holder_address' => '123 Main St',
    'account_holder_city' => 'New York',
    'account_holder_state' => 'NY',
    'account_holder_zip' => '10001',
    'account_holder_country' => 'US'
  ]),
  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-payee-account/{user_id}"

	payload := strings.NewReader("{\n  \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"account_holder_name\": \"John A. Doe\",\n  \"account_type\": \"PERSONAL_CHECKING\",\n  \"bank_nick_name\": \"Personal Checking - Wells Fargo\",\n  \"account_number\": \"62**56**90**75\",\n  \"routing_number\": \"021****21\",\n  \"account_holder_address\": \"123 Main St\",\n  \"account_holder_city\": \"New York\",\n  \"account_holder_state\": \"NY\",\n  \"account_holder_zip\": \"10001\",\n  \"account_holder_country\": \"US\"\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-payee-account/{user_id}")
  .header("X-Platform-ID", "<x-platform-id>")
  .header("X-Signature", "<x-signature>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"account_holder_name\": \"John A. Doe\",\n  \"account_type\": \"PERSONAL_CHECKING\",\n  \"bank_nick_name\": \"Personal Checking - Wells Fargo\",\n  \"account_number\": \"62**56**90**75\",\n  \"routing_number\": \"021****21\",\n  \"account_holder_address\": \"123 Main St\",\n  \"account_holder_city\": \"New York\",\n  \"account_holder_state\": \"NY\",\n  \"account_holder_zip\": \"10001\",\n  \"account_holder_country\": \"US\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"account_holder_name\": \"John A. Doe\",\n  \"account_type\": \"PERSONAL_CHECKING\",\n  \"bank_nick_name\": \"Personal Checking - Wells Fargo\",\n  \"account_number\": \"62**56**90**75\",\n  \"routing_number\": \"021****21\",\n  \"account_holder_address\": \"123 Main St\",\n  \"account_holder_city\": \"New York\",\n  \"account_holder_state\": \"NY\",\n  \"account_holder_zip\": \"10001\",\n  \"account_holder_country\": \"US\"\n}"

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

{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "bank_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "payee_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",
    "account_holder_address": "123 Main St",
    "account_holder_city": "New York",
    "account_holder_state": "NY",
    "account_holder_zip": "10001",
    "account_holder_country": "US"
  },
  "queryGeneratedTime": 1718006400
}

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

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 string 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

Example:

"PERSONAL_CHECKING"

bank_nick_name

string

required

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

Maximum string length: 100

Example:

"Personal Checking - Wells Fargo"

account_number

string

required

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

Maximum string length: 20

Example:

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

routing_number

string

required

9-digit ABA routing number of the financial institution.

Maximum string length: 9

Example:

"021****21"

account_holder_address

string | null

Account holder address line 1 (required for RTP payouts).

Maximum string length: 500

Example:

"123 Main St"

account_holder_city

string | null

Account holder city (required for RTP payouts).

Maximum string length: 50

Example:

"New York"

account_holder_state

string | null

Account holder state (required for RTP payouts).

Maximum string length: 50

Example:

"NY"

account_holder_zip

string | null

Account holder ZIP/postal code (required for RTP payouts).

Maximum string length: 50

Example:

"10001"

account_holder_country

string | null

Account holder country (required for RTP payouts).

Maximum string length: 50

Example:

"US"

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

ExternalContactBankAccountRead · 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

Path Parameters

Body

Response