Create a new payee
Creates a new payee with the provided information. Email must be unique within the entity.
Request Body
Name rules
name may contain only:
- Letters
A–Zanda–z - Characters in Unicode range U+00C0–U+017F: accented Latin letters (for example
é,ñ,ü,ł), plus×and÷ - Digits
0–9 - Spaces, hyphens (
-), underscores (_), and straight apostrophes (')
Any other character is rejected, including &, ,, ., /, (, ), en dash (–), em dash (—), and curly apostrophe (’). For example, O'Brien and José Núñez are accepted. Smith & Sons, LLC and Ana–María are rejected. To send a business name, remove or replace the punctuation (for example, Smith and Sons LLC).
Leading and trailing spaces are removed, and runs of whitespace become one space, before the name is checked and stored.
Email rules
email must be a valid address, and it must be unique among your payees. Addresses on special-use domains are rejected: .arpa, .invalid, .local, .localhost, .onion, and .test. In the test environment, use an address on a real domain that you control.
Success Responses
Error Responses
Example: duplicate email (409)
Example: name not allowed (422)
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.