Skip to main content

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

FieldTypeDescription
idstringAccruPay merchant ID.
publicIdstringPublic-facing merchant identifier.
namestringBusiness display name.
industrystring | nullIndustry classification.
websiteUrlstring | nullMerchant website URL.
entityTypestring | nullLegal entity type (e.g. LLC, Corp).
statusstringAccount status.

Contact

FieldTypeDescription
emailstring | nullBusiness email address.
phonestring | nullBusiness phone number.
primaryContactNamestring | nullName of primary contact.
primaryContactEmailstring | nullEmail of primary contact.
primaryContactPhonestring | nullPhone of primary contact.

Business address

FieldTypeDescription
addressCountrystring | nullISO 3166-1 alpha-2 country code.
addressStatestring | nullState or province.
addressCitystring | nullCity.
addressLine1string | nullStreet address line 1.
addressLine2string | nullStreet address line 2.
addressPostalCodestring | nullPostal / ZIP code.
FieldTypeDescription
legalIdentifierstring | nullLegal entity identifier (e.g. EIN, company number).
legalIdentifierTypestring | nullType of legal identifier.
legalAddress*string | nullLegal address fields — same shape as business address, prefixed legalAddress.

Locale

FieldTypeDescription
timezonestring | nullIANA timezone string (e.g. America/New_York).
localestring | nullBCP 47 locale (e.g. en-US).

Timestamps

FieldTypeDescription
archivedAtstring | nullISO timestamp if account is archived.
createdAtstringISO creation timestamp.
updatedAtstringISO last-update timestamp.