The merchant sells products to his customers, and receives a payment for it. In our language, the term includes also service providers, platforms, and marketplaces. As payment service provider (PSP), secupay cares for the payment and interacts with both, the merchant and his customer. The API offers an object called General Merchant to access merchant details.
Every merchant has a contract with secupay, or even multiple ones for different purposes. The API offers an object called General Contract to access the contract. The awkward details are managed behind the scenes by our system. What's important is that you will receive one or multiple General Contract IDs (GCR_xxx) and information how to use them. You need to manage to use the right contract ID for the right purpose.
A Smart Transaction manages a business transaction, like a purchase order for instance. If this includes one of our payment or loyalty services, it also manages the life cycle of the Payment Transaction or Loyalty Transactions. Furthermore it manages the checkout process, and can track the fullfilment of an order.
The Payment Transaction manages the payment process between secupay and your customer, as well as between secupay and you, the merchant. It is defined by the payer and the payee, the payment method and the amount, and if needed a number of options.
The Payment Customer holds customer data like name and address, e-mail and phone number. It can be used to set a billing address or delivery address. You can pass the customer details to the Smart Transaction. Then the Payment Customer is created for you. But you can also create it explicitely, and pass the object ID. Payment customers can be reused as long as the details did not change.
The Payment Container is an object that holds a payment instrument for you. It can be passed when you create a Payment Transaction, or when you let the Smart Transaction do this for you. Usually a Payment Container is associated with a Payment Customer, and can only be used together with it. Payment Containers can also be reused in order to offer the customer an express checkout experience.
A secucard is identified by a card ID, and can be secured by a card security code (CSC). There can be a physical card or not. The card may belong to a known card holder, or be used anonymously. It can be used for multiple merchants at the same time, having multiple loyalty programmes. Depending on the programme settings, it is used as personal loyalty card, gift card or discount voucher. Discount vouchers can be shared publicly as a marketing tool. There can also be acceptance points not belonging to the same merchant. The API object to mange the cards is called Loyalty Card.
The Merchant Card is an API object that manages the relation between the card, the merchant, the card programs and the acceptance points.
The Loyalty Customer is an API object, that can be associated to a Merchant Card to store the contact details of the card holder.