{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/card_transaction",
"title": "Card Transaction",
"type": "object",
"properties": {
"acquirer_fee": {
"description": "Fee assessed by the merchant and paid for by the cardholder in the smallest unit of the currency. Will be zero if no fee is assessed. Rebates may be transmitted as a negative value to indicate credited fees.",
"example": 0,
"type": [
"integer",
"null"
]
},
"acquirer_reference_number": {
"description": "Unique identifier assigned to a transaction by the acquirer that can be used in dispute and chargeback filing. This field has been deprecated in favor of the `acquirer_reference_number` that resides in the event-level `network_info`.",
"example": "12345678987654321234567",
"maxLength": 23,
"minLength": 23,
"type": [
"string",
"null"
],
"deprecated": true
},
"account_token": {
"description": "The token for the account associated with this transaction.",
"example": "bd5e5649-1be8-4117-9bc5-3268258d1417",
"format": "uuid",
"type": "string"
},
"amount": {
"description": "When the transaction is pending, this represents the authorization amount of the transaction in the anticipated settlement currency. Once the transaction has settled, this field represents the settled amount in the settlement currency.",
"example": 1000,
"type": "integer",
"deprecated": true
},
"amounts": {
"$ref": "#/components/schemas/transaction_amounts"
},
"authorization_amount": {
"description": "The authorization amount of the transaction in the anticipated settlement currency.",
"example": 1000,
"type": [
"integer",
"null"
],
"deprecated": true
},
"authorization_code": {
"description": "A fixed-width 6-digit numeric identifier that can be used to identify a transaction with networks.",
"example": "123456",
"maxLength": 6,
"minLength": 6,
"type": [
"string",
"null"
]
},
"avs": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/avs"
}
]
},
"card_token": {
"description": "Token for the card used in this transaction.",
"example": "19c22c47-7a75-43ee-9891-595419830f7e",
"format": "uuid",
"type": "string"
},
"cardholder_authentication": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/cardholder_authentication"
}
]
},
"created": {
"description": "Date and time when the transaction first occurred. UTC time zone.",
"example": "2023-09-26T21:14:28.637Z",
"format": "date-time",
"type": "string"
},
"events": {
"items": {
"$ref": "#/components/schemas/transaction_event"
},
"type": "array"
},
"financial_account_token": {
"oneOf": [
{
"type": "null"
},
{
"format": "uuid",
"type": "string"
}
]
},
"merchant": {
"$ref": "#/components/schemas/transaction_merchant"
},
"service_location": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/service_location"
}
]
},
"merchant_amount": {
"description": "Analogous to the 'amount', but in the merchant currency.",
"example": 1000,
"type": [
"integer",
"null"
],
"deprecated": true
},
"merchant_authorization_amount": {
"description": "Analogous to the 'authorization_amount', but in the merchant currency.",
"example": 1000,
"type": [
"integer",
"null"
],
"deprecated": true
},
"merchant_currency": {
"deprecated": true,
"$ref": "#/components/schemas/merchant_currency"
},
"network": {
"description": "Card network of the authorization. Value is `UNKNOWN` when Lithic cannot determine the network code from the upstream provider.",
"enum": [
"AMEX",
"INTERLINK",
"MAESTRO",
"MASTERCARD",
"UNKNOWN",
"VISA"
],
"example": "MASTERCARD",
"type": [
"string",
"null"
]
},
"network_risk_score": {
"$ref": "#/components/schemas/network_risk_score"
},
"result": {
"$ref": "#/components/schemas/decline_result"
},
"pos": {
"$ref": "#/components/schemas/pos"
},
"settled_amount": {
"title": "Settled Amount",
"description": "The settled amount of the transaction in the settlement currency.",
"type": "integer",
"example": 1000,
"deprecated": true
},
"status": {
"description": "Status of the transaction.",
"enum": [
"DECLINED",
"EXPIRED",
"PENDING",
"SETTLED",
"VOIDED"
],
"example": "SETTLED",
"type": "string"
},
"token": {
"description": "Globally unique identifier.",
"format": "uuid",
"type": "string"
},
"token_info": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/token_info"
}
]
},
"tags": {
"$ref": "#/components/schemas/tags"
},
"updated": {
"description": "Date and time when the transaction last updated. UTC time zone.",
"example": "2023-09-26T21:14:28.637Z",
"format": "date-time",
"type": "string"
}
},
"required": [
"acquirer_fee",
"acquirer_reference_number",
"account_token",
"amount",
"amounts",
"authorization_amount",
"authorization_code",
"avs",
"card_token",
"cardholder_authentication",
"created",
"financial_account_token",
"merchant_amount",
"merchant_authorization_amount",
"merchant_currency",
"merchant",
"service_location",
"network",
"network_risk_score",
"result",
"pos",
"settled_amount",
"status",
"tags",
"token",
"token_info",
"updated"
],
"examples": [
{
"account_token": "db3942f0-0627-4887-a190-1ea83b46d091",
"acquirer_fee": 0,
"acquirer_reference_number": null,
"amount": 1800,
"amounts": {
"cardholder": {
"amount": 0,
"conversion_rate": "1.000000",
"currency": "USD"
},
"hold": {
"amount": -1800,
"currency": "USD"
},
"merchant": {
"amount": 0,
"currency": "USD"
},
"settlement": {
"amount": 0,
"currency": "USD"
}
},
"authorization_amount": 1800,
"authorization_code": "071471",
"avs": {
"zipcode": "95006",
"address": "123 Evergreen Terrace"
},
"card_token": "aac502f9-aecc-458a-954e-4bcf6edb6123",
"cardholder_authentication": {
"liability_shift": "3DS_AUTHENTICATED",
"authentication_result": "SUCCESS",
"authentication_method": "FRICTIONLESS",
"three_ds_authentication_token": "fc60d37d-95f7-419c-b628-dd9fbf9d80d0",
"decision_made_by": "NETWORK"
},
"created": "2023-08-03T18:42:30Z",
"events": [
{
"amount": 1800,
"amounts": {
"cardholder": {
"amount": 1800,
"conversion_rate": "1.000000",
"currency": "USD"
},
"merchant": {
"amount": 1800,
"currency": "USD"
},
"settlement": null
},
"created": "2023-08-03T18:42:30Z",
"detailed_results": [
"APPROVED"
],
"effective_polarity": "DEBIT",
"network_info": {
"acquirer": {
"acquirer_reference_number": null,
"retrieval_reference_number": "064386558597"
},
"amex": null,
"mastercard": {
"banknet_reference_number": "U1HSCJ",
"switch_serial_number": null,
"original_banknet_reference_number": null,
"original_switch_serial_number": null
},
"visa": null
},
"result": "APPROVED",
"rule_results": [],
"token": "bbbf1e86-322d-11ee-9779-00505685a123",
"type": "AUTHORIZATION"
}
],
"financial_account_token": "a3b113e8-01fe-42d3-b900-b9adf3f15496",
"merchant": {
"acceptor_id": "452322000053360",
"acquiring_institution_id": "333301802529120",
"city": "gosq.com",
"country": "USA",
"descriptor": "SQ *SOMA EATS",
"mcc": "5812",
"state": "CA",
"postal_code": "94107",
"street_address": null,
"phone_number": null
},
"service_location": null,
"merchant_amount": 1800,
"merchant_authorization_amount": 1800,
"merchant_currency": "USD",
"network": "MASTERCARD",
"network_risk_score": 5,
"pos": {
"entry_mode": {
"card": "NOT_PRESENT",
"cardholder": "NOT_PRESENT",
"pan": "ECOMMERCE",
"pin_entered": false
},
"terminal": {
"attended": false,
"card_retention_capable": false,
"on_premise": false,
"operator": "UNKNOWN",
"partial_approval_capable": false,
"pin_capability": "NOT_CAPABLE",
"type": "UNKNOWN"
}
},
"result": "APPROVED",
"settled_amount": 0,
"status": "PENDING",
"tags": {
"risk-level": "high"
},
"token": "c30c2182-1e69-4e0d-b40f-eec0d2a19123",
"token_info": {
"wallet_type": "APPLE_PAY"
},
"updated": "2023-08-03T18:42:30Z"
}
]
}