Skip to content

Customer Information

This endpoint gets information on the customer.

1
GET /customers/<token>

Input Parameters

Path Param Type Required Description
token string Required The security token for the customer

Output

This endpoint returns a Customer object.

Property Type Description
isOptedIn boolean Whether or not the customer has opted-in to the program.
pageLoadBeacon string A beacon that should be triggered when a page loads
totalEarned float The total lifetime earnings of this customer
accounts Account[] A collection of customer's accounts
program Program Details about the rewards program this customer is enrolled in

Example

Request

1
GET /api/v1/customers/C1FA3C38-1B28-4B54-A2F8-E577FFEEF9F5

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
      "isOptedIn" : true,
      "pageLoadBeacon" : "http://example.com/beacon/pageload",
      "totalEarned" : 722.98,
      "accounts" : [
              {
                  "accountId" : 937690653,
                  "sourceAccountId" : "70840204",
                  "name" : "Joe's Checking Account",
                  "isPrimary" : true,
                  "portfolioName" : "Checks and Balances Checking",
                  "portfolioId" : 1776
              }
        ],
        "program" : {
              "name" : "Super Bank Rewards Program",
              "title" : "Super Bank",
              "tagline" : "Earn cash back on special purchases!",
              "description" : "Foo",
              "cultureName" : "en-US",
              "currencyUnit" : "cash",
              "currencyExchangeRate" : 1.0,
        "isCashAccount": true
        }
}