hiqdev/Merchant – is a web application that provides payment processing API and UI hiqdev/Cashew – is an abstractions library over the payment processing
Both share the same terms:
| The term | meaning | example |
|---|---|---|
| Payment Page | a customizable UI for payments processing on hiqdev/Merchant | |
| POS | point of sale. Probably a Website | |
| Merchant | the POS owner. Can have multiple POS with different settings, but share customers' data | |
| Customer | a customer who is willing to spend some money | |
| Payment Request | a request from POS, that starts the transaction on a specific Payment Page | |
| Payment Method | is a mean of payment, where Customer holds some amount of money, he/she is willing to spend | Credit card, BTC wallet, PayPal balance, WebMoney Purse |
| Payment Provider | a 3rd party payment provider, that can process payments via the specific Payment Methods list | PayPal, Stripe, BitPay |
| Provider Account | credentials for a Payment Provider that can be used to interact with it | API keys, etc |
| Customer Remote Reference | represents a relationship between a Customer in the local database and a specific remote Provider Account | |
| Payment Flow | either HPP (stands for Hosted Payment Page), where the Customer will be redirected to proceed the payment; or Card – a Customer will be charged in a background, e.g. with periodic payments | HPP, Card |
| Payment Service | represents a combination of the Payment Method, the Currency and a Payment Flow for the payment processing | webmoneytransfer_usd_hpp |
| Route | is one of the options Customer can choose to transfer money with. Represents a combination of the Payment Service via the Provider Account | |
| Gateway | a set of Routes that can be assigned to different Payment Pages within one Merchant, so in case you need the same set of Routes for different Payment Pages you don't specify them twice. | |
| Payment Transaction | gets created when a Customer initiates a payment thorugh a specific Route at the Payment Page | |
| Payment Confirmation | gets created when a Payment Transaction receives a confirmation from the Payment Service. Holds a reference to a remote transaction ID. | |
| Payment Confirmation Notification | holds all the nessesary infomation about the success Payment Confirmation and gets transformed to a HTTP request in order to notify a POS about a success Payment Transaction | |
| Customer Card Token | masks a real card PAN and CVV using a secret token created at the Payment Service for a specific Customer Remote Reference |