For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Get supportSee a Demo
HomeAPI Reference
HomeAPI Reference
    • Authentication
  • API Reference
      • POSTEarned Reward Webhook
Get supportSee a Demo
API ReferenceWebhooks

Earned Reward Webhook

Payload
1{
2  "user": {
3    "referringPartnerUserId": "some-referring-partner-user-id"
4  },
5  "card": {
6    "bin": "123443",
7    "last4": "4567",
8    "network": "VISA"
9  },
10  "reward": {
11    "merchantId": "some-merchant-id",
12    "name": "Merchant Name",
13    "commissionToIssuer": 112,
14    "commissionSplit": {
15      "issuersCommissionInCents": 40,
16      "usersCommissionInCents": 72
17    },
18    "status": "APPROVED",
19    "type": "CARDLINKED"
20  },
21  "transaction": {
22    "issuerTransactionId": "some-transaction-id",
23    "status": "APPROVED",
24    "transactionAmountInCents": 1000,
25    "transactionTimeStamp": "2021-04-08T03:29:23.000+00:00"
26  },
27  "postDineInLinkURL": "http://www.somemerchant.com/postdineinlinkurl"
28}
This is an outbound webhook for issuers to receive notifications from Kard on transactions that earn rewards. Learn more about how to configure, ingest and trigger your earned reward webhooks [here](https://github.com/kard-financial/kard-postman#d-trigger-an-earned-reward-webhook).
Was this page helpful?
Previous
Built with

This is an outbound webhook for issuers to receive notifications from Kard on transactions that earn rewards. Learn more about how to configure, ingest and trigger your earned reward webhooks here.

Payload

The payload of this webhook request is an object.
userobjectRequired
Information about user that is earning reward
cardobjectRequired
Information about card associated with transaction that is earning reward
rewardobjectRequired
Information about reward earned
transactionobjectRequired
Information about transaction that is earning reward
postDineInLinkURLstringOptional
Post Dine In Survey Link URL, if available. This will be present for rewards associated with local offers
errorstringOptionalDeprecated
Error, if available

Response

200
any
Return a 200 status to indicate that the data was received successfully.