B2B Customer Care - Loyalty

processExternalActivity

Processes the activity of an external loyalty program.

POST URL/b2b-gateway/loyalty/activities

The details of how the program is administered are set during onboarding. Principals used to login to these B2B endpoints must have the LOYALTY_CUSTOMER_ADMIN permission in one of their Roles.

In the sample here, a one-time award of points are added to a customer’s account using the ONDEMAND_AWARD designation.

Request

Attribute Description
b2bRequest Required B2bRequest
Identifies the request to the B2B Gateway.
issuingPartnerUri Required String
The unique identifier of the Paydiant partner that issued the mobile payments app where the wallet is registered.
partnerUri Required String
The unique identifier of the Paydiant partner under which the issuer is registered.
customerUri Required String
The unique identifier of a registered mobile wallet user.
externalActivity Required LoyaltyExternalActivity
Defines the details of how the external loyalty program operates.

Response

Attribute Description
b2bResponse Required B2bResponse
Identifies the response from the B2B Gateway.
activityResults Required LoyaltyAccrualActivityResult
Describes the Loyalty program activity being returned.

queryActivities

Used to return loyalty information about an external loyalty program.

POST URL/b2b-gateway/loyalty/activities/search

You can return all the external loyalty transactions for a customer/issuing partner/partner or filter on the activity type, points status, or reference IDs to locate individual transactions.

Request

Attribute Description
queryRequest Required QueryRequest
Extends the b2bRequest to add query parameters.
issuingPartnerUri Required String
The unique identifier of the Paydiant partner that issued the mobile payments app where the wallet is registered.
partnerUri Required String
The unique identifier of the Paydiant partner under which the issuer is registered.
customerUri Required String
The unique identifier of a registered mobile wallet user.

The following are Optional search parameters:

Attribute Description
accrualActivityEventType Optional Enum
Identifies the kind of accrual activity you want to filter the results by. Valid values are:
GAME_LEVEL_REACHED
SOCIAL_NETWORKING
ONDEMAND_AWARD
pointsPostStatus Optional Enum
Indicates the status of the points. Valid values are:
POSTED
PENDING
FAILED
CANCELLED
paydiantRefId Optional String
A unique transaction identifier generated by the Paydiant service.
externalRefId Optional String
A transaction identifier generated by the external loyalty program.

Response

Attribute Description
b2bResponse Required B2bResponse
Identifies the response from the B2B Gateway.
activityResults Optional Object
Lists the LoyaltyAccrualActivityResult for the returned transactions or customers.