Create Payees

Payees can also be added manually in the Payman Dashboard.

payee = payman.payments.create_payee(
    type="US_ACH",
    name="John Doe",
    account_holder_name="John Doe",
    account_holder_type="individual",
    account_number="1234567890",
    routing_number="011000138",
    account_type="checking",
    contact_details={
        "email": "[email protected]"
    }
)

print(f"Payee created: {payee.id}")

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

payee = payman.payments.create_payee(
    type="US_ACH",
    name="John Doe",
    account_holder_name="John Doe",
    account_holder_type="individual",
    account_number="1234567890",
    routing_number="011000138",
    account_type="checking",
    contact_details={
        "email": "[email protected]"
    }
)

print(f"Payee created: {payee.id}")

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

const payee = await payman.payments.createPayee({
    type: "US_ACH",
    name: "John Doe",
    accountHolderName: "John Doe",
    accountHolderType: "individual",
    accountNumber: "1234567890",
    routingNumber: "011000138",
    accountType: "checking",
    contactDetails: {
        email: "[email protected]"
    }
});

console.log(`Payee created: ${payee.id}`);

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:

{
  "id": "string",                 // Unique payee identifier (e.g., 'pd-1f001934-7...')
  "name": "string",               // User-assigned name of the payee
  "type": "US_ACH" | "CRYPTO_ADDRESS" | "PAYMAN_WALLET", // Type of payee
  "organizationId": "string",      // Your organization ID
  "status": "ACTIVE" | "DELETED", // Current status
  "contactDetails": {              // Optional contact information
    "email": "string",
    "phoneNumber": "string",
    "address": "string"
  },
  "tags": ["string"],               // Optional categorization tags
  "createdAt": "string",            // ISO timestamp of creation
  "updatedAt": "string",            // ISO timestamp of last update
  "createdBy": "string",            // ID of the creator
  "updatedBy": "string",            // ID of the last updater
  "payeeDetails": {},                // Payee-specific details (varies by type)
  "searchHashes": {},                // Search optimization data
}

payee = payman.payments.create_payee(
    type="US_ACH",
    name="John Doe",
    account_holder_name="John Doe",
    account_holder_type="individual",
    account_number="1234567890",
    routing_number="011000138",
    account_type="checking",
    contact_details={
        "email": "[email protected]"
    }
)

print(f"Payee created: {payee.id}")

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

payee = payman.payments.create_payee(
    type="US_ACH",
    name="John Doe",
    account_holder_name="John Doe",
    account_holder_type="individual",
    account_number="1234567890",
    routing_number="011000138",
    account_type="checking",
    contact_details={
        "email": "[email protected]"
    }
)

print(f"Payee created: {payee.id}")

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

const payee = await payman.payments.createPayee({
    type: "US_ACH",
    name: "John Doe",
    accountHolderName: "John Doe",
    accountHolderType: "individual",
    accountNumber: "1234567890",
    routingNumber: "011000138",
    accountType: "checking",
    contactDetails: {
        email: "[email protected]"
    }
});

console.log(`Payee created: ${payee.id}`);

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:

{
  "id": "string",                 // Unique payee identifier (e.g., 'pd-1f001934-7...')
  "name": "string",               // User-assigned name of the payee
  "type": "US_ACH" | "CRYPTO_ADDRESS" | "PAYMAN_WALLET", // Type of payee
  "organizationId": "string",      // Your organization ID
  "status": "ACTIVE" | "DELETED", // Current status
  "contactDetails": {              // Optional contact information
    "email": "string",
    "phoneNumber": "string",
    "address": "string"
  },
  "tags": ["string"],               // Optional categorization tags
  "createdAt": "string",            // ISO timestamp of creation
  "updatedAt": "string",            // ISO timestamp of last update
  "createdBy": "string",            // ID of the creator
  "updatedBy": "string",            // ID of the last updater
  "payeeDetails": {},                // Payee-specific details (varies by type)
  "searchHashes": {},                // Search optimization data
}

payee = payman.payments.create_payee(
    type="CRYPTO_ADDRESS",
    name="Crypto Wallet",
    address="0x123abc456def789ghi",
    chain="ethereum",
    currency="USDC",
    contact_details={
        "email": "[email protected]"
    },
    tags=["crypto", "eth"]
)

print(f"Payee created: {payee.id}")

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

payee = payman.payments.create_payee(
    type="CRYPTO_ADDRESS",
    name="Crypto Wallet",
    address="0x123abc456def789ghi",
    chain="ethereum",
    currency="USDC",
    contact_details={
        "email": "[email protected]"
    },
    tags=["crypto", "eth"]
)

print(f"Payee created: {payee.id}")

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

const payee = await payman.payments.createPayee({
    type: "CRYPTO_ADDRESS",
    name: "Crypto Wallet",
    address: "0x123abc456def789ghi",
    chain: "ethereum",
    currency: "USDC",
    contactDetails: {
        email: "[email protected]"
    },
    tags: ["crypto", "eth"]
});

console.log(`Payee created: ${payee.id}`);

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:

{
  "id": "string",                 // Unique payee identifier (e.g., 'pd-1f001934-7...')
  "name": "string",               // User-assigned name of the payee
  "type": "US_ACH" | "CRYPTO_ADDRESS" | "PAYMAN_WALLET", // Type of payee
  "organizationId": "string",      // Your organization ID
  "status": "ACTIVE" | "DELETED", // Current status
  "contactDetails": {              // Optional contact information
    "email": "string",
    "phoneNumber": "string",
    "address": "string"
  },
  "tags": ["string"],               // Optional categorization tags
  "createdAt": "string",            // ISO timestamp of creation
  "updatedAt": "string",            // ISO timestamp of last update
  "createdBy": "string",            // ID of the creator
  "updatedBy": "string",            // ID of the last updater
  "payeeDetails": {},                // Payee-specific details (varies by type)
  "searchHashes": {},                // Search optimization data
}

payee = payman.payments.create_payee(
    type="PAYMAN_WALLET",
    name= "Agent Wallet"// This can be anything, according to your requirements,
    payman_wallet_paytag="mean.shop.apron/15",
)

print(f"Payee created: {payee.id}")

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

payee = payman.payments.create_payee(
    type="PAYMAN_WALLET",
    name= "Agent Wallet"// This can be anything, according to your requirements,
    payman_wallet_paytag="mean.shop.apron/15",
)

print(f"Payee created: {payee.id}")

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

const payee = await payman.payments.createPayee({
    type: "PAYMAN_WALLET",
    name: "Agent Wallet"// This can be anything, according to your requirements,
    paymanWalletPaytag: "mean.shop.apron/15",
});

console.log(`Payee created: ${payee.id}`);

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

Example PAYMAN_WALLET Payee Response

{
  "id": "pd-1f014a03-035d-61b5-b3a6-3b7603b9cbdf",
  "name": "Agent Wallet",
  "type": "PAYMAN_WALLET",
  "organizationId": "org-1f0149e6-9697-6153-b3a6-3b7603b9cbdf",
  "status": "ACTIVE",
  "tags": [],
  "createdAt": "2025-04-08T17:37:48.469626Z",
  "updatedAt": "2025-04-08T17:37:48.469626Z",
  "createdBy": "usr-1efd817d-8b4b-61d5-b624-3d5e74f0218c",
  "updatedBy": "usr-1efd817d-8b4b-61d5-b624-3d5e74f0218c",
  "payeeDetails": {
    "payman-wallet-paytag": "mean.shop.apron/15",
    "payman-wallet-name": "Agent Wallet",
    "payman-wallet-provider": "STRIPE",
    "payman-wallet-id": "wlt-1f014a01-844a-6b2c-b3a6-3b7603b9cbdf",
    "payman-wallet-org-name": "org-1f0149e6-9697-6153-b3a6-3b7603b9cbdf"
  },
  "searchHashes": {
    "payman-wallet-id": "754dd24f37ca54de37e47528b15af413",
    "payman-wallet-name": "cdd3c721669aa64061e3740bf9ad5f52",
    "payman-wallet-paytag": "c126d78d6b06c90dddc6f397d4f1257f",
    "payman-wallet-org-name": "98206de2eb7f683ca99db9befeb09130",
    "payman-wallet-provider": "8a98c86b49d93794705dd64bcdbbe3ab"
  }
}

Overview

For Developers

Guides

APIs

API Endpoints

Parameters

Parameters

Parameters

Response

Parameters

Parameters

Parameters

Response

Parameters

Parameters

Parameters

Response

Parameters

Parameters

Parameters

Example PAYMAN_WALLET Payee Response

Overview

For Developers

Guides

APIs

API Endpoints

​Parameters

​Parameters

​Parameters

​Response

​Parameters

​Parameters

​Parameters

​Response

​Parameters

​Parameters

​Parameters

​Response

​Parameters

​Parameters

​Parameters

​Example PAYMAN_WALLET Payee Response

Parameters

Parameters

Parameters

Response

Parameters

Parameters

Parameters

Response

Parameters

Parameters

Parameters

Response

Parameters

Parameters

Parameters

Example PAYMAN_WALLET Payee Response