Skip to main content
POST
/
v1
/
payers
Create payer
curl --request POST \
  --url https://api.example.com/v1/payers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "name": "<string>",
  "company": "<string>",
  "country": "<string>",
  "metadata": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "name": "<string>",
  "company": "<string>",
  "country": "<string>",
  "active": true,
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modified_at": "2023-11-07T05:31:56Z",
  "modified_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.corebanq.com/llms.txt

Use this file to discover all available pages before exploring further.

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>