API Reference

Create Merchant

post
https://api.preczn.com/v1/merchants

Create a Merchant record on your platform.

Body Params
boolean
Defaults to true

Whether merchant is active or inactive in Preczn. Inactive merchants cannot perform transactions

string

Plan ID

labels
array of strings

The labels array enables multiple labels to be added to a merchant record for enhanced categorization and filtering in the vault. Labels must be capitalized alphanumeric characters; spaces are supported. Note that any addition or removal of labels in the array requires all desired labels to be included in the request. Please be cautious when modifying merchants with existing labels; ensure that you include any existing labels you wish to keep along with any new labels in the array.

labels
string
required
length ≤ 255

Merchant name (e.g. DBA)

string
length ≤ 255

Merchant registered business name

address
object

Merchant physical address.

string

Merchant email address.

string

Merchant phone number.

number

The amount a merchant finances in a year.

string
9 to 15

Tax identification number.

string
enum

Identification number type, value must be either ssn, ein, bn, or sin.

Allowed:
string

URL to merchant's website.

mailingAddress
object

Mailing address.

billingContact
object

Billing address.

string
enum

Business type.

Allowed:
boolean
Defaults to true

Publically traded company flag.

boolean

Flag indicating whether the merchant address is a business address.

string

State in which business was incorporated.

string

Country in which business was incorporated.

string

Date which merchant business was established.

string

Merchant business customer service phone number.

string

Description of merchant's products or services provided.

string

Merchant category code.

number

The total sales volume for the year, represented as a whole number without decimals. For example, an annual sales volume of $100,000.50 should be entered as 10000050. This field is intended to avoid decimal representation by scaling the actual dollar amount to a whole number (i.e., multiplying the dollar amount by 100).

number

The average sales ticket dollar amount, represented as a whole number without decimals. For example, an amount of $13.50 should be entered as 1350. This field is intended to avoid decimal representation by scaling the actual dollar amount to a whole number (i.e., multiplying the dollar amount by 100).

number

The highest sales ticket dollar amount collected by the merchant, represented as a whole number without decimals. For example, an amount of $2,500.75 should be entered as 250075. This field is intended to avoid decimal representation by scaling the actual dollar amount to a whole number (i.e., multiplying the dollar amount by 100).

number
0 to 30

Number of days required to ship sold items.

string
length ≤ 50

A unique identifier used to reference the merchant in your external system. This value must be unique across the same mode (test or live).

owners
array of objects
owners
banking
array of objects
banking
saasData
object

Vertical SaaS platform data for this merchant, including start date and billing configuration.

transactionVolumeSnapshot
object

Snapshot of the merchant transaction volume, including date and aggregated payment method totals.

walletSettings
object

Digital wallet payment settings for this merchant. Configure Google Pay and Apple Pay payment methods.

Headers
string

Unique key to ensure idempotency of requests. If provided, the server will return the same response for subsequent requests with the same key.

Responses

Updated 7 months ago

What’s Next
Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago 
What’s Next