Get Earned Rewards

1 curl -G https://rewards-api.getkard.com/v2/issuers/org-123/users/user-456/earned-rewards \ 2 -H "Authorization: Bearer <token>" \ 3 -d "page[size]=10"

1 { 2 "data": [ 3 { 4 "type": "rewardedTransaction", 5 "attributes": { 6 "status": "SETTLED", 7 "transactionId": "TXN-20241001-F21-127964", 8 "transactionAmountInCents": 12796, 9 "transactionTimestamp": "2024-10-01T01:36:57Z", 10 "paidToIssuer": "UNPAID", 11 "commissionEarned": { 12 "issuer": { 13 "type": "cents", 14 "value": 102 15 }, 16 "user": { 17 "type": "cents", 18 "value": 320 19 } 20 }, 21 "payoutTimestamp": "2024-10-01T02:00:00Z", 22 "cardBIN": "123456", 23 "cardLastFour": "4321" 24 }, 25 "id": "fcabf024-3870-41f3-9fbd-b43ea85a3d19", 26 "relationships": { 27 "user": { 28 "data": { 29 "type": "user", 30 "id": "8c52423a-c319-44ee-8fc7-508e97b43892" 31 } 32 }, 33 "merchant": { 34 "data": { 35 "type": "merchant", 36 "id": "633ed2ab30dcb60009dd5699" 37 } 38 }, 39 "offer": { 40 "data": { 41 "type": "offer", 42 "id": "OFF-F21-INSTORE-2024Q4-001" 43 } 44 } 45 } 46 } 47 ], 48 "links": { 49 "self": "/v2/issuers/org-123/users/user-456/earned-rewards?page[size]=10", 50 "next": "/v2/issuers/org-123/users/user-456/earned-rewards?page[size]=10&page[after]=eyJpZCI6ImZjYWJmMDI0LTM4NzAtNDFmMy05ZmJkLWI0M2VhODVhM2QxOSIsInRzIjoiMjAyNC0xMC0wMVQwMTozNjo1N1oifQ==" 51 }, 52 "included": [ 53 { 54 "type": "merchant", 55 "attributes": { 56 "name": "Forever 21" 57 }, 58 "id": "633ed2ab30dcb60009dd5699" 59 }, 60 { 61 "type": "merchant", 62 "attributes": { 63 "name": "Target" 64 }, 65 "id": "5f3e2d1c40abc50008cc4821" 66 }, 67 { 68 "type": "offer", 69 "attributes": { 70 "purchaseChannel": [ 71 "INSTORE" 72 ] 73 }, 74 "id": "OFF-F21-INSTORE-2024Q4-001" 75 }, 76 { 77 "type": "offer", 78 "attributes": { 79 "purchaseChannel": [ 80 "ONLINE" 81 ] 82 }, 83 "id": "OFF-TGT-ONLINE-2024Q4-002" 84 } 85 ] 86 }

Retrieve rewarded transaction history for a specific user. Returns only SETTLED transactions within the last 12 months.

Required scopes: transaction:read

Query Limit: Maximum of 12 months of transaction data can be queried.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

organizationIdstringRequired

Your issuer organization ID, provided by Kard

userIdstringRequired

The ID of the user as defined on the issuers system

Query Parameters

page[after]stringOptional

Cursor for next page (base64-encoded timestamp + transaction ID)

page[before]stringOptional

Cursor for previous page (base64-encoded timestamp + transaction ID)

page[size]integerOptional

Number of results per page

Response

This endpoint returns an object.

datalist of objects

linksobject

Authentication

Path Parameters

Query Parameters

Response

Errors