Create a new payer
Create a new payer in the system.
A payer is an entity that sends money to your platform via ACH debit transactions. Each payer must have a unique email address within your organization.
Required Information
When creating a payer, you must provide:
- Email: Must be unique within your organization
- Name: Full name of the payer
Validation
name and email follow the same rules as Create a new payee:
- Name: letters
A–Zanda–z, characters in U+00C0–U+017F (accented Latin letters such asé,ñ,ü, plus×and÷), digits, spaces, hyphens (-), underscores (_), and straight apostrophes ('). Any other character is rejected, including&,,,.,/,(,), en and em dashes, and curly apostrophes (’). Leading and trailing spaces are removed, and runs of whitespace become one space. - Email: must be a valid address. Addresses on special-use domains are rejected:
.arpa,.invalid,.local,.localhost,.onion, and.test.
Response
Returns the newly created payer object with:
- Unique payer ID
- All provided information
- Timestamps for creation and last update
Errors
Authentication
RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.
Request
Name may contain only letters A-Z and a-z, characters in U+00C0-U+017F (accented Latin letters such as é, ñ, ü, ł, plus × and ÷), digits, spaces, hyphens (-), underscores (_), and straight apostrophes (’). Other punctuation, such as & , . / ( ), en or em dashes, and curly apostrophes (’), is not allowed.
Must be a valid email address. Special-use domains are rejected: .arpa, .invalid, .local, .localhost, .onion, and .test.