Merchants
The merchants service exposes data about the authenticated merchant account — the business entity associated with your API key.
Methods
getCurrent()
Returns the merchant record for the API key in use. Takes no parameters.
const merchant = await accrupay.merchants.getCurrent();
console.log(merchant.name); // 'Acme Corp'
console.log(merchant.timezone); // 'America/Chicago'
Return shape
Identity and status
| Field | Type | Description |
|---|---|---|
id | string | AccruPay merchant ID. |
publicId | string | Public-facing merchant identifier. |
name | string | Business display name. |
industry | string | null | Industry classification. |
websiteUrl | string | null | Merchant website URL. |
entityType | string | null | Legal entity type (e.g. LLC, Corp). |
status | string | Account status. |
Contact
| Field | Type | Description |
|---|---|---|
email | string | null | Business email address. |
phone | string | null | Business phone number. |
primaryContactName | string | null | Name of primary contact. |
primaryContactEmail | string | null | Email of primary contact. |
primaryContactPhone | string | null | Phone of primary contact. |
Business address
| Field | Type | Description |
|---|---|---|
addressCountry | string | null | ISO 3166-1 alpha-2 country code. |
addressState | string | null | State or province. |
addressCity | string | null | City. |
addressLine1 | string | null | Street address line 1. |
addressLine2 | string | null | Street address line 2. |
addressPostalCode | string | null | Postal / ZIP code. |
Legal
| Field | Type | Description |
|---|---|---|
legalIdentifier | string | null | Legal entity identifier (e.g. EIN, company number). |
legalIdentifierType | string | null | Type of legal identifier. |
legalAddress* | string | null | Legal address fields — same shape as business address, prefixed legalAddress. |
Locale
| Field | Type | Description |
|---|---|---|
timezone | string | null | IANA timezone string (e.g. America/New_York). |
locale | string | null | BCP 47 locale (e.g. en-US). |
Timestamps
| Field | Type | Description |
|---|---|---|
archivedAt | string | null | ISO timestamp if account is archived. |
createdAt | string | ISO creation timestamp. |
updatedAt | string | ISO last-update timestamp. |