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

ParameterTypeDescription
typestrMust be 'US_ACH'
namestrDescriptive name
account_holder_namestrLegal name on account
account_holder_typestr'individual' or 'business'
account_numberstrBank account number
routing_numberstr9-digit ABA number (check here)
account_typestr'checking' or 'savings'
contact_detailsdictOptional contact information
tagslist[str]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", // 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
}