For any question, we are one click away

Contact us
Search by keyword
/

Antamivi loyalty program

Overview

Antamivi is a loyalty program in which loyalty points are awarded for daily transactions with Bank of Cyprus cards. Payment gateway allows to you to redeem bonus points when paying with cards involved in this program.

This functionality requires a special permission.

Usage scenarios

Inputting payment data on Payment Gateway side

sequenceDiagram participant C as Customer participant OS as Online Store participant PG as Payment Gateway autonumber C ->> OS: Forming an Order OS ->> PG: Registering the Order PG -->> OS: orderId, formUrl OS -->> C: Redirecting to the card data collection form C ->> PG: Sending the card data PG ->> PG: Interaction with Antamivi PG -->> C: Displaying available points C ->> PG: Choosing to use the points PG ->> PG: Making the payment
and redeeming the points PG -->> C: Displaying payment result OS ->> PG: Checking the status PG -->> OS: Status of the Order
with loyalty information
  1. A customer initiates payment.
  2. The online store server requests an order registration by sending the register.do API call to Payment Gateway.
  3. In response to the registration request, Payment Gateway returns a unique identifier of the order in the payment system and the URL to redirect the client to the form for card data collection.
  4. The online store redirects the customer to the form for card data collection.
  5. The customer enters the card data or selects the stored card and clicks Pay.
  6. Payment Gateway interacts with Antamivi system to find out the available discount, vouchers, and the number of redeemable points.

  7. Payment Gateway displays the page with available discount, vouchers, and redeemable points to the customer.

  8. The customer chooses to use the redeemable points (the discounts cannot be refused).

  9. Payment Gateway performs the payment with redeeming loyalty points.

  10. The customer is redirected to the online store page.

  11. (Optionally) The online store sends the getOrderStatusExtended.do request to Payment Gateway to check the order status and make sure the order is really paid.

  12. In response, Payment Gateway returns the order status data, including the loyaltyOrderInfo block with the information about redeemed loyalty points.

Inputting payment data on the merchant’s side

Registration and payment via instantPayment.do

sequenceDiagram participant C as Customer participant OS as Online Store participant PG as Payment Gateway autonumber C ->> OS: Forming an Order OS -->> C: Opening payment page C ->> OS: Sending the card data OS ->> PG: checkLoyalty.do PG ->> PG: Assigning loyaltyUuid PG ->> PG: Checking Antamivi involvment PG ->> PG: Interaction with Antamivi PG -->> OS: response to checkLoyalty.do OS -->> C: Displaying available points C ->> OS: Chooses to use the points OS ->> PG: instantPayment.do PG ->> PG: Making the payment
and redeeming the points PG -->> OS: response to instantPayment.do OS -->> C: Displaying payment result OS ->> PG: Checking the status PG -->> OS: Status of the Order
with loyalty information
  1. A customer initiates payment.
  2. The online store server receives a purchase request and opens a payment page.
  3. The customer enters their card details on the online store payment page.
  4. The merchant sends checkLoyalty.do request to Payment Gateway in order to check that the card is involved into Antamivi loyalty program and to find out the available loyalty points number.
  5. Payment Gateway assigns loyaltyUuid (identifier of loyalty calculation) to the order.
  6. Payment Gateway checks that the card is involved into Antamivi loyalty program.
  7. Payment Gateway interacts with Antamivi system to find out the available discount, voucher, and the number of redeemable points.
  8. Payment Gateway sends the response to the request with available discount, voucher, redeemable points.
  9. The merchant displays the page with available discount, voucher, redeemable points to the customer.
  10. The customer chooses to use redeemable points (the discounts cannot be refused).

  11. The merchant requests an order registration and initiates payment by sending the instantPayment.do request to Payment Gateway, specifying loyaltyUuid and the indication of the client's refusal to use the maximum number of available loyalty points.

  12. Payment Gateway performs the payment with redeeming loyalty points.

  13. Response to the request.

  14. The online store page displays payment result to the customer.

  15. (Optionally) The online store sends the getOrderStatusExtended.do request to Payment Gateway to check the order status and make sure the order is really paid.

  16. In response, Payment Gateway returns the order status data, including the loyaltyOrderInfo block with the information about redeemed loyalty points.

Payment by stored credential via paymentOrderBinding.do

sequenceDiagram participant C as Customer participant OS as Online Store participant PG as Payment Gateway autonumber C ->> OS: Forming an Order OS -->> C: Opening payment page C ->> OS: Sending the card data OS ->> PG: Registering the Order PG -->> OS: orderId OS ->> PG: checkLoyalty.do PG ->> PG: Assigning loyaltyUuid PG ->> PG: Checking Antamivi involvment PG ->> PG: Interaction with Antamivi PG -->> OS: response to checkLoyalty.do OS -->> C: Displaying available points C ->> OS: Chooses to use the points OS ->> PG: paymentOrderBinding.do PG ->> PG: Making the payment
and redeeming the points PG -->> OS: response to paymentOrderBinding.do OS -->> C: Displaying payment result OS ->> PG: Checking the status PG -->> OS: Status of the Order
with loyalty information
  1. A customer initiates payment.
  2. The online store server receives a purchase request and opens a payment page.
  3. The customer enters their card details or selects a stored card on the online store payment page.
  4. The online store server requests an order registration by sending the register.do API call to Payment Gateway with specifying clientId (for storing a credential) or bindingId (for existing stored credential).
  5. In response to the registration request, Payment Gateway returns a unique identifier of the order.
  6. The merchant sends checkLoyalty.do request to Payment Gateway in order to check that the card is involved into Antamivi loyalty program and to find out the available loyalty points number. The request contains bindingId - stored credential identifier and mdOrder - the order identifier received at step 5.
  7. Payment Gateway assigns loyaltyUuid (identifier of loyalty calculation) to the order.
  8. Payment Gateway checks that the card is involved into Antamivi loyalty program.
  9. Payment Gateway interacts with Antamivi system to find out the available discount, voucher, and the number of redeemable points.
  10. Payment Gateway sends the response to the request with available discount, voucher, redeemable points.
  11. The merchant displays the page with available discount, voucher, redeemable points to the customer.
  12. The customer chooses to use redeemable points (the discounts cannot be refused).

  13. The merchant initiates stored credential payment by sending the paymentOrderBinding.do request to Payment Gateway, specifying loyaltyUuid and the indication of the client's refusal to use the maximum number of available loyalty points.

  14. Payment Gateway performs the payment with redeeming loyalty points.

  15. Response to the request.

  16. The online store page displays payment result to the customer.

  17. (Optionally) The online store sends the getOrderStatusExtended.do request to Payment Gateway to check the order status and make sure the order is really paid.

  18. In response, Payment Gateway returns the order status data, including the loyaltyOrderInfo block with the information about redeemed loyalty points.

Categories:
eCommerce API V1
Categories
Search results
Navigate
Select
Close
Categories
Search results