transactions

Get Audit Status

Call this endpoint to retrieve an update on the status of a created transaction audit. Note, the resolutionCode, resolutionDescription and resolutionTimeStamp will not be available until the audit has a “CLOSED” status signifying its resolution. <br/> <b>Required scopes:</b> audit:read

get/transactions/audit/{id}

Request

  • Base URL: https://rewards-api.getkard.com
  • URL: https://rewards-api.getkard.com/transactions/audit/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The audit ID provided by Kard's system

Response

Response with status 200

_idstring required

The unique identifier for a document in the database

transactionIdstring required

Transaction ID associated with audit

auditCodeinteger required

Audit Code - Enum. Code to define audit.

<ul> <li>`3005` : Customer is claiming cashback is incorrect - INCORRECT CASHBACK CLAIM</li> <li>`3006` : Transaction is missing the cashback award - MISSING CASHBACK AWARD</li> <li>`8001` : Other - check audit description</li> </ul>
merchantNamestring required

Merchant name related to the transaction audit

auditDescriptionstring required

Audit Description. More details around the audit

preferredContactEmailstring required

Preferred contact email to message to as audit is reviewed

transactionAmountInCentsinteger

Transaction amount in cents

referringPartnerUserIdstring

Referring partner user ID associated with the transaction to audit

merchantIdstring

The unique identifier for a document in the database

submitterNamestring

Submitter name

status'NEW' | 'IN_PROGRESS' | 'CLOSED' required
resolutionCodeinteger

Resolution Code - Enum. field is available when audit is status CLOSED.

<ul> <li>`5001` : Transaction will be deleted</li> <li>`5002` : Settlement amount will be adjusted</li> <li>`5003` : Return amount will be adjusted</li> <li>`5004` : Reward dispute resolved</li> <li>`5005` : Transaction will be marked for writeoff</li> <li>`5006` : Transaction will be marked as rejected</li> <li>`5007` : Transaction will be resent through webhook</li> <li>`5008` : Transaction will be resent through daily file</li> <li>`5009` : No change needed</li> <li>`9001` : Ineligible item in purchase</li> <li>`9002` : Return was made</li> <li>`9003` : User ineligible for offer (usually because of participation through another program)</li> <li>`9004` : Redemption limit hit (if offer has a set number of redemptions and it isn't handled programmatically)</li> <li>`9005` : Transaction not captured</li> </ul>
resolutionDescriptionstring

Resolution Description; field is available when audit is status CLOSED

resolutionTimeStampstring date-time

Resolution timestamp of when the audit was marked as status CLOSED in ISO format; available when audit is closed.

Changes

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