Skip to main content
POST
/
payers
Create a payer
curl --request POST \
  --url https://api.withacclaim.com/v1/payers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "given_name": "John",
  "family_name": "Doe",
  "middle_name": "<string>",
  "name": "John Doe",
  "company_name": "Acme Corp",
  "email": "john.doe@example.com",
  "phone": "+15551234567",
  "tax_id": "12-3456789",
  "identifier": "PAYER-2025-001",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  }
}
'
{
  "id": "pyr_AbC123XyZ",
  "identifier": "PAYER-2025-001",
  "name": "John Doe",
  "given_name": "John",
  "family_name": "Doe",
  "middle_name": "<string>",
  "company_name": "Acme Corp",
  "email": "john.doe@example.com",
  "phone": "+15551234567",
  "tax_id": "12-3456789",
  "address": {
    "country": "US",
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001"
  },
  "metadata": {
    "custom_field": "value",
    "source": "api"
  },
  "created_at": "2025-10-08T18:20:31Z",
  "updated_at": "2025-10-08T18:25:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
given_name
string | null

First name

Required string length: 1 - 255
Example:

"John"

​
family_name
string | null

Last name

Required string length: 1 - 255
Example:

"Doe"

​
middle_name
string | null
Required string length: 1 - 255
​
name
string | null

Full name (overrides given_name/family_name if provided)

Required string length: 1 - 255
Example:

"John Doe"

​
company_name
string | null

Company name for business payers

Required string length: 1 - 255
Example:

"Acme Corp"

​
email
string<email> | null
Example:

"john.doe@example.com"

​
phone
string | null

E.164 formatted phone number

Example:

"+15551234567"

​
tax_id
string | null

Tax identification number

Required string length: 1 - 50
Example:

"12-3456789"

​
identifier
string | null

Custom identifier for the payer (auto-generated if not provided)

Required string length: 1 - 100
Example:

"PAYER-2025-001"

​
address
object
​
metadata
object

Optional metadata as key-value pairs

Example:
{ "custom_field": "value", "source": "api" }

Response

Payer created.

​
id
string
Example:

"pyr_AbC123XyZ"

​
identifier
string
Example:

"PAYER-2025-001"

​
name
string

Full name for individual or business name

Example:

"John Doe"

​
given_name
string | null
Example:

"John"

​
family_name
string | null
Example:

"Doe"

​
middle_name
string | null
​
company_name
string | null
Example:

"Acme Corp"

​
email
string<email> | null
Example:

"john.doe@example.com"

​
phone
string | null

E.164 formatted phone number

Example:

"+15551234567"

​
tax_id
string | null

Tax identification number

Example:

"12-3456789"

​
address
object
​
metadata
object

Optional metadata as key-value pairs

Example:
{ "custom_field": "value", "source": "api" }
​
created_at
string<date-time>
Example:

"2025-10-08T18:20:31Z"

​
updated_at
string<date-time>
Example:

"2025-10-08T18:25:00Z"

Last modified on April 14, 2026