Logo
Get supportSee a Demo
HomeAPI Reference
HomeAPI Reference
    • Authentication
  • API Reference
Get supportSee a Demo
API ReferenceTransactions

POST
/transactions/incoming
POST
/transactions/incoming
1curl -X POST https://rewards-api.getkard.com/transactions/incoming \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '[
5  {
6    "transactionId": "asdlkfjalksdf0t-dsfdfsdfsdkajsldkf",
7    "referringPartnerUserId": "6FHt5b6Fnp0qdomMEy5AN6PXcSJIeX69",
8    "amount": 1000,
9    "status": "APPROVED",
10    "currency": "USD",
11    "description": "ADVANCEAUTO",
12    "description2": "ADVANCEAUTO",
13    "mcc": "1234",
14    "authorizationDate": "2021-07-02T17:47:06Z",
15    "merchantId": "123456789101213",
16    "merchantName": "ADVANCEAUTO",
17    "merchantAddrCity": "Philadephia",
18    "merchantAddrState": "PA",
19    "merchantAddrZipcode": "19147",
20    "merchantAddrCountry": "United States",
21    "merchantAddrStreet": "125 Main St",
22    "merchantLat": "37.9419429",
23    "merchantLong": "-73.1446869",
24    "cardBIN": "123456",
25    "cardLastFour": "4321",
26    "authorizationCode": "123456",
27    "retrievalReferenceNumber": "100804333919",
28    "systemTraceAuditNumber": "333828",
29    "acquirerReferenceNumber": "1234567890123456789012345678",
30    "isDeposit": false
31  }
32]'
Try it
1"Incoming Transaction event successfully queued for processing"
Was this page helpful?
Previous

Create Audit

Next
Built with
Call this endpoint to send all incoming transactions made by all enrolled users in your rewards program. These incoming transactions will be processed and matched by the Kard system. Learn more about the [Transaction CLO Matching](https://github.com/kard-financial/kard-postman#c-transaction-clo-matching) flow here.<br/> <b>Required scopes:</b> `transaction:write`
Create Incoming Transaction

Authentication

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

Request

This endpoint expects a list of objects.
transactionIdstringRequired
Transaction ID in issuer's system
referringPartnerUserIdstringRequired
Referring partner user ID from issuer associated with transaction
amountintegerRequired
Transaction amount in cents
statusenumRequired
Transaction status
Allowed values:
currencystringRequired
Currency of transaction
descriptionstringRequired
Description of transaction - usually includes merchant and other key details on transaction
description2stringOptional
Description2 of transaction — usually includes other merchant identifying information
mccstringOptional
Merchant Category Code (usually a 4-digit numerical number). <b>Note, this field is REQUIRED for SOME national offers. We HIGHLY RECOMMEND sending this field as it will be required in the near future.</b>
coreProviderIdstringOptional
Name of processor associated with transaction
transactionDatedatetimeOptional
Timestamp for <b>REVERSED, RETURNED, DECLINED</b> transaction events; <b>REQUIRED</b> for transactions with <b>REVERSED, RETURNED, DECLINED</b> status. Date string should be in ISO format i.e.`'YYYY-MM-DDThh:mm:ss.sTZD'` where TZD = time zone designator (Z or +hh:mm or -hh:mm) i.e. `1994-11-05T08:15:30-05:00` OR `1994-11-05T08:15:30Z`
authorizationDatedatetimeOptional
Timestamp for <b>APPROVED</b> transaction event; <b>REQUIRED</b> for transactions with <b>APPROVED</b> status, and <b>HIGHLY RECOMMENDED</b> to include for transactions with a <b>SETTLED</b> status. Date string should be in ISO format i.e.`'YYYY-MM-DDThh:mm:ss.sTZD'` where TZD = time zone designator (Z or +hh:mm or -hh:mm) i.e. `1994-11-05T08:15:30-05:00 OR 1994-11-05T08:15:30Z`
settledDatedatetimeOptional
Timestamp for <b>SETTLED</b> transaction event, <b>REQUIRED</b> for transactions with <b>SETTLED</b> status. Date string should be in ISO format i.e.`'YYYY-MM-DDThh:mm:ss.sTZD'` where TZD = time zone designator (Z or +hh:mm or -hh:mm) i.e. `1994-11-05T08:15:30-05:00` OR `1994-11-05T08:15:30Z`
merchantIdstringOptional
Acquirer Merchant Identification Number (MID) — usually a 15 digit numerical identifier code. <b>Note, this field is REQUIRED for local offers. We HIGHLY RECOMMEND sending this field as it will be required in the near future.</b>
merchantStoreIdstringOptional
Merchant store ID where transaction originated from
cardPresencestringOptional
Whether card was present at time of transaction
merchantNamestringOptional
Merchant name associated with transaction
merchantAddrCitystringOptional
Merchant address city associated with transaction. <b>We HIGHLY RECOMMEND sending this field as it may be required in the near future.</b>
merchantAddrStateenumOptional
Merchant address state associated with transaction. <b>We HIGHLY RECOMMEND sending this field as it may be required in the near future.</b>
merchantAddrZipcodestringOptional
Merchant address zip code associated with transaction. <b>We HIGHLY RECOMMEND sending this field as it may be required in the near future.</b>
merchantAddrCountrystringOptional
Merchant address country associated with transaction. <b>We HIGHLY RECOMMEND sending this field as it may be required in the near future.</b>
merchantAddrStreetstringOptional
Merchant street address associated with transaction. <b>We HIGHLY RECOMMEND sending this field as it may be required in the near future.</b>
merchantLatstringOptional
Merchant latitude geocoordinate associated with transaction. <b>We HIGHLY RECOMMEND sending this field as it may be required in the near future.</b>
merchantLongstringOptional
Merchant longitude geocoordinate associated with transaction. <b>We HIGHLY RECOMMEND sending this field as it may be required in the near future.</b>
panEntryModestringOptional
PAN entry mode (usually a 2 digit numeric code)
cardBINstringOptional
Bank identification number (BIN). Must be a valid BIN of 6 digits. If over 6 digits, please send first 6. <b>Note, this field is REQUIRED for matching purposes.</b>
cardLastFourstringOptional
Card last four digits. <b>Note, this field is REQUIRED for matching purposes.</b>
authorizationCodestringOptional
Transaction approval code
retrievalReferenceNumberstringOptional
Retrieval Reference Number
systemTraceAuditNumberstringOptional
System Trace Audit Number
acquirerReferenceNumberstringOptional
Acquirer Reference Number
isDepositbooleanOptional
Transaction is a deposit
googleIdstringOptionalDeprecated
Google Id

Response

This endpoint returns a string.

Errors

Description2 of transaction — usually includes other merchant identifying information

Call this endpoint to send all incoming transactions made by all enrolled users in your rewards program. These incoming transactions will be processed and matched by the Kard system. Learn more about the Transaction CLO Matching flow here.
Required scopes: transaction:write

Description of transaction - usually includes merchant and other key details on transaction

Merchant Category Code (usually a 4-digit numerical number). Note, this field is REQUIRED for SOME national offers. We HIGHLY RECOMMEND sending this field as it will be required in the near future.

Timestamp for REVERSED, RETURNED, DECLINED transaction events; REQUIRED for transactions with REVERSED, RETURNED, DECLINED status. Date string should be in ISO format i.e.'YYYY-MM-DDThh:mm:ss.sTZD' where TZD = time zone designator (Z or +hh:mm or -hh:mm) i.e. 1994-11-05T08:15:30-05:00 OR 1994-11-05T08:15:30Z

Timestamp for APPROVED transaction event; REQUIRED for transactions with APPROVED status, and HIGHLY RECOMMENDED to include for transactions with a SETTLED status. Date string should be in ISO format i.e.'YYYY-MM-DDThh:mm:ss.sTZD' where TZD = time zone designator (Z or +hh:mm or -hh:mm) i.e. 1994-11-05T08:15:30-05:00 OR 1994-11-05T08:15:30Z

Timestamp for SETTLED transaction event, REQUIRED for transactions with SETTLED status. Date string should be in ISO format i.e.'YYYY-MM-DDThh:mm:ss.sTZD' where TZD = time zone designator (Z or +hh:mm or -hh:mm) i.e. 1994-11-05T08:15:30-05:00 OR 1994-11-05T08:15:30Z

Merchant address city associated with transaction. We HIGHLY RECOMMEND sending this field as it may be required in the near future.

Acquirer Merchant Identification Number (MID) — usually a 15 digit numerical identifier code. Note, this field is REQUIRED for local offers. We HIGHLY RECOMMEND sending this field as it will be required in the near future.

Merchant address country associated with transaction. We HIGHLY RECOMMEND sending this field as it may be required in the near future.

Merchant street address associated with transaction. We HIGHLY RECOMMEND sending this field as it may be required in the near future.

Merchant address state associated with transaction. We HIGHLY RECOMMEND sending this field as it may be required in the near future.

Merchant address zip code associated with transaction. We HIGHLY RECOMMEND sending this field as it may be required in the near future.

Merchant longitude geocoordinate associated with transaction. We HIGHLY RECOMMEND sending this field as it may be required in the near future.

Merchant latitude geocoordinate associated with transaction. We HIGHLY RECOMMEND sending this field as it may be required in the near future.

Bank identification number (BIN). Must be a valid BIN of 6 digits. If over 6 digits, please send first 6. Note, this field is REQUIRED for matching purposes.

PAN entry mode (usually a 2 digit numeric code)

Card last four digits. Note, this field is REQUIRED for matching purposes.

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