Create Payees
Your AI Agent can add approved payees it can send money to - humans, AI agents, crypto wallets, or other Payman wallets
Payees can also be added manually in the Payman Dashboard.
Use the returned id
when sending payments to this payee. You can also find payee IDs in the Payman Dashboard.
Parameters
Parameter | Type | Description |
---|---|---|
type | str | Must be 'US_ACH' |
name | str | Descriptive name |
account_holder_name | str | Legal name on account |
account_holder_type | str | 'individual' or 'business' |
account_number | str | Bank account number |
routing_number | str | 9-digit ABA number (check here) |
account_type | str | 'checking' or 'savings' |
contact_details | dict | Optional contact information |
tags | list[str] | Optional labels |
Use the returned id
when sending payments to this payee. You can also find payee IDs in the Payman Dashboard.
Parameters
Parameter | Type | Description |
---|---|---|
type | str | Must be 'US_ACH' |
name | str | Descriptive name |
account_holder_name | str | Legal name on account |
account_holder_type | str | 'individual' or 'business' |
account_number | str | Bank account number |
routing_number | str | 9-digit ABA number (check here) |
account_type | str | 'checking' or 'savings' |
contact_details | dict | Optional contact information |
tags | list[str] | Optional labels |
Use the returned id
when sending payments to this payee. You can also find
payee IDs in the Payman Dashboard.
Parameters
Parameter | Type | Description |
---|---|---|
type | string | Must be 'US_ACH' |
name | string | Descriptive name |
accountHolderName | string | Legal name on account |
accountHolderType | string | 'individual' or 'business' |
accountNumber | string | Bank account number |
routingNumber | string | 9-digit ABA number |
accountType | string | 'checking' or 'savings' |
contactDetails | object | Optional contact information |
tags | string[] | Optional labels |
Response
Both SDKs return a similar response object:
Use the returned id
when sending payments to this payee. You can also find payee IDs in the Payman Dashboard.
Parameters
Parameter | Type | Description |
---|---|---|
type | str | Must be 'US_ACH' |
name | str | Descriptive name |
account_holder_name | str | Legal name on account |
account_holder_type | str | 'individual' or 'business' |
account_number | str | Bank account number |
routing_number | str | 9-digit ABA number (check here) |
account_type | str | 'checking' or 'savings' |
contact_details | dict | Optional contact information |
tags | list[str] | Optional labels |
Use the returned id
when sending payments to this payee. You can also find payee IDs in the Payman Dashboard.
Parameters
Parameter | Type | Description |
---|---|---|
type | str | Must be 'US_ACH' |
name | str | Descriptive name |
account_holder_name | str | Legal name on account |
account_holder_type | str | 'individual' or 'business' |
account_number | str | Bank account number |
routing_number | str | 9-digit ABA number (check here) |
account_type | str | 'checking' or 'savings' |
contact_details | dict | Optional contact information |
tags | list[str] | Optional labels |
Use the returned id
when sending payments to this payee. You can also find
payee IDs in the Payman Dashboard.
Parameters
Parameter | Type | Description |
---|---|---|
type | string | Must be 'US_ACH' |
name | string | Descriptive name |
accountHolderName | string | Legal name on account |
accountHolderType | string | 'individual' or 'business' |
accountNumber | string | Bank account number |
routingNumber | string | 9-digit ABA number |
accountType | string | 'checking' or 'savings' |
contactDetails | object | Optional contact information |
tags | string[] | Optional labels |
Response
Both SDKs return a similar response object:
Use the returned id
when sending payments to this payee. You can also find payee IDs in the Payman Dashboard.
Parameters
Parameter | Type | Description |
---|---|---|
type | str | Must be 'CRYPTO_ADDRESS' |
name | str | Descriptive name |
address | str | The cryptocurrency address to send funds to |
chain | str | The blockchain to use for the transaction (e.g., 'ethereum' , 'polygon' ) |
currency | str | 'USDC' - currency/token to use for the transaction |
contact_details | dict | Optional contact information |
tags | list[str] | Optional labels |
Use the returned id
when sending payments to this payee. You can also find payee IDs in the Payman Dashboard.
Parameters
Parameter | Type | Description |
---|---|---|
type | str | Must be 'CRYPTO_ADDRESS' |
name | str | Descriptive name |
address | str | The cryptocurrency address to send funds to |
chain | str | The blockchain to use for the transaction (e.g., 'ethereum' , 'polygon' ) |
currency | str | 'USDC' - currency/token to use for the transaction |
contact_details | dict | Optional contact information |
tags | list[str] | Optional labels |
Use the returned id
when sending payments to this payee. You can also find
payee IDs in the Payman Dashboard.
Parameters
Parameter | Type | Description |
---|---|---|
type | string | Must be 'CRYPTO_ADDRESS' |
name | string | Descriptive name |
address | string | The cryptocurrency address to send funds to |
chain | string | The blockchain to use for the transaction (e.g., 'ethereum' , 'polygon' ) |
currency | string | The currency/token to use for the transaction (e.g., 'USDC' , 'ETH' ) |
contactDetails | object | Optional contact information |
tags | string[] | Optional labels |
Response
Both SDKs return a similar response object:
Use the returned id
when sending payments to this payee. You can also find payee IDs in the Payman Dashboard.
Parameters
Parameter | Type | Description |
---|---|---|
type | str | Must be 'PAYMAN_WALLET' |
name | str | Descriptive name for the payee |
payman_wallet_paytag | str | The paytag of the destination wallet |
tags | list[str] | Optional labels |
Use the returned id
when sending payments to this payee. You can also find payee IDs in the Payman Dashboard.
Parameters
Parameter | Type | Description |
---|---|---|
type | str | Must be 'PAYMAN_WALLET' |
name | str | Descriptive name for the payee |
payman_wallet_paytag | str | The paytag of the destination wallet |
tags | list[str] | Optional labels |
Use the returned id
when sending payments to this payee. You can also find
payee IDs in the Payman Dashboard.
Parameters
Parameter | Type | Description |
---|---|---|
type | string | Must be 'PAYMAN_WALLET' |
name | string | Descriptive name for the payee |
paymanWalletPaytag | string | The paytag of the destination wallet |
tags | string[] | Optional labels |