Getting Started

1
import { KardApiClient } from "@kard-financial/sdk";
2
3
const client = new KardApiClient({
4
  clientId: "YOUR_CLIENT_ID",
5
  clientSecret: "YOUR_CLIENT_SECRET",
6
});

1
import { KardApiClient } from "@kard-financial/sdk";
2
3
const client = new KardApiClient();

1
import { KardApiClient } from "@kard-financial/sdk";
2
3
const client = new KardApiClient({
4
  clientId: "YOUR_CLIENT_ID",
5
  clientSecret: "YOUR_CLIENT_SECRET",
6
});
7
8
await client.users.create("organization-123", {
9
    data: [{
10
            type: "user",
11
            id: "1234567890",
12
            attributes: {
13
                zipCode: "11238",
14
                enrolledRewards: ["CARDLINKED"]
15
            }
16
        }]
17
});

1
import { KardApiClient } from "@kard-financial/sdk";
2
import { generateHEM } from "@kard-financial/sdk/helpers/hem";
3
4
const client = new KardApiClient({
5
  clientId: "YOUR_CLIENT_ID",
6
  clientSecret: "YOUR_CLIENT_SECRET",
7
});
8
9
const hashedEmail = generateHEM("Jane.Doe+work@gmail.com");
10
11
await client.users.create("organization-123", {
12
    data: [{
13
        type: "user",
14
        id: "1234567890",
15
        attributes: {
16
            enrolledRewards: ["CARDLINKED"],
17
            hashedEmail: hashedEmail,
18
        }
19
    }]
20
});

1
import { KardApiClient } from "@kard-financial/sdk";
2
3
const client = new KardApiClient({
4
  clientId: "YOUR_CLIENT_ID",
5
  clientSecret: "YOUR_CLIENT_SECRET",
6
});
7
8
await client.users.rewards.offers("organization-123", "user-123", {
9
    "page[size]": 1,
10
    "filter[isTargeted]": true,
11
    sort: "-startDate",
12
    supportedComponents: [
13
        "shortDescription",
14
        "longDescription",
15
        "cta",
16
        "tags",
17
        "detailTags",
18
        "baseReward"
19
    ],
20
});

1
import { KardApiClient } from "@kard-financial/sdk";
2
3
const client = new KardApiClient({
4
  clientId: "YOUR_CLIENT_ID",
5
  clientSecret: "YOUR_CLIENT_SECRET",
6
});
7
8
await client.transactions.create("organization-123", {
9
    data: [{
10
            type: "transaction",
11
            id: "12345610",
12
            attributes: {
13
                userId: "1234567890",
14
                amount: 1000,
15
                status: "APPROVED",
16
                currency: "USD",
17
                description: "ADVANCEAUTO",
18
                cardBIN: "123456",
19
                cardLastFour: "4321",
20
                direction: "DEBIT",
21
                paymentType: "CARD",
22
                transactionId: "12345611",
23
                subtotal: 800,
24
                description2: "ADVANCEAUTO",
25
                mcc: "1234",
26
                authorizationDate: "2021-07-02T17:47:06Z",
27
                merchant: {
28
                    name: "ADVANCEAUTO",
29
                    id: "12345678901234567",
30
                    addrStreet: "125 Main St",
31
                    addrCity: "Philadelphia",
32
                    addrState: "PA",
33
                    addrZipcode: "19147",
34
                    addrCountry: "United States",
35
                    latitude: "37.9419429",
36
                    longitude: "-73.1446869",
37
                    storeId: "12345"
38
                },
39
                authorizationCode: "123456",
40
                retrievalReferenceNumber: "100804333919",
41
                systemTraceAuditNumber: "333828",
42
                acquirerReferenceNumber: "1234567890123456789012345678",
43
                processorMids: {
44
                    processor: "VISA",
45
                    mids: {
46
                        vmid: "12345678901",
47
                        vsid: "12345678"
48
                    }
49
                }
50
            }
51
        }]
52
});

1
import { KardApi } from "@kard-financial/sdk";
2
3
const request: KardApi.GetTokenRequest = {
4
    ...
5
};

1
import { KardApiError } from "@kard-financial/sdk";
2
3
try {
4
  await client.users.create(...);
5
} catch (err) {
6
  if (err instanceof KardApiError) {
7
    console.error("Status:", err.statusCode);
8
    console.error("Message:", err.message);
9
    console.error("Body:", err.body);
10
  }
11
}

1
const response = await client.users.create(..., {
2
    headers: {
3
        'X-Custom-Header': 'custom value'
4
    }
5
});

1
const response = await client.users.create(..., {
2
    queryParams: {
3
        'customQueryParamKey': 'custom query param value'
4
    }
5
});

1
const response = await client.users.create(..., {
2
    maxRetries: 0 
3
});

1
const response = await client.users.create(..., {
2
    timeoutInSeconds: 30 
3
});

1
const controller = new AbortController();
2
const response = await client.users.create(..., {
3
    abortSignal: controller.signal
4
});
5
controller.abort();

1
const { data, rawResponse } = await client.users.create(...).withRawResponse();
2
console.log(data);
3
console.log(rawResponse.headers['X-My-Header']);

1
import { KardApiClient, logging } from "@kard-financial/sdk";
2
3
const client = new KardApiClient({
4
    ...
5
    logging: {
6
        level: logging.LogLevel.Debug, 
7
        logger: new logging.ConsoleLogger(), 
8
        silent: false,
9
    }
10
});

1
import { KardApiClient } from "@kard-financial/sdk";
2
3
const client = new KardApiClient({
4
    ...
5
    fetcher:
6
});