Getting Started

1
import com.kard.api.KardApiClient;
2
3
KardApiClient client = KardApiClient
4
    .withCredentials("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET")
5
    .build();

1
import com.kard.api.KardApiClient;
2
3
KardApiClient client = KardApiClient.builder()
4
    .token("your-access-token")
5
    .url("https://api.getkard.com")
6
    .build();

1
import com.kard.api.KardApiClient;
2
import com.kard.api.core.Environment;
3
4
KardApiClient client = KardApiClient.builder()
5
    .environment(Environment.Production)
6
    .build();

1
import com.kard.api.KardApiClient;
2
3
KardApiClient client = KardApiClient.builder()
4
    .url("https://example.com")
5
    .build();

1
import com.kard.api.KardApiClient;
2
import com.kard.api.resources.commons.types.EnrolledRewardsType;
3
import com.kard.api.resources.users.types.CreateUsersObject;
4
import com.kard.api.resources.users.types.UserRequestAttributes;
5
import com.kard.api.resources.users.types.UserRequestData;
6
import com.kard.api.resources.users.types.UserRequestDataUnion;
7
import java.util.Arrays;
8
9
KardApiClient client = KardApiClient
10
    .withCredentials("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET")
11
    .build();
12
13
client.users().create(
14
    "organization-123",
15
    CreateUsersObject.builder()
16
        .data(Arrays.asList(
17
            UserRequestDataUnion.user(
18
                UserRequestData.builder()
19
                    .id("1234567890")
20
                    .attributes(
21
                        UserRequestAttributes.builder()
22
                            .zipCode("11238")
23
                            .enrolledRewards(
24
                                Arrays.asList(EnrolledRewardsType.CARDLINKED)
25
                            )
26
                            .build()
27
                    )
28
                    .build()
29
            )
30
        ))
31
        .build()
32
);

1
import com.kard.api.KardApiClient;
2
import com.kard.api.resources.commons.types.EnrolledRewardsType;
3
import com.kard.api.resources.users.types.CreateUsersObject;
4
import com.kard.api.resources.users.types.UserRequestAttributes;
5
import com.kard.api.resources.users.types.UserRequestData;
6
import com.kard.api.resources.users.types.UserRequestDataUnion;
7
import com.kard.hem.HEM;
8
import java.util.Arrays;
9
10
KardApiClient client = KardApiClient
11
    .withCredentials("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET")
12
    .build();
13
14
String hashedEmail = HEM.generateHEM("Jane.Doe+work@gmail.com");
15
16
client.users().create(
17
    "organization-123",
18
    CreateUsersObject.builder()
19
        .data(Arrays.asList(
20
            UserRequestDataUnion.user(
21
                UserRequestData.builder()
22
                    .id("1234567890")
23
                    .attributes(
24
                        UserRequestAttributes.builder()
25
                            .enrolledRewards(
26
                                Arrays.asList(EnrolledRewardsType.CARDLINKED)
27
                            )
28
                            .hashedEmail(hashedEmail)
29
                            .build()
30
                    )
31
                    .build()
32
            )
33
        ))
34
        .build()
35
);

1
import com.kard.api.KardApiClient;
2
import com.kard.api.resources.users.rewards.types.ComponentType;
3
import java.util.Arrays;
4
5
KardApiClient client = KardApiClient
6
    .withCredentials("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET")
7
    .build();
8
9
client.users().rewards().offers(
10
    "organization-123",
11
    "1234567890",
12
    GetOffersByUserRequest.builder()
13
        .pageSize(1)
14
        .filterIsTargeted(true)
15
        .sort("-startDate")
16
        .supportedComponents(Arrays.asList(
17
            ComponentType.SHORT_DESCRIPTION,
18
            ComponentType.LONG_DESCRIPTION,
19
            ComponentType.CTA,
20
            ComponentType.TAGS,
21
            ComponentType.DETAIL_TAGS,
22
            ComponentType.BASE_REWARD
23
        ))
24
        .build()
25
);

1
import com.kard.api.KardApiClient;
2
import com.kard.api.resources.transactions.types.*;
3
import java.util.Arrays;
4
5
KardApiClient client = KardApiClient
6
    .withCredentials("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET")
7
    .build();
8
9
client.transactions().create(
10
    "organization-123",
11
    CreateTransactionsObject.builder()
12
        .data(Arrays.asList(
13
            TransactionsDataUnion.transaction(
14
                TransactionsData.builder()
15
                    .id("12345610")
16
                    .attributes(
17
                        TransactionsAttributes.builder()
18
                            .userId("1234567890")
19
                            .amount(1000)
20
                            .subtotal(800)
21
                            .status("APPROVED")
22
                            .currency("USD")
23
                            .description("ADVANCEAUTO")
24
                            .authorizationDate("2021-07-02T17:47:06Z")
25
                            .paymentType("CARD")
26
                            .direction("DEBIT")
27
                            .merchant(
28
                                Merchant.builder()
29
                                    .id("12345678901234567")
30
                                    .name("ADVANCEAUTO")
31
                                    .addrStreet("125 Main St")
32
                                    .addrCity("Philadelphia")
33
                                    .addrState("PA")
34
                                    .addrZipcode("19147")
35
                                    .addrCountry("United States")
36
                                    .latitude("37.9419429")
37
                                    .longitude("-73.1446869")
38
                                    .storeId("12345")
39
                                    .build()
40
                            )
41
                            .cardBIN("123456")
42
                            .cardLastFour("4321")
43
                            .authorizationCode("123456")
44
                            .retrievalReferenceNumber("100804333919")
45
                            .systemTraceAuditNumber("333828")
46
                            .acquirerReferenceNumber("1234567890123456789012345678")
47
                            .transactionId("12345611")
48
                            .build()
49
                    )
50
                    .build()
51
            )
52
        ))
53
        .build()
54
);

1
import com.kard.api.core.KardApiApiException;
2
3
try {
4
    client.users().create(...);
5
} catch (KardApiApiException e) {
6
    System.out.println("Status: " + e.statusCode());
7
    System.out.println("Body: " + e.body());
8
}

1
import com.kard.api.KardApiClient;
2
3
KardApiClient client = KardApiClient.builder()
4
    .maxRetries(1)
5
    .build();

1
import com.kard.api.KardApiClient;
2
import com.kard.api.core.RequestOptions;
3
4
// Client level
5
KardApiClient client = KardApiClient.builder()
6
    .timeout(30)
7
    .build();
8
9
// Request level
10
client.users().create(
11
    ...,
12
    RequestOptions.builder()
13
        .timeout(30)
14
        .build()
15
);

1
import com.kard.api.KardApiClient;
2
import com.kard.api.core.RequestOptions;
3
4
// Client level
5
KardApiClient client = KardApiClient.builder()
6
    .addHeader("X-Custom-Header", "custom-value")
7
    .build();
8
9
// Request level
10
client.users().create(
11
    ...,
12
    RequestOptions.builder()
13
        .addHeader("X-Request-Header", "request-value")
14
        .build()
15
);

1
CreateHttpResponse response = client.users().withRawResponse().create(...);
2
3
System.out.println(response.body());
4
System.out.println(response.headers().get("X-My-Header"));

1
import com.kard.api.KardApiClient;
2
import okhttp3.OkHttpClient;
3
4
OkHttpClient customClient = new OkHttpClient.Builder()
5
    .connectTimeout(30, java.util.concurrent.TimeUnit.SECONDS)
6
    .build();
7
8
KardApiClient client = KardApiClient.builder()
9
    .httpClient(customClient)
10
    .build();