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

Response

Returns the newly created payer object with:

Unique payer ID
All provided information
Timestamps for creation and last update

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 ## Response Returns the newly created payer object with: - Unique payer ID - All provided information - Timestamps for creation and last update

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Request

This endpoint expects an object.

namestringRequired1-255 characters

emailstringRequiredformat: "email"<=255 characters

country_codeenumOptional

country_sub_divisionstring or nullOptional<=35 characters

State, province, or country subdivision

citystring or nullOptional<=35 characters

City or town name

address_linestring or nullOptional<=500 characters

Street address, building number, postal code, etc.

postal_codestring or nullOptional<=16 characters

Zip or postal code

metadatamap from strings to strings or nullOptional

Response

Payer created successfully

dataobject

warningstring or null

$	curl -X POST https://api.useroot.com/api/payers \
>	-H "x-api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "John Doe",
>	"email": "john.doe@company.com",
>	"country_code": "US",
>	"country_sub_division": "NY",
>	"city": "New York",
>	"address_line": "123 Main Street, Apt 4B",
>	"postal_code": "10001"
>	}'

1	{
2	"data": {
3	"created_at": "2024-03-20T12:00:00Z",
4	"updated_at": "2024-03-20T12:00:00Z",
5	"id": "123e4567-e89b-12d3-a456-426614174000",
6	"name": "John Doe",
7	"email": "john.doe@company.com",
8	"country_code": "US",
9	"country_sub_division": "NY",
10	"city": "New York",
11	"address_line": "123 Main Street, Apt 4B",
12	"postal_code": "10001"
13	}
14	}