Apple Pay Notification Guide

Summary

This guide aims to help Shaype Clients understand Apple Pay Notifications they will receive and how transactions are captured.

Reminder notifications schedule will be started when a customer starts the process of adding their card to a digital wallet. The first notification will be to remind the customer to complete the process and then to spend their first transaction using Apple Pay.

After the reminders if a condition is met (provisioned completed or spent on apple pay token) after the reminder, then Shaype will post a notification with the type APPLE_PAY_REWARD_FOR_CUSTOMER indicating the client should carry out the reward transaction to their customers account.

Customer Reward Notification

Shaype has added a new Event Field and type:

NotificationEventType.APPLE_PAY_REWARD_FOR_CUSTOMER

as well as:

NotificationDto the new field applePayRewardForCustomerEvent of type:
ApplePayRewardForCustomerEventDto

@ApiModel(
    description =
        "Details of the **Apple Pay Reward For Customer** event; provided when the type "
            + "is `APPLE_PAY_REWARD_FOR_CUSTOMER`.")
public class ApplePayRewardForCustomerEventDto {

  @ApiModelProperty(value = "Account Id")
  UUID accountId;

  @ApiModelProperty(value = "Card Id")
  UUID cardId;
}

Reward Transactions

To reward the customer, clients must use the [POST/v1/transactions/credit] API when funding the account. To complete the funding we ask that the Transaction Channel APPLE_REWARD is used.

Apple Pay Notification Scenarios

When the customer started to provision a digital wallet but did not complete the process:

• APPLE_PAY_REMINDER_24_HRS
• APPLE_PAY_REMINDER_7_DAYS

And when the customer has completed provisioning their card successfully but has not yet made an apple pay transaction:

• APPLE_PAY_SPEND_REMINDER_7_DAYS
• APPLE_PAY_SPEND_REMINDER_14_DAYS

When the customer is due a Apple Reward:

• APPLE_PAY_REWARD_FOR_CUSTOMER

Notification Events Examples

APPLE_PAY_REMINDER_24_HRS

{
  "customerHayId": "e818093c-4bd6-4dbc-b054-66318a55a587",
  "idempotencyKey": "23b39dc5-e283-40c7-9a95-1c204610b152",
  "type": "REMINDER",
  "reminderType": "APPLE_PAY_REMINDER_24_HRS"
}

APPLE_PAY_REMINDER_7_Days

{
  "customerHayId": "e818093c-4bd6-4dbc-b054-66318a55a587",
  "idempotencyKey": "7ed153c1-e1f9-4305-a92c-0b30e1c56b20",
  "type": "CARD_ADDED_TO_WALLET",
  "cardAdditionToWalletEvent": {
    "cardHayId": "b91826b8-78f2-4d36-bfb4-a4139cee591e",
    "cardLastFourDigits": "7927",
    "walletType": "APPLE_WALLET"
  }
}

CARD_ADDED_TO_WALLET

{  
  "customerHayId": "e818093c-4bd6-4dbc-b054-66318a55a587",  
  "idempotencyKey": "7ed153c1-e1f9-4305-a92c-0b30e1c56b20",  
  "type": "CARD_ADDED_TO_WALLET",  
  "cardAdditionToWalletEvent": {  
    "cardHayId": "b91826b8-78f2-4d36-bfb4-a4139cee591e",  
    "cardLastFourDigits": "7927",  
    "walletType": "APPLE_WALLET"  
  }  
}

APPLE_PAY_SPEND_REMINDER_7_DAYS

{
  "customerHayId": "203d1dda-5665-440a-a757-102519fb0da8",
  "idempotencyKey": "bf3506c2-3781-44b8-8304-e1cc89e10ad2",
  "type": "REMINDER",
  "reminderType": "APPLE_PAY_SPEND_REMINDER_7_DAYS"
}

APPLE_PAY_SPEND_REMINDER_14_DAYS

{
  "customerHayId": "203d1dda-5665-440a-a757-102519fb0da8",
  "idempotencyKey": "84f96abf-2ea5-4eea-bd63-d2257f5947a6",
  "type": "REMINDER",
  "reminderType": "APPLE_PAY_SPEND_REMINDER_14_DAYS"
}

APPLE_PAY_REWARD_FOR_CUSTOMER

{
  "customerHayId": "203d1dda-5665-440a-a757-102519fb0da8",
  "idempotencyKey": "bf3506c2-3781-44b8-8304-e1cc89e10ad2",
  "type": "APPLE_PAY_REWARD_FOR_CUSTOMER",
  "applePayRewardForCustomerEvent": {
    "accountId": "b91826b8-78f2-4d36-bfb4-a4139cee591e",
    "cardId": "bac20509-f094-470d-a65f-794b58e88f37"
  }
}