Skip to content

Merchant Admin

Set up the outside businesses that sell or collect payments through your platform. A merchant is an entity record, the same kind as a customer or supplier, with its own payment-gateway credentials, contracts and rate cards; it is not where your own companies and branches live, which is the Organisation applet. What is saved here is read by the gateway callbacks, the Peppol and e-Invoice applets and the monthly merchant report.

Your job, and the screen for it

The jobScreen or tabRead
Onboard a merchant with its gateway credentials — check the PGW Merchant Code against the gateway provider’s list before CREATE; nothing else checks it is uniqueMerchant › +Fields
Add tax, payment, address, contact and credit details — rows on those tabs are lost unless you press the header SaveThe merchant’s edit tabs, then the header SaveEdit form
Write the contract, rate cards and charge rates — the gateway finds a contract by a code this form cannot set, and an Edit-tab save may turn it into a templateContract, then the Rate Card tabContract; Rate card, payment channel, charge rate
Link a login so the merchant’s staff can work its products and orders in the Seller Applet — Verify Email adds the address as a tenant userLogin tab › Verify Email, or Send Invite when the user is not foundLogin
Read the month’s transactions and charges — # of Txn reads 0 when the generated merchant code differs from the PGW Merchant Code, and figures can fall short past 100 transactions on one channelReport (filled only when a Scheduler clock runs the job)Report; Troubleshooting
Set up companies, tax codes, GL codes and settlement methods first — a contract is refused without a Contract CompanyOrganisation, Tax Configuration, Chart of Account and Cashbook appletsBefore you can use it

Overview

Merchant Admin is the merchant view of BigLedger’s shared entity master. A merchant is the same kind of record as a customer, supplier or employee, flagged as a merchant and carrying two payment-gateway credentials of its own — a PGW Merchant Code and a Merchant Key. This applet is where you create that record, attach everything the platform needs to deal with the merchant (Peppol participant IDs, portal logins, checkout return URLs, tax codes, bank accounts, addresses, contacts, company links, merchant branches, credit terms and limits, a logo) and then write the commercial side as merchant contracts, each with rate cards, payment channels and charge rates.

It is opened by the platform or finance administrator who onboards partner businesses that sell or collect payments through the tenant — an e-commerce arm running third-party sellers, or a group company that operates its own payment gateway. Upstream it needs companies, tax codes and settlement methods; downstream the payment-gateway callbacks, the Peppol / e-Invoice applets and the monthly merchant transaction report read what is saved here.

Who needed it. The applet serves a tenant that runs a payment gateway for other businesses. A merchant’s storefront or app sends each payment request to the tenant’s gateway under the merchant’s PGW Merchant Code, signed with its Merchant Key; BigLedger checks the signature against the key it finds under that code, records a payment transaction and ties it to the contract that carries the same code. The contract’s rate cards record what the operator charges per payment channel, and the Report is where those charges were meant to meet the month’s payments. The same merchant record is also the seller identity in the marketplace: a login linked to it works that seller’s products and orders in the Seller Applet. At GadgetSphere, GadgetSphere Online (GSO) hosts third-party brands on its marketplace and takes their customers’ card payments through the group’s gateway, so each brand is a merchant here; GadgetSphere’s own three companies and 22 branches are not.

Merchant Admin is not the Organisation applet. Organisation maintains your own companies, branches and locations. Merchant Admin maintains external businesses that transact on your platform: they have their own gateway credentials, contracts and rate cards. A merchant can also be a customer, supplier or employee at the same time — it is the same entity record, just with more flags (see Entity Maintenance).

A recorded walkthrough of the applet (merchant setup, contracts and rate cards, payment configuration, tax and billing, reports, audit trail):

Where it fits

DirectionApplet / documentWhy
UpstreamOrganisationCompanies for the Contract Company picker and the Company Linking tab; branches for the Merchant Branch tab
UpstreamTax ConfigurationTax codes offered on the Tax & Billing tab and the Merchant Branch control-account section
UpstreamChart of AccountGL codes and subledgers for the Merchant Branch control account
UpstreamCashbookSettlement methods read by the Payment Config tab
UpstreamTenant AdminConfirmed tenant logins that the Login tab verifies and invites
SiblingEntity Maintenance, Customer Maintenance, Supplier, Employee MaintenanceSame records; each sibling edits its own entity type
DownstreamPayment-gateway callbacksVerify callback signatures with the merchant key copied onto the payment transaction
DownstreamMy Peppol Admin, My E-Invoice AdminPeppol participant IDs and the e-Invoice notification methods saved on the merchant
DownstreamMerchant monthly report jobReads the merchant’s rate cards and charge rates to price each payment channel per month; the result is the applet’s Report menu
DownstreamSeller AppletA login linked to the merchant entity maintains that seller’s marketplace products and store stock balances and works the seller orders allocated to it
SiblingMerchant Access (MerchantAccessApplet, no wiki page)The merchant-side applet; a separate build, see Related applets

The table names the neighbours; the five relationships below are what the screen does not show.

  • What must exist first. Companies in Organisation before any contract, because BigLedger refuses a contract without a Contract Company. And before a merchant can take a payment, a contract must exist that carries the merchant’s PGW Merchant Code as its gateway code: the gateway finds the contract by that code, not by the contract’s Merchant field, and the Create Contract form here has no field for it. If no contract carries the code, the merchant’s payment requests fail at the gateway (read, not run), and the first symptom is the merchant’s checkout erroring, not anything on this screen.
  • What becomes possible. Once the merchant exists with a PGW Merchant Code and a Merchant Key, its storefront can send signed payment requests to the gateway; a linked login lets that seller work its marketplace products and orders in the Seller Applet; its Peppol IDs and notification choices are there for the e-Invoice applets; and once a report clock runs, its monthly counts appear under Report.
  • Its siblings, and when to use which. Use Merchant Admin when the business needs gateway credentials, contracts or rate cards. Use Customer Maintenance or Supplier instead when you only sell to it or buy from it: the record is the same, and Entity Type adds the customer or supplier flag to a merchant. Use Organisation, not this applet, for your own companies and branches.
  • What breaks elsewhere. Removing a merchant takes its key away from the gateway, so requests under its PGW Merchant Code fail (read, not run); its contracts stay behind as templates; its past Report rows keep their figures but show an error code in place of its name, because the name is looked up each time the Report opens. Changing the PGW Merchant Code on the Details tab breaks the merchant’s payments as well unless the contract’s gateway code and the merchant’s own integration change with it (read, not run). Rotating the Merchant Key affects new transactions only.
  • What it is used alongside. The Scheduler applet, which holds the clock that fills the Report; Entity Maintenance, the place to read the merchant code BigLedger generated, which the Report shows in its Merchant ID column; and the Seller Applet for merchants that also sell on your marketplace.

Modules: Core, E-Commerce, E-Invoice.

Screens and menus

Left menu (the registry name is Merchant Admin and the UI banner still says Merchant Applet):

MenuWhat it is for
MerchantListing, create and edit of merchant entities — the main working area
ContractListing, create and edit of merchant contracts with their rate cards and charge rates
ReportThe monthly merchant transaction summary — read-only
Audit TrailEntity events written by this applet: Create Merchant, Edit Merchant, Create Charge Rate, Update Payment Channels…

Gear (Settings) menu: System Configuration › Field Settings, Default Selection; the shared settings frame adds Server Side Permissions (Permission Wizard, Permission Set, User / Team / Role Permission), Integration › Triggers (webhooks) and Developer Tools › Audit Trail, Reset Applet State. Only Field Settings, Default Selection, Permission Set, User / Team / Role Permission and Triggers actually open in this applet; Permission Wizard, the developer Audit Trail and Reset Applet State are links that land back on the merchant listing. Feature Visibility opens (it is the default settings page) but has no menu link. Personalization lists Field Settings (which does not open) and Default Selection; a Sidebar screen exists without a menu entry.

Merchant listing

Columns: Merchant ID, Merchant Name, Merchant Company, Status, Creation Date, Updated Date. Keyword search plus column filters. + opens the create form; clicking a row opens the edit form.

Create form

A single panel. CREATE is enabled only when every starred field is filled (see Fields). Status defaults to ACTIVE, Merchant Type to CORPORATE and Entity Type to MERCHANT.

Create Merchant form with Merchant ID, Merchant Name, Merchant Company, Company Registration No, Merchant Type, AR/AP Type, PGW Merchant Code, Merchant Key, Status and Description
Create Merchant. Entity Type is hidden here because the tenant has HIDE_ENTITY_TYPE switched on in Field Settings.

Edit form

Tabs, in order: Details, Peppol Config (inner tabs Peppol Ids, Notification Config), Login, Contract, Return URL, Tax & Billing, Payment Config, Address, Contact, Company Linking, Merchant Branch, Credit Limit and Terms (inner tabs Credit Term, Credit Limit), Logo.

How the tabs save differs:

  • The header Save writes the Details tab, the Notification Config checkboxes and every row staged on Return URL, Tax & Billing, Payment Config, Address, Contact, Credit Term and Credit Limit in one save of the whole merchant. Until you press Save those rows exist only in the browser.
  • Peppol Ids, Login, Contract, Company Linking, Merchant Branch and Logo save immediately when you press Add / Save / Create inside the panel.
  • Remove on the Details tab deletes the merchant at once — there is no confirmation dialog (see Lifecycle and effects).
Peppol Config tab, Peppol Ids listing with Peppol Participant ID and Is Default columns, and the Add Peppol Participant ID panel with Verify Participant ID button and Default toggle
Peppol Config › Peppol Ids. Verify Participant ID calls the Peppol participant lookup before the ID can be added.
Notification Config with four checkboxes: peppol (only applicable if valid peppol id), email, other UCC channels, through customer portals
Peppol Config › Notification Config. The four checkboxes are saved with the merchant when you press the header Save.
Return URL tab listing URL Code, URL Name, Success Return URL and Error Return URL, with the edit panel showing the two toggles
Return URL. Each toggle reveals its URL field; the rows are stored as URL_INFO extensions.
Tax & Billing tab listing Country, Tax Code, Tax Type, Tax Rate and Tax Option with the Add Tax panel
Tax & Billing. Country is chosen first; Tax Type and Tax Code are filtered to that country's tax codes.
Payment Config tab with Payee Residential Status, Country, Bank, Swift Code, Bank Acc No., Bank Acc Holder Name, IBN Number and Account Expiry
Payment Config. Bank details for paying the merchant out; Payee Residential Status and Country are mandatory.
Address tab listing and the Add New Address panel with Address Name, Address Type, Address 1-5, Country, State, City, Postal Code and Set as default
Address. Rows are saved with the merchant on Save.
Contact tab listing Contact ID, Contact Name, Mobile Number, Email Address, Contact Tag and the Create Contact panel
Contact. Contacts become CONTACT_INFO entity lines.
Company Linking tab with Company Code, Company Name and AR/AP Type columns and the Add Company Linking panel
Company Linking. One link per company; the panel refuses a company that is already linked.
Credit Limit sub-tab listing and the Credit Limit Edit panel with Code, Name, Status, Currency, Credit Limit Amount and audit fields
Credit Limit and Terms › Credit Limit. Existing or new limit profiles; the rows are CREDIT_LIMIT extensions saved with the header Save.
Logo tab with an empty image listing and the Upload Logo drop zone
Logo. The file is attached to the entity as a SYS_MERCHANT_LOGO extension.

Contract screens

Contract listing columns: Contract Code, Contract Name, Contract Company, Merchant Contract Key, Status, Creation Date, Updated Date. Create has Contract Name, Contract Code (computed, read-only), Merchant, Contract Company and Status. Edit has tabs Details, Rate Card and Annex; the contract opened from a merchant’s own Contract tab shows Details, Rate Card and Audit Trail instead. Inside Rate Card: a rate-card listing (Rate Card Code, Rate Card Name, Rate Card Status) → payment-channel listing for the selected card → charge-rate listing per channel, each level with its own create / edit panel.

Create Contract form with Contract Name, Contract Code C00010 (read-only), Merchant, Contract Company and Status
Create Contract. The code is the highest existing C-number plus one, computed in the browser.

Report

Listing columns: Merchant ID, Merchant Name, Payment Channel, Currency, PC Charge Name 1-4 and PC Charge 1-4 (%/$), VAT %, Unrecoverable VAT %, network charges per transaction ($ and %), network Charge Name 1-4 and Charge 1-4, # of Txn, Total Amount, Download. Clicking a row opens a read-only view of the same charges. The column group labelled with the payment network’s own name in the UI is described generically here.

Every row is a stored snapshot, written by the merchant monthly report job at the time it ran: one row per merchant per payment channel, channels the merchant never used included. The rows carry no month. Run with no months or years, the job covers the previous calendar month, so a row written on 1 November describes October; run for named months, nothing on the row says which month it describes. The listing shows the newest rows first. Merchant ID, # of Txn, Total Amount, VAT % and every charge column are frozen at the run, and the Merchant ID column is the merchant code BigLedger generated, not the Merchant ID you typed. Merchant Name, Payment Channel and Currency are looked up live each time the Report opens, so a renamed merchant shows its new name against old figures. What each figure is counted from is under Lifecycle and effects.

Audit Trail

Listing columns: Merchant Name, Action, Event Code, User, Date — the entity events this applet writes. It is a log of actions, not a before/after field diff.

Configuration

Before you can use it

  • Companies in the Organisation applet — every contract needs a Contract Company (BigLedger refuses a contract without one), and the Company Linking tab picks from the same list. Branches are needed for the Merchant Branch tab.
  • Tax codes in Tax Configuration — Tax & Billing filters by the chosen country; the Merchant Branch panel offers SST/GST and WHT codes and the MyInvois tax type codes.
  • GL codes and subledgers in Chart of Account for the Merchant Branch control account.
  • Settlement methods in the Cashbook applet — read by Payment Config.
  • Banks and countries — the Payment Config Bank and Country lists come from the platform’s shared bank and country lists.
  • Merchant code prefix / running number — the create form never sends a merchant code, so BigLedger generates one from the merchant running number plus the tenant’s merchant prefix. The Merchant ID you type is a different thing: a display identifier only.
  • Server-side permissions — creating a merchant needs TNT_API_ERP_MERCHANT_ENTITY_CREATE (or the merchant-entity owner / admin permission); update and delete need the matching _UPDATE / _DELETE codes. Contract, rate-card and charge-rate writes need the tenant owner / admin role or the corresponding permission, with the contract’s company as the permission target.

Applet settings

Settings are applet-local: Field Settings is this applet’s own screen, saved as the applet’s tenant-wide settings. The shared document-applet Field Configuration screen is not used. Anyone with access to the Settings menu can change them; they apply tenant-wide.

SettingWhat it controlsDefaultEffect when changed
HIDE_E_TYPE (labelled HIDE_ENTITY_TYPE, panel Main Details)Hides the Entity Type multi-select on the create formOff (a never-saved tenant has no value, so the field shows)On: the control is disabled and hidden, so the create request carries no entity-type flags; BigLedger still flags the record as a merchant because it was created from this applet. CUSTOMER / SUPPLIER / EMPLOYEE cannot be added at creation. The edit form ignores this setting — Entity Type is always visible there

That is the only setting that is declared, rendered, persisted and consumed. Also on the screen but not saved:

  • Lines Settings — Unit Discount, SST/VAT/GST, WHT, Blanket Order — and Department Settings — Segment, G/L Dimension, Profit Center, Project: eight slide toggles connected to nothing. They are a copy of a document-applet panel.
  • Default Selection (Default Branch, Default Location): since the build published on 2026-10-08, SAVE works and writes DEFAULT_BRANCH / DEFAULT_LOCATION into the applet-wide settings. Nothing in this applet reads them from there, and the backend does not read them at all, so the applet-wide pair is a stored preference with no effect. (Until that build the pickers wrote into a settings container that was never loaded, so choosing a value failed and SAVE saved nothing — if your screen still behaves that way, reload the applet.)
  • Personalization › Default Selection: the same two pickers, saved to your own per-user settings — and this is the pair that does something: the shared branch and location multi-selects that other applets’ listings and documents open with pre-fill from the per-user DEFAULT_BRANCH / DEFAULT_LOCATION. The effect shows in other applets’ pickers — a sales or purchase document’s branch picker, for instance — not on a merchant screen.
Applet Settings with Field Settings selected showing the HIDE_ENTITY_TYPE toggle under Main Details, and collapsed Lines Settings and Department Settings panels
Settings › Field Settings. Only HIDE_ENTITY_TYPE is bound; the two collapsed panels hold unbound toggles.

Document behaviour settings

Not applicable — master data; no statuses beyond the entity and contract status fields, no posting, no printables.

Settings in other applets that control this applet

None found: the applet reads no company, branch or other-applet settings.

Feature visibility / permissions

  • Client-side permissions: none are defined for this applet, and the applet checks no SHOW_* codes. Feature Visibility is the shared Manage Team Access screen only.
  • Server-side permissions: the Permission Set / User / Team / Role screens are the shared ones; in this applet a permission target can be a Company, Branch, Location, Applet, Tenant, Team, Hostname, Merchant Contract, Merchant Rate Card, Payment Channel, Merchant Rate, Entity Credit Limit, Entity Credit Term, GL Code, Tax Code, Country, Entity (merchant), Login, Currency, Contract Rate or settlement-method Item.

Fields

Create form

FieldMeaningRequiredNotes / validation
Merchant IDDisplay identifierYesStored as a display identifier, separate from the generated merchant code; no uniqueness check
Company Registration No / ID NumberRegistration or identity numberYesMax 100; label follows Merchant Type (CORPORATE → Company Registration No, INDIVIDUAL → ID Number)
Entity TypeMulti-select CUSTOMER, SUPPLIER, EMPLOYEE, MERCHANTYes (when shown)Default MERCHANT; hidden by HIDE_ENTITY_TYPE; choosing EMPLOYEE forces Merchant Type to INDIVIDUAL. Sets the customer / supplier / employee / merchant flags on the record
Merchant TypeCORPORATE / INDIVIDUALYesDefault CORPORATE
AR / AP TypeAR_TRADE, AR_OTHER, AR_MERCHANT, AP_TRADE, AP_OTHER, AP_MERCHANT, AP_EMPLOYEEYesIf blank BigLedger defaults to AP_TRADE for suppliers, else AR_TRADE
PGW Merchant CodeThe name a payment request uses for this merchantYes, on this formA payment request names its merchant by this code, and BigLedger checks the request’s signature with the Merchant Key it finds under the code — so it must match, character for character, what the gateway integration sends. Nothing checks that another merchant does not already carry it, and the listing’s search does not look at it; if two merchants carry the same code, key lookups for that code stop working and so do its payments (read, not run). Keeping the codes unique is the onboarding administrator’s job: check the new code against the gateway provider’s merchant list before CREATE. No length limit here; 100 on the Details tab
Merchant KeyGateway signing keyYesShown in clear text; copied onto each payment transaction at transaction time
StatusACTIVE / TEMP / INACTIVENoDefault ACTIVE; a blank status is set to ACTIVE server-side. TEMP is a holding status: where the temporary-entity clean-up clock is switched on in the Scheduler applet (how scheduled work runs), a TEMP record older than the hours that clock is given is marked deleted

The Details tab of the edit form has the same fields (all of Merchant ID, Merchant Name, Merchant Company, registration number, Entity Type, Merchant Type, AR/AP Type, PGW Merchant Code and Merchant Key mandatory, each max 100) plus Remove.

Peppol Config

  • Peppol Ids — Peppol Participant ID (with Verify Participant ID, which calls the Peppol participant lookup by ISO 6523 scheme and ID), Default toggle, Delete. Saved immediately.
  • Notification Config — four checkboxes: peppol (only applicable if valid peppol id), email, other UCC channels (through telegram / facebook messengers etc), through customer portals. Saved by the header Save as the merchant’s e-Invoice notification methods.

Login

FieldMeaningRequiredNotes
User emailTenant login to linkYesVerify Email tries to add the address as a tenant user: if it succeeds or the user already exists, the confirmed login is linked; if the user is not found, the Send Invite button appears (the invitation also creates an entity for the new user)
RankOWNER, ADMIN, MANAGER, MEMBER, GUEST, VISITOR, ANNONYMOUSYesDefault MEMBER
StatusACTIVE / INACTIVEYesDefault ACTIVE

Add links the login immediately. Listing columns: User Email, Rank, Status, Modified Date.

Return URL

Return URL Code, Return URL Name, Success Return URL toggle + URL, Error Return URL toggle + URL. Saved with the header Save.

Tax & Billing

Country (required), Tax Type, Tax Code, Tax Rate (%) (required), Tax Option (required). Tax types include SST service-tax input / output entries; codes are the tax codes of the chosen country. Saved with the header Save.

Payment Config

Payee Residential Status (RESIDENT / NON-RESIDENT, required), Country (required), Bank, Swift Code, Bank Acc No., Bank Acc Holder Name, IBN Number, Account Expiry (date). Saved with the header Save.

Address, Contact

  • Address — Address Name, Address Type (required), Address 1 (required), Address 2-5, Country / State / City / Postal Code (required), Set as default. Saved with the header Save.
  • Contact — Contact Name, Contact ID, Position, Mobile No (required), Office No, Extension No, Fax No, Phone Number, Email, Other No. Saved with the header Save.

Company Linking, Merchant Branch

  • Company Linking — Company and AR/AP Type, both required; Add saves the link at once and is refused if the company is already linked. The edit panel shows Company Code, Company Name, Registration No. and AR/AP Type.
  • Merchant Branch (panel title Create Customer Branch) — Selected Entity (read-only), Code, Name, Description, Mapping Value 01-05, Address Name, Email, Phone Number, Address Line 1-5, Country, State, City, Postal Code, Control Account Code, Account AR/AP Type, Account GL Code, Account Subledger, Output Tax Type + SST/GST/VAT, Output WHT Type + WHT, Input Tax Type + SST/GST/VAT, Input WHT Type + WHT, Einvoice Tax Type Code. Saved immediately; the edit panel adds DELETE.

Credit Limit and Terms

  • Credit Term — Existing Credit Term or New Credit Term: Credit Term Name, Credit Term Code (required), Status, Set Year / Month / Day, Add Year / Month / Day. Saved with the header Save.
  • Credit Limit — Credit Limit Code (required), Credit Limit Name, Status, Currency, Credit Limit Amount. Saved with the header Save.

Contract

FieldMeaningRequiredNotes
Contract CodeRead-onlyBrowser computes the highest existing numeric part + 1, formatted C00001…; no backend uniqueness check on the code
MerchantThe merchant this contract belongs toYes, on this formBigLedger refuses a merchant that does not exist but accepts none at all — a contract with no merchant is a TEMPLATE (see Type)
Contract CompanyYour company on the contractYesBigLedger rejects a missing or unknown company
StatusACTIVE / DEACTIVATE on create; ACTIVE / INACTIVE on editYesThe two forms offer different lists, so a contract created as DEACTIVATE opens on the Edit tab with Status empty, and saving it makes you pick ACTIVE or INACTIVE. What a DEACTIVATE or INACTIVE contract stops outside this applet was not confirmed for this page — the monthly report job does not read it — so before relying on it to stop a merchant’s payments, ask BigLedger support
Merchant Contract KeyGeneratedTen random alphanumerics assigned by BigLedger; must be unique
TypeDerivedRead-onlyTEMPLATE when the contract has no merchant, PERSONAL otherwise. The create form insists on a merchant, so every contract made here starts PERSONAL. Caution (read, not run): the Edit tab’s Save writes the contract back with no merchant, and without the gateway settings the form does not show, so a saved PERSONAL contract reopens as TEMPLATE. Test it on one contract you can recreate: note its Type, change only the name, Save, reopen. If it reads TEMPLATE, leave contracts that carry live payments unedited and create a new contract instead

Rate card, payment channel, charge rate

  • Rate Card — Rate Card Code (generated RC_nnnn, read-only), Rate Card Name (required), Status, Description.
  • Payment channel — a rate-card line linking the card to a payment provider. You do not pick these: when you create a rate card, BigLedger adds one line, switched off, for each payment provider your Contract Company has a gateway contract with. A company with no gateway contract gets a rate card with no channels.
  • Charge Rate — Charge Rate Name (required), Rate (required), rate logic. The report’s network-named Charge Name 1-4 columns are meant for up to four named charge rates, but the report job looks rates up by payment channel, and a charge rate saved here records its rate card and line without a payment channel, so those columns stay blank (see Lifecycle and effects). The PC Charge Name 1-4 columns are the gateway’s own contract rates for that payment channel, which are not maintained in this applet.

Lifecycle and effects

This is a master-data applet: no server document type, no amount or quantity signum, no journal, no stock processor and no open-queue rows. It writes:

WhatHow
Merchant — the entity record with its display ID, company info, return URLs, tax rows, payment config, credit terms, credit limits, logo and contactsOne save of the whole merchant from the header Save
Entity event (CREATE_MERCHANT, EDIT_MERCHANT, CREATE_CHARGE_RATE, UPDATE_PAYMENT_CHANNELS, …)Written by the applet after each save
Peppol ID, login link, company link, merchant branchSaved immediately from the panel
Contract, rate card, charge rateSaved immediately from the Contract screens

It reads the monthly merchant transaction summary for the Report menu. The merchant monthly report job writes those rows. The applet has no button to run it: the job is shipped and registered, and it runs only on a tenant where a Scheduler clock for it is switched on. Given no months or years it covers the previous calendar month. For each merchant and each payment channel it:

  • counts payments by the generated merchant code. It takes the payment transactions whose merchant code and channel match and whose date falls in the month, counts every one that was not deleted, answered or not, and adds up the amount the gateway answered with, so an abandoned request adds to # of Txn and nothing to Total Amount. A payment transaction records the PGW Merchant Code the request named, while the job matches on the merchant code BigLedger generated; when the two codes differ, the merchant reads 0 transactions whatever it took. The job also reads at most 100 of the merchant’s transactions on a channel, from all time, before keeping the month’s, so once a merchant has more than 100 on one channel the month’s count and total can fall short.
  • copies VAT % from the first tax row on the merchant’s Tax & Billing tab, as it stands at the run.
  • fills the network-named charge columns from charge rates found by payment channel, not by merchant or contract. A charge rate saved on this applet’s Rate Card screens records no payment channel, so the job finds none of them and those columns stay blank.
  • fills the PC charge columns from the gateway’s own contract rates for the channel, the same figures for every merchant on that channel.

Run twice for the same month, it adds a second set of rows rather than replacing the first.

Backend validation that stops a save:

  • Merchant: a status must be present; a merchant code on a record that is not flagged as a merchant is rejected; a duplicate merchant code is rejected. Codes are upper-cased and stripped of spaces before the check. The server would also refuse a duplicate in the record’s own merchant-ID column, but this applet never fills that column — the Merchant ID you type is stored separately — so two merchants can carry the same Merchant ID.
  • Contract: company, contract key, revision, status, dates and created / updated user are all mandatory and must exist; a merchant is optional to BigLedger but must exist when given (the create form is what insists on one); a duplicate contract key is rejected.
  • Rate card and charge rate: the same kind of existence checks.

Status. Merchant status is ACTIVE / TEMP / INACTIVE; the merchant listing and every downstream lookup by entity type filter on the merchant flag, not on status, so an INACTIVE merchant still appears wherever merchants are listed. Contract status is ACTIVE / DEACTIVATE on the create form and ACTIVE / INACTIVE on the edit form, and is not read by the monthly report job.

Delete. Remove deletes the merchant at once. BigLedger deletes the record, its extensions, lines and login links physically after deleting attached files, and fires the MERCHANT_DELETED webhook; it does not check for contracts, payment transactions or documents that reference the entity. Contracts are separate records and survive pointing at a merchant that no longer exists. Contract Remove deletes the contract the same way.

What reads the credentials. Payment-gateway callbacks verify their signature with the merchant key copied onto the payment transaction when it was created — so rotating the Merchant Key affects new transactions only.

What success looks like

Follow one merchant through, from creation to the one place its figure lands. GadgetSphere Online onboards a wireless-audio brand that sells on its marketplace: Merchant ID GSO-MKT-017, PGW Merchant Code GSOAUDIO17, Contract Company GadgetSphere Online Sdn Bhd. In October the brand’s storefront sends 38 payment requests through the gateway’s card channel; the gateway answers 36 of them for RM 11,362.00 in total, and 2 are abandoned before any answer.

  1. After CREATE, Audit Trail shows a Create Merchant row with your user and today’s date. Search Entity Maintenance for the brand’s name and note the merchant code BigLedger generated.
  2. After the contract, the Contract listing shows the new contract with a ten-character Merchant Contract Key, and opening it shows Type PERSONAL.
  3. After the report clock has run on or after 1 November with no months or years given, Report shows a row for the brand on the card channel, newest first, with the generated code from step 1 in its Merchant ID column. If that code is the same text as GSOAUDIO17, # of Txn reads 38 and Total Amount 11,362.00: the abandoned requests count, and add nothing to the total. If the two codes differ, both read 0, whatever the brand took; that is the behaviour described above, not a missed payment.

If step 3 shows two rows for the brand and the card channel, the clock ran twice for October; each row is a snapshot of the month taken at its own run, and the newer one is listed first.

Related applets

  • Entity Maintenance — the type-agnostic view of the same records; use it to see a merchant that is also a customer or supplier, or to maintain the category trees.
  • Customer Maintenance, Supplier, Employee Maintenance — the other entity-type views; a merchant with CUSTOMER in its Entity Type appears in Customer Maintenance with the credit terms and limits set here.
  • Organisation — companies for contracts and company linking; branches for merchant branches.
  • Tax Configuration — tax codes for Tax & Billing and the merchant branch control account.
  • Chart of Account — GL codes and subledgers for the merchant branch control account.
  • Cashbook — settlement methods read by Payment Config.
  • My Peppol Admin, My E-Invoice Admin — consume the Peppol participant IDs and notification methods saved on the merchant.
  • Seller Applet — the seller-side workspace of a merchant registered here: its products, stock balances and allocated orders.
  • Tenant Admin — the tenant users that the Login tab verifies and invites.
  • Merchant Access (registry code MerchantAccessApplet) — a separate ACTIVE applet with its own build, intended as the merchant-side counterpart of this administrator view. It has no page on this wiki and nothing about its behaviour is documented here.

Troubleshooting

SymptomCauseFix
CREATE stays greyOne of the starred fields is empty — Merchant ID, Name, Company, registration number, Entity Type (when shown), Merchant Type, AR/AP Type, PGW Merchant Code, Merchant KeyFill every starred field; Description is the only optional one
Entity Type is missing on the create form but visible on editHIDE_ENTITY_TYPE is on in Field Settings; the edit form does not honour itExpected. Turn the setting off to set CUSTOMER / SUPPLIER / EMPLOYEE at creation, or add them afterwards on the Details tab
Merchant saved without the CUSTOMER flag although CUSTOMER was expectedWith HIDE_ENTITY_TYPE on, the disabled control is excluded from the request, so only the merchant flag is setEdit the merchant and add the type on the Details tab
Two merchants with the same Merchant IDMerchant ID is a display identifier and is never checked for uniqueness; the unique key is the generated merchant code, which this applet never displaysSearch by name; use Entity Maintenance (keyword search matches the merchant code) to tell them apart
merchant_code already exists on an import or API callAnother entity already carries that merchant code (…MERCHANT_CODE_ALREADY_EXISTS); codes are compared after upper-casing and removing spacesLeave the code blank so the running number generates it, or pick an unused one
Rows added on Return URL / Tax & Billing / Payment Config / Address / Contact / Credit Term / Credit Limit disappearThey are staged in the browser until the header Save is pressedPress Save on the Merchant Edit header, not only the panel’s Save / Add
Merchant vanished after clicking RemoveRemove deletes immediately, without confirmation, and physicallyRecreate the merchant; contracts that pointed at it still exist in the Contract listing but show no merchant
Contract listing shows a contract with an empty Merchant Name / edit shows Type = TEMPLATEThe contract has no merchant — the merchant was deleted, the contract was created as a template, or (read, not run) it was saved from the Edit tab, which writes it back without its merchantCreate a new contract for the merchant; templates cannot be re-pointed from the UI. Test the Edit-tab behaviour on one contract before editing any other (see Type under Contract)
Two contracts with the same Contract CodeThe code is computed in the browser as max + 1; two users creating at the same time get the same number and BigLedger does not check the code for uniquenessRename one; the contract key, not the code, is the unique identifier
Verify Email says User … not foundThe e-mail is not registered as a login in this tenantPress Send Invite; the invitation creates the login and an entity for it. Link the login once the user has confirmed
Verify Email succeeded but the user now appears in Tenant AdminVerify works by attempting to add the address as a tenant user; success means it was addedExpected side effect
Report menu is emptyThe monthly summary is filled only by the merchant monthly report job, which runs from a Scheduler clockAsk support to schedule or run the job (PGW_MERCHANT_MONTHLY_REPORT_PROCESSOR in the Scheduler applet). With no months or years given it covers the previous calendar month; name the months and years to fill earlier ones
Report shows blank network-named charge names and chargesThe job looks charge rates up by payment channel, and a charge rate saved on this applet’s Rate Card screens records no payment channel, so it finds noneRead the merchant’s agreed rates under Contract › Rate Card; rerunning the job changes nothing. Ask BigLedger support before relying on the report’s charge columns
# of Txn and Total Amount read 0 although the merchant took paymentsThe job matches payments on the merchant code BigLedger generated; each payment records the PGW Merchant Code its request named. When the two differ, nothing matchesCompare the Report’s Merchant ID column with the merchant’s PGW Merchant Code. If they differ, count from the gateway’s own records and raise it with BigLedger support; changing a live merchant’s PGW Merchant Code to make them agree breaks its payments
# of Txn is lower than the gateway’s own count for a busy merchantThe job reads at most 100 of a merchant’s transactions on a channel, from all time, before keeping the month’sCount from the gateway’s own records for that merchant and channel
Two Report rows for the same merchant and channelThe job ran twice for the same month; each run adds rows and replaces noneUse the newer row, which the listing shows first: each is a snapshot of the month taken at its own run
Payment-gateway callback fails with signature mismatch after the Merchant Key was changedCallbacks are verified against the key copied onto the payment transaction when it was created, not the current merchant keyTransactions started before the change keep the old key; only new transactions use the new one. Do not change the key while transactions are in flight
Default Selection saves, but nothing on a merchant screen changesExpected. The applet-wide pair is read by nothing; the per-user pair (Personalization › Default Selection) pre-fills the shared branch and location pickers that other applets open withSet it under Personalization and look for the effect in other applets’ documents and listings; see Applet settings
Choosing a Default Selection branch throws a console error and SAVE saves nothingYou are on the build before 2026-10-08, which wrote into a settings container that was never loadedReload the applet; the served build saves
Settings links Permission Wizard, Audit Trail, Reset Applet State return to the merchant listingThe shared settings frame lists them but this applet does not have those screensUse Permission Set / User / Team / Role Permission; the applet’s own Audit Trail is the left-menu item
Personalization › Field Settings does nothingListed in the menu without a screen behind itUse Settings › Field Settings

Related documentation

Last updated on