Create Incoming Transaction

POST

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: audit:write

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
Allowed values: APPROVEDSETTLEDREVERSEDRETURNEDDECLINED
Transaction status
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). Note, this field is REQUIRED for SOME national offers. We HIGHLY RECOMMEND sending this field as it will be required in the near future.

coreProviderIdstringOptional
Name of processor associated with transaction
transactionDatedatetimeOptional

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

authorizationDatedatetimeOptional

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

settledDatedatetimeOptional

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

merchantIdstringOptional

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.

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. We HIGHLY RECOMMEND sending this field as it may be required in the near future.

merchantAddrStateenumOptional

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

merchantAddrZipcodestringOptional

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

merchantAddrCountrystringOptional

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

merchantAddrStreetstringOptional

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

merchantLatstringOptional

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

merchantLongstringOptional

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

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. Note, this field is REQUIRED for matching purposes.

cardLastFourstringOptional

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

googleIdstringOptionalDeprecated
Google Id

Response

This endpoint returns a string.

Errors

Built with