Skip to content

Glossary ​

TermDefinition
AggregatorPlatform exposing payment channels behind a single API. SOAMTAR is one.
API keyBearer token authenticating API requests: sk_test_... / sk_live_... on your server, pk_test_... / pk_live_... in the browser.
ChargebackA payment dispute raised by the customer.
CustomerPersistent payer profile, scoped to a merchant.
DisputedStatus of a transaction under an open dispute.
E.164International phone format. In Sierra Leone: +232 followed by 8 digits, e.g. +23276123456.
EndpointURL to which SOAMTAR sends a merchant's webhooks.
Fee amountFees charged to the merchant by SOAMTAR.
Freetown timeAfrica/Freetown, GMT all year round (no daylight saving).
Hosted checkoutPayment page hosted by SOAMTAR.
HMACHash-based Message Authentication Code, the webhook signing algorithm.
Idempotency-KeyHeader on POST/PUT/PATCH/DELETE that makes retries safe.
Internal refSOAMTAR reference of a transaction (TXN-...).
KYCKnow Your Customer: identity verification in progressive levels.
Leone (SLE)Currency of Sierra Leone. Two decimals (0.01 SLE is the smallest unit). Written Le 1,250.00.
livemodeBoolean present in API responses: true = production, false = sandbox.
Merchant refFree reference chosen by the merchant (business idempotency).
Orange Money Sierra LeoneThe mobile money service SOAMTAR uses for collections and payouts (orange_money_sl).
PayoutOutgoing transfer from the merchant balance to an Orange Money wallet.
PINSecret code the customer enters on their phone to confirm an Orange Money payment. SOAMTAR never sees it.
ReconciliationPeriodic check with Orange Money to catch lost webhooks.
RefundReturn of funds for a success transaction — created with POST /v1/refunds (full or partial) and credited back to the payer's Orange Money wallet.
SaloneCommon name for Sierra Leone in Krio.
SandboxTest environment, sk_test_... keys, no real money moves.
SettlementTransfer of the merchant balance to the merchant's bank account.
SLLFormer leone code. The leone was redenominated in 2022 (1 SLE = 1,000 SLL); always send SLE.
Soft deleteLogical deletion: no record is physically removed.
SplitDistribution of one transaction between several beneficiary merchants.
SubscriptionRecurring billing on a plan.
WebhookSigned HTTP notification sent by SOAMTAR to a merchant endpoint.

SOAMTAR Payment API Documentation.