Skip to main content
POST
Create a merchant

Authorizations

Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version
enum<string>
required
Available options:
2026-04-01
Idempotency-Key
string

A unique string used to ensure the request is processed exactly once. If you retry a request with the same idempotency key within 24 hours, the original response is returned without re-executing the operation.

Maximum string length: 255
Example:

"ik_a1b2c3d4e5f6"

Body

application/json
display_name
string
required

Name shown on the documents and emails issued for this merchant

Minimum string length: 1
Example:

"Northwind Traders"

external_id
string
required

Your own identifier for the merchant, unique within your organization.

Minimum string length: 1
Example:

"acct_492"

avatar
object | null

Square mark for places too small for the full logo. We host it and return its URL as avatar_url.

logo
object | null

Logo shown beside yours in the header of this merchant's documents and emails. We host it and return its URL as logo_url.

support_email
string | null

Support address shown to this merchant's buyers. Omit it to show yours instead.

Example:

"support@northwind.example"

Response

Success

created_at
string<date-time>
required

When the merchant was created

Example:

"2026-08-01T10:00:00Z"

display_name
string
required

Name shown on the documents and emails issued for this merchant

Example:

"Northwind Traders"

external_id
string
required

Your own identifier for the merchant, unique within your organization

Example:

"acct_492"

id
string
required

Unique identifier for the merchant

Example:

"mrch_034DG8VMQwhPngo3S9mdKO"

updated_at
string<date-time>
required

When the merchant was last updated

Example:

"2026-08-01T12:30:00Z"

archived_at
string<date-time> | null

When the merchant was archived. Absent while the merchant is active; archived merchants take no new document attribution but keep rendering on historical documents.

Example:

"2026-08-20T12:00:00Z"

avatar_url
string

Square mark for places too small for the full logo, such as list rows

logo_url
string

Logo shown beside yours in the header of documents and emails issued for this merchant

support_email
string

Support address shown to this merchant's buyers on its documents and emails

Example:

"support@northwind.example"