Kard transactions API is one of 16 APIs that Kard publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include transactions. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and an AsyncAPI specification.
This API exposes
7 operations
across 7 paths,
and defines 69 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://rewards-api.getkard.com, https://test-rewards-api.getkard.com.
The identity and technical contract details declared by the specification.
type_commons:RelationshipData
object
2 properties
2 required
type_commons:RequestValidationErrorResponse
object
1 property
1 required
type_transactions:DirectionType
string
type_transactions:CreateFileUploadAttributes
object
1 property
1 required
type_transactions:CoreTransactionAttributes
object
12 properties
9 required
type_transactions:RewardedTransactionStatus
string
type_transactions:CreateAuditResponseBody
object
1 property
1 required
type_transactions:AuditResponseAttributes
object
1 property
1 required
type_transactions:CreateIncomingTransactionRequestBody
array
type_transactions:TransactionsResponseData
object
3 properties
3 required
type_transactions:FileUploadType
string
Specifies the category of transaction file being uploaded. Use incomingTransactionsFile for new, real-time transactions that need to be processed and matched a…
type_transactions:IncomingTransactionRequest
object
32 properties
6 required
type_transactions:TransactionMerchantAttributes
object
2 properties
1 required
type_transactions:RewardedTransactionRelationships
object
3 properties
3 required
type_transactions:States
string
type_transactions:CommissionEarnedDetails
object
1 property
1 required
type_transactions:TransactionOfferAttributes
object
1 property
1 required
type_transactions:TransactionsMultiResponse
object
2 properties
2 required
type_transactions:Transactions
type_transactions:CreateAuditRequestBody_2
object
10 properties
6 required
type_commons:RelationshipSingle
object
1 property
1 required
type_transactions:TransactionPaymentType
string
type_transactions:FileUploadUrlData
object
3 properties
3 required
type_commons:ErrorObject
object
5 properties
3 required
type_transactions:CreateFileUploadUrlResponse
object
1 property
1 required
type_transactions:ProcessorMid
type_commons:CommissionValueType
string
The type of commission value
type_transactions:TransactionStatus
string
type_transactions:CreateFileUploadRequestBody
object
1 property
1 required
type_transactions:PaymentType
string
type_commons:InvalidRequestUnion
type_transactions:CreateAuditMultiStatusResponse
object
2 properties
1 required
type_commons:CardNetwork
string
Supported card networks
type_transactions:MerchantAssetType
string
type_commons:Job
object
2 properties
2 required
type_transactions:AuditStatus
string
type_transactions:RewardedTransactionUnion
type_commons:ErrorResponse
object
1 property
1 required
type_transactions:CreateAuditResponse
object
11 properties
7 required
type_transactions:RewardedTransactionAttributes
object
7 properties
6 required
type_transactions:ApprovedTransactionAttributes
object
4 properties
4 required
type_transactions:AuditAttributes
object
4 properties
4 required
type_transactions:GetEarnedRewardsMeta
object
1 property
1 required
type_transactions:FileUploadUrlAttributes
object
2 properties
2 required
type_commons:JobStatus
string
Status of the job
type_transactions:TransactionIncludedResource
type_commons:MongoId
string
The unique identifier for a document in the database
type_transactions:GetEarnedRewardsResponse
object
4 properties
3 required
type_transactions:PaymentStatus
string
type_transactions:TransactionsResponse
object
1 property
1 required
type_transactions:TransactionsAttributes
object
29 properties
10 required
type_transactions:VisaMidDetails
object
2 properties
2 required
type_transactions:MatchedTransactionsAttributes
object
21 properties
7 required
type_commons:State
string
type_transactions:CreateAuditRequestDataUnion
type_commons:Links
object
Related links to the API call
3 properties
1 required
type_transactions:ReceiptMediumType
string
type_commons:ErrorSource
object
3 properties
type_commons:CommissionValue
object
2 properties
2 required
type_transactions:GetAuditByIdResponse
object
14 properties
7 required
type_commons:OrganizationId
string
Your issuer organization ID, provided by Kard
type_transactions:CreateAuditResponseDataUnion
type_transactions:MerchantAsset
object
3 properties
2 required
type_transactions:CreateFileUploadData
object
2 properties
2 required
type_transactions:TransactionsRequestBody
object
1 property
1 required
type_commons:UnauthorizedErrorBody
object
1 property
1 required
type_transactions:CreateAuditRequestBody
object
1 property
1 required
type_transactions:Merchant
object
10 properties
1 required
type_commons:ResourceType
string
Type of document returned
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Kard publishes across the network.
