{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/network_info", "title": "Network Information", "oneOf": [ { "type": "null" }, { "type": "object" } ], "description": "Information provided by the card network in each event. This includes common identifiers shared between you, Lithic, the card network and in some cases the acquirer. These identifiers often link together events within the same transaction lifecycle and can be used to locate a particular transaction, such as during processing of disputes. Not all fields are available in all events, and the presence of these fields is dependent on the card network and the event type. If the field is populated by the network, we will pass it through as is unless otherwise specified. Please consult the official network documentation for more details about these fields and how to use them.", "properties": { "acquirer": { "properties": { "acquirer_reference_number": { "description": "Identifier assigned by the acquirer, applicable to dual-message transactions only. The acquirer reference number (ARN) is only populated once a transaction has been cleared, and it is not available in all transactions (such as automated fuel dispenser transactions). A single transaction can contain multiple ARNs if the merchant sends multiple clearings.", "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "retrieval_reference_number": { "description": "Identifier assigned by the acquirer.", "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "oneOf": [ { "type": "null" }, { "type": "object" } ], "required": [ "acquirer_reference_number", "retrieval_reference_number" ] }, "amex": { "properties": { "transaction_id": { "description": "Identifier assigned by American Express to link original messages to subsequent messages. Guaranteed by American Express to be unique for each original authorization and financial authorization.", "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "original_transaction_id": { "description": "Identifier assigned by American Express. Matches the `transaction_id` of a prior related event. May be populated in incremental authorizations (authorization requests that augment a previously authorized amount), authorization advices, financial authorizations, and clearings.", "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "oneOf": [ { "type": "null" }, { "type": "object" } ], "required": [ "transaction_id", "original_transaction_id" ] }, "mastercard": { "properties": { "banknet_reference_number": { "description": "Identifier assigned by Mastercard. Guaranteed by Mastercard to be unique for any transaction within a specific financial network on any processing day.", "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "switch_serial_number": { "description": "Identifier assigned by Mastercard, applicable to single-message transactions only.", "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "original_banknet_reference_number": { "description": "Identifier assigned by Mastercard. Matches the `banknet_reference_number` of a prior related event. May be populated in authorization reversals, incremental authorizations (authorization requests that augment a previously authorized amount), automated fuel dispenser authorization advices and clearings, and financial authorizations. If the original banknet reference number contains all zeroes, then no actual reference number could be found by the network or acquirer. If Mastercard converts a transaction from dual-message to single-message, such as for certain ATM transactions, it will populate the original banknet reference number in the resulting financial authorization with the banknet reference number of the initial authorization, which Lithic does not receive.", "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "original_switch_serial_number": { "description": "Identifier assigned by Mastercard. Matches the `switch_serial_number` of a prior related event. May be populated in returns and return reversals. Applicable to single-message transactions only.", "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "oneOf": [ { "type": "null" }, { "type": "object" } ], "required": [ "banknet_reference_number", "switch_serial_number", "original_banknet_reference_number", "original_switch_serial_number" ] }, "visa": { "properties": { "transaction_id": { "description": "Identifier assigned by Visa to link original messages to subsequent messages. Guaranteed by Visa to be unique for each original authorization and financial authorization.", "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "original_transaction_id": { "description": "Identifier assigned by Visa. Matches the `transaction_id` of a prior related event. May be populated in incremental authorizations (authorization requests that augment a previously authorized amount), authorization advices, financial authorizations, and clearings.", "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "oneOf": [ { "type": "null" }, { "type": "object" } ], "required": [ "transaction_id", "original_transaction_id" ] } }, "required": [ "acquirer", "amex", "mastercard", "visa" ] }