Skip to main content
POST
Create payer

Authorizations

Authorization
string
header
required

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

Body

application/json
customer_id
string<uuid>
required

Associated customer UUID

email
string<email>
required

Payer's email address

name
string

Payer's name

company
string

Company name

country
string

ISO3 country code

Pattern: ^[A-Z]{3}$
metadata
object

Additional metadata

Response

Payer created successfully

id
string<uuid>
customer_id
string<uuid>
email
string<email>
name
string
company
string
country
string
Pattern: ^[A-Z]{3}$
active
boolean
metadata
object
created_at
string<date-time>
created_by
string<uuid>
modified_at
string<date-time>
modified_by
string<uuid>