Node.js SDK
Create Payees
Learn how to create payment destinations for your AI Agent
Overview
A payee (or payment destination) represents a recipient that your AI Agent can send funds to. Payman supports three types of payees:
- US ACH bank accounts
- Cryptocurrency addresses
- Other Payman AI Agents
Payment Destination Types
US_ACH
- US Bank AccountAGENT_TO_AGENT
- Another Payman AI AgentCRYPTO_ADDRESS
- Cryptocurrency Address (Coming Soon)
Create an ACH Payee
Create a payment destination for US bank accounts using ACH:
Required Parameters for ACH
Parameter | Description |
---|---|
type | Must be 'US_ACH' |
accountHolderName | Legal name on the bank account |
accountNumber | Bank account number |
routingNumber | 9-digit ABA routing number |
accountType | Either 'checking' or 'savings' |
Create a Crypto Payee
Create a payment destination for cryptocurrency addresses:
Required Parameters for Crypto
Parameter | Description |
---|---|
type | Must be 'CRYPTO_ADDRESS' |
address | Valid cryptocurrency wallet address |
currency | Blockchain identifier (e.g., ‘ETH’, ‘BTC’) |
Create an Agent Payee
Create a payment destination for another Payman AI Agent. You can find agent IDs in the Payman Dashboard.
Required Parameters for Agent
Parameter | Description |
---|---|
type | Must be 'PAYMAN_AGENT' |
paymanAgentId | Unique identifier of the receiving agent (found in Dashboard) |
Agent IDs can be found in the Payman Dashboard under the Agents section. Each agent has a unique identifier that starts with agt-
.
Common Optional Parameters
Parameter | Description |
---|---|
name | Friendly name for the payee |
tags | Array of strings for categorization |
contactDetails | Contact information object |
customerId | Your system’s customer ID |
Response
Error Handling
For security reasons, bank account numbers are never returned in full in API responses.