Key concepts
| Term | Description |
|---|---|
| Cashier | The name of the BR-DGE product embedded into third party websites to facilitate customer deposit and withdrawal transactions. |
| Cashier instance | An instantiation of a Cashier with specific attributes to be served to a particular customer. A customer logging onto the website and choosing to deposit would be shown a deposit Cashier Instance, while another depositing customer would be shown a different Cashier Instance. |
| Transaction | A Transaction is created when a customer deposits or withdraws on the Cashier Instance. The Transaction represents the interaction with BR-DGE and the Payment Method to move funds. A Cashier Instance will typically have one associated Transaction, but may have more than one if a first Transaction fails and the customer retries. |
| Deposit | A Deposit is a type of Transaction where funds are transferred from the customer to the merchant using the Payment Method. This is also known as a Payment. |
| Withdrawal | A Withdrawal is a type of Transaction where funds are transferred from the merchant to the customer via a Payment Method. This is also known as a Payout. |
| Pre-validation | A step in processing a Deposit or Withdrawal before the Transaction is requested from the Payment Method. Pre-validation allows the merchant to indicate whether the Transaction should proceed, should be cancelled, or should be held for further checks. The pre-validation check is used as a fraud prevention tool, and for checking customer limits and closed loop compliance on the merchant’s side. |
| Notification | An asynchronous message that is sent from the Cashier to the merchant to provide information about some aspect of Transaction processing - these are sent independently of any synchronous API response. |
| Payment method | A mechanism that a customer can use to Deposit or Withdraw funds to and from a merchant - common Payment Methods are card, Google Pay, Apple Pay, PayPal. |
| Payment instrument | A set of details required for a particular customer to make a Transaction with a specific Payment Method. The Payment Instrument is the set of details that are passed from BR-DGE to the Payment Method and normally reflects the details that a customer understands they are interacting with - a card PAN, expiry date and CVV representing a physical card (the Payment Instrument represents the physical card); an account login representing a PayPal account. |
| Retail channel | A retail channel is a logical separation of transactions and configuration on the BR-DGE platform, to allow a merchant to have multiple different sets of transactions and configuration that function independently. Different retail channels might be used for different brands for a merchant, to keep transactions separated. |
| Payment Service Provider (PSP) | A service that processes card payments - typically a payment gateway. |
| Alternative Payment Method (APM) | An alternative to a traditional card payment method - common examples would be PayPal, Revolut Pay, Skrill. |