Glossary
The terms of the Ginger platform, its portals, its connectors and these docs.
The terms used on the platform and in these docs, grouped by topic. Each links to the page that explains it.
Platform
| Term | Meaning |
|---|---|
| Admin portal | The portal of your team: boarding, permissions, contracts, support. See Tour the portals. |
| Base permissions | The most a merchant may ever do, set only by you. Its projects, users and roles stay within them. See Merchant hierarchy. |
| Contract | The configuration of a processor or payment method for a project: merchant IDs, credentials, currencies, capture mode. See Processor contracts. |
| Merchant | A business you contract with. It has projects, users and roles. |
| Merchant portal | The portal of your merchants: orders, refunds, payment links, their own projects and users. |
| Merchant tag | A label on a merchant, copied to its orders and transactions. See Merchant tags. |
| Platform instance | Your own Ginger platform, under your domain. |
| Project | One place where a merchant accepts payments, with its own API key, webhook URL, payment methods and contracts. |
| Role | A named set of permissions, given to users. |
| System user | A user of your own team, in the Admin portal. |
| Test mode | A project with the status active-testing: its orders get the is-test flag and go to the test environments of the connectors. See Take a test payment. |
| User | A login to a portal. A merchant user sees one merchant. |
Payments
| Term | Meaning |
|---|---|
| Capture mode | Whether a card payment is captured at once or authorised first and captured later. See Processor contracts. |
| Flags | A summary of the history of an order, such as is-test or has-refunds. See Statuses. |
| Hosted payment page | The payment page Ginger shows when a merchant redirects its customer. See Style the hosted payment page. |
| Order | What a customer pays for: an amount, a currency and a description. Its status tells the merchant whether to deliver. |
| Transaction | One payment attempt for an order, with one payment method. |
Every status of a merchant, project, order and transaction is on Statuses.
Card processing
| Term | Meaning |
|---|---|
| Acceptor key | The Silverflow acceptor of a project for one card scheme, mac-…. See Merchant boarding. |
| AFT | Account Funding Transaction: a payment that pulls money from a card to fund another account. See Account Funding Transactions. |
| AReq | The authentication request of 3-D Secure. Mastercard sets which customer data it holds. See Mastercard 3DS AReq data. |
| BEP | The protocol of Bancontact app payments. See Bancontact. |
| BIN key | The reference to your BIN at Silverflow, bin-…. |
| Boarding mode | How Ginger boards a project at Silverflow: full-merchant, acceptors-only or disabled. See Merchant boarding. |
| Endeavour | The 3-D Secure server used for Elavon. See Elavon. |
| Funding charge | The Silverflow charge type of an AFT. |
| Low value exemption | Skipping 3-D Secure for payments under a threshold. |
| Merchant key | The Silverflow merchant, mct-…. |
| MID | Merchant ID: the merchant at the processor, often one per card brand. |
| Network transaction ID | The reference of the card scheme, used for recurring payments. |
| OCT | Original Credit Transaction: a payout to a card. |
| PAR | Payment Account Reference: one reference for a card account across its card numbers and tokens. |
| Settlement ID | The transaction reference in the Elavon settlement file. See Settlement IDs. |
| Soft decline | A decline in which the issuer asks for 3-D Secure; the payment is retried with it. |
| TID | Terminal ID, at the processor. |
| TLID | Mastercard's Transaction Link ID, linking the transactions of one payment. |
Fraud prevention
| Term | Meaning |
|---|---|
| Fraud rule | A block on payments of a project by BIN, BIN country, country, IP address or card. See Ginger fraud rules. |
| Report-only mode | The fraud provider decides, but Ginger never declines on its decision. See Fraud prevention. |
| Risk profile | The profile of the fraud provider that sets how strict its decision is, per project. |
APIs
| Term | Meaning |
|---|---|
| Admin API key | The API key of a project in your admin merchant, with permission on the platform APIs. See API keys. |
| Field permission | A read or write limit on a field of a project, for users. See Permissions. |
| JWKS | A published set of public keys, to verify signatures. See Gateway order API. |
| JWS | A signature of the body of a request or response. |
| Path permission | An API path pattern with the HTTP methods allowed on it. See Permissions. |
| Project API key | The API key of a project, sent as the username of HTTP Basic authentication with an empty password. |
search_ | The cursor to page through search results. See Search API. |
self | A placeholder in a path for the merchant, project or user of the caller. |
| Stream pointer | The last sequence number your system processed from the Stream API. |
| Token | The temporary credential of a logged-in user. See Log in with a username and password. |
| Trusted token | A token that lets a device skip multi-factor authentication for a while. |