transactions

Create Incoming Transaction

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

post/transactions/incoming

Request

Base URL: https://rewards-api.getkard.com
URL: https://rewards-api.getkard.com/transactions/incoming
Auth: HTTP bearer

Request body

transactionIdstring required

Transaction ID in issuer's system

referringPartnerUserIdstring required

Referring partner user ID from issuer associated with transaction

amountinteger required

Transaction amount in cents

status'APPROVED' | 'SETTLED' | 'REVERSED' | 'RETURNED' | 'DECLINED' required

currencystring required

Currency of transaction

descriptionstring required

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

description2string

Description2 of transaction — usually includes other merchant identifying information

mccstring

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.

coreProviderIdstring

Name of processor associated with transaction

transactionDatestring date-time

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

authorizationDatestring date-time

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

settledDatestring date-time

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

merchantIdstring

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.

merchantStoreIdstring

Merchant store ID where transaction originated from

cardPresencestring

Whether card was present at time of transaction

merchantNamestring

Merchant name associated with transaction

merchantAddrCitystring

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

merchantAddrState'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FM' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MH' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PW' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VI' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY'

merchantAddrZipcodestring

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

merchantAddrCountrystring

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

merchantAddrStreetstring

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

merchantLatstring

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

merchantLongstring

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

panEntryModestring

PAN entry mode (usually a 2 digit numeric code)

cardBINstring

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.

cardLastFourstring

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

googleIdstring

Google Id

authorizationCodestring

Transaction approval code

retrievalReferenceNumberstring

Retrieval Reference Number

systemTraceAuditNumberstring

System Trace Audit Number

acquirerReferenceNumberstring

Acquirer Reference Number

isDepositboolean

Transaction is a deposit

Response

Response with status 201

string required

Changes

No recorded changes to this operation across all 1 revision of this API.