# Aggregated Transit Rules in the North America Region source: https://developer.mastercard.com/mastercard-gateway/documentation/gateway-features/trans-enrich-data/cardholder-present-data/transit/agg-transit-rules-na/index.md ## Overview {#overview} The aggregation model is designed for situations where the final fare is not known at the time of travel. Instead, the fare is calculated at the end of a predefined travel period, typically within 24 hours, based on the journeys made during that time. You can charge flat, distance-based, or time-based fares for each trip within the travel period. Ensure to familiarize yourself with the scheme rules and comply with all the requirements. ## Supported schemes {#supported-schemes} The aggregated transit rules in the North American Region support the following card schemes: * Mastercard * Visa ## API version and parameters {#api-version-and-parameters} Mastercard Gateway supports transit aggregation from version 100 onwards of the Gateway Direct API for Mastercard and Visa scheme rules processing in the North American Region. ### posTerminal parameters {#posterminal-parameters} This table describes the most common **posTerminal** parameters. | Gateway Direct API Field | Value | |--------------------------|--------------------------------------------------------------------------------------------------| | cardPresenceCapability | CARD_PRESENT | | Attended | UNATTENDED | | cardholderActivated | NOT_CARDHOLDER_ACTIVATED | | Location | MERCHANT_TERMINAL_ON_PREMISES | | Lane | Use a unique Terminal ID for the device. Do not use a fixed Terminal ID value across the estate. | | inputCapability | CONTACTLESS_CHIP | | pinEntry capability | PIN_NOT_SUPPORTED | | panEntryMode | CONTACTLESS | | onlineReasonCode | N/A | ### transaction.transit.aggregatedFare parameter group {#transactiontransitaggregatedfare-parameter-group} Additionally, the `transaction.transit.aggregatedFare` is required for aggregation. | Gateway Direct API Field | Value | |--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | .type | * FARE * DEBT_RECOVERY_MERCHANT_INITIATED * DEBT_RECOVERY_PAYER_INITIATED * DEBT_RECOVERY_TAP_INITIATED ([Standalone Capture](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction)) | | .aggregationStartDate | `` of first trip yyyy-mm-dd | | .transportationMode | CABLE_CAR * COACH * COMMUTER_TRAIN * EXPRESS_COMMUTER_TRAIN * FUNICULAR_TRAIN * HIGH_SPEED_TRAIN * INTERURBAN_ BUS * INTER_CITY * LIGHT_TRAIN_MASS_TRANSIT * LOCOMOTIVE * OTHER * PARA_TRANSIT * PARKING * POWERED_MOTOR_VEHICLE * REGIONAL_TRAIN * RURAL_BUS * SELF_DRIVE_VEHICLE * TAXI * TOLL * TRAILER * TRAIN * URBAN_BUS * WATER_BORNE_VEHICLE | ## Aggregation use cases {#aggregation-use-cases} The use cases for aggregated transit fare payments are: * [First tap within the travel period](https://developer.mastercard.com/mastercard-gateway/documentation/gateway-features/trans-enrich-data/cardholder-present-data/transit/agg-transit-rules-na/index.md#first-tap-within-travel-period) * [Subsequent taps within the travel period](https://developer.mastercard.com/mastercard-gateway/documentation/gateway-features/trans-enrich-data/cardholder-present-data/transit/agg-transit-rules-na/index.md#subsequent-taps-within-the-travel-period) * [End of travel period](https://developer.mastercard.com/mastercard-gateway/documentation/gateway-features/trans-enrich-data/cardholder-present-data/transit/agg-transit-rules-na/index.md#end-of-travel-period) * [Merchant initiated debt recovery](https://developer.mastercard.com/mastercard-gateway/documentation/gateway-features/trans-enrich-data/cardholder-present-data/transit/agg-transit-rules-na/index.md#merchant-initiated-debt-recovery) * [Payer or tap initiated debt recovery](https://developer.mastercard.com/mastercard-gateway/documentation/gateway-features/trans-enrich-data/cardholder-present-data/transit/agg-transit-rules-na/index.md#payer-or-tap-initiated-debt-recovery) ### API Requests for Aggregated Fare in Transit Transactions {#api-requests-for-aggregated-fare-in-transit-transactions} API requests include the `transaction.transit.aggregatedFare` parameter, consisting of: * `type` * `aggregationStartDate` * `transportationMode` The API request type and values for each use case are tailored to align with the specific scheme requirements as detailed in the following sections. The posTerminal parameters detailed are the same for each aggregation use case. ## First tap within travel period {#first-tap-within-travel-period} ### Mastercard and Visa {#mastercard-and-visa} [Verify](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) * `order.id` * `order.amount` - 0.00 * `order.currency` * `transaction.id` - Unique value * `sourceOfFunds.provided.card.emvRequest` with valid EMV tag data * `sourceOfFunds.provided.card.expiry` * `sourceOfFunds.provided.card.expiry.month` * `sourceOfFunds.provided.card.expiry.year` * `sourceOfFunds.provided.card.number` * `sourceOfFunds.type` - CARD * `transaction.source` - CARD_PRESENT * `posTerminal.attended` - UNATTENDED * `posTerminal.cardholderActivated` - NOT_CARDHOLDER_ACTIVATED * `posTerminal.location` - MERCHANT_TERMINAL_ON_PREMISES * `posTerminal.panEntryMode` - CONTACTLESS * `posTerminal.inputCapability` - CONTACTLESS_CHIP * `posTerminal.lane` * `posTerminal.pinEntryCapability` - PIN_NOT_SUPPORTED For a declined response: * Add to Deny List ## Subsequent taps within the travel period {#subsequent-taps-within-the-travel-period} ### Mastercard and Visa {#mastercard-and-visa-1} Automated Fare Collection (AFC) tracks the aggregated fare for the card covering each journey. No gateway request is required. ## End of travel period {#end-of-travel-period} ### Mastercard and Visa {#mastercard-and-visa-2} [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) * `order.id` - New value * `transaction.transit.aggregatedFare.type` * `transaction.transit.aggregatedFare.aggregationStartDate` * `transaction.transit.aggregatedFare.transportationMode` * `sourceOfFunds.provided.card.emvRequest` with valid EMV tag data * Containing all the mandatory for transaction processing emv tags * `sourceOfFunds.provided.card.sequenceNumber` [Capture](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) for successful [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) requests * `order.id` - Of the successful [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) transaction * `transaction.id` - Unique value for the [Capture](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) * `transaction.amount` - Same as the successful [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) * `transaction.currency` - Same as the successful [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) Warning: Do not resubmit any other payment details in the [Capture](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) request as the gateway stores the payment details for each order. ## Merchant initiated debt recovery {#merchant-initiated-debt-recovery} ### Mastercard and Visa {#mastercard-and-visa-3} If the [Standalone Capture](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) request is not submitted in line with the First Ride Risk rules, you can attempt to recover the online fare within the applicable scheme rules. [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) * `order.id` - New value * `transaction.id` - Unique value * `transaction.source` - MERCHANT * `transaction.amount` - xx.xx * `transaction.currency` * `transaction.transit.aggregatedFare` * `type`=DEBT_RECOVERY_MERCHANT_INITIATED * `aggregationStartDate` - The valid trip start date * `transportationMode`= - The valid transportation mode used for the first trip If the [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) is successful, the cards should be removed from the deny list in a timely manner. If the debt recovery [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) request fails, additional requests can be made as long as they do not exceed the number permitted within the scheme rules. ***Capture*** * `order.id` - Same as successful [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) * `transaction.id` - Unique value * `transaction.amount` - Same as [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) * `transaction.currency` - Same as [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) ## Payer or tap initiated debt recovery {#payer-or-tap-initiated-debt-recovery} ### Mastercard and Visa {#mastercard-and-visa-4} [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) `transaction.transit.aggregatedFare` fields are required. If the Authorize is successful, the cards should be removed from the deny list in a timely manner. ### Visa {#visa} [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) `transaction.transit.aggregatedFare` fields are required. After the debt is recovered successfully, the Visa rules state that the card must be removed from the deny list within 1 hour from the time authorization approval is received. If the debt recovery [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) request fails, additional requests can be made as long as they do not exceed the number permitted within the Visa rules. ## First Ride Risk {#first-ride-risk} For more details about the First Ride Risk, see the [First Ride Risk](https://developer.mastercard.com/mastercard-gateway/documentation/gateway-features/trans-enrich-data/cardholder-present-data/transit/first-ride-risk/index.md) section. ## Aggregation clearing requirements {#aggregation-clearing-requirements} Clearing data, for transactions processed by the gateway, is provided in a Draft Capture File (DCF). The acquirers must ensure that their processing platform is able to process the card present data. The DCF specification document version 4.3.6 or later details the required records and fields. | Purpose | Record type | |----------------------------------------------------------------------------------------------------|--------------------------| | All Schemes: Mandatory 1 Mandatory 2 EMV Data Record 1 EMV Data Record 2 Mastercard Gateway Record | 6220 6221 6225 6271 6290 | | Mastercard only | 6222 | | Visa only | 6223 | ### Transit solutions-specific requirements {#transit-solutions-specific-requirements} This table describes the requirements of transit solutions. | Description | DCF Record, Field, and Position | Mastercard Integrated Product Messages (IPM) or Visa Base II | |----------------------------------------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------| | Mastercard Transit Transaction Type Indicator DE48 SE64 SF1 | 6222, Field 11, Pos. 64-65 | PDS 0210 -- SF 1 * 02 Real-time Authorized * 03 Post-Authorized Aggregated * 07 Debt Recovery | | Mastercard Transit Transportation Mode Indicator DE48 SE64 SF2 | 6222, Field 12, Pos. 66-67 | PDS 0210 -- SF 2 | | Visa Date of First Tap in the travel period | 6223, Field 16, Pos. 85-90 | TCR0 Pos. 58-61 | ## Gateway Direct API Examples for aggregation use cases {#gateway-direct-api-examples-for-aggregation-use-cases} ### [Verify](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) {#verifyhahahugoshortcodes21hbhb} ```json { "apiOperation": "VERIFY", "order": { "currency": "USD" }, "sourceOfFunds": { "provided": { "card": { "emvRequest": { "5F2A": "826", "82": "0000", "84": "010101010101", "95": "0000000000", "9A": "161021", "9B": "0101", "9C": "00", "9F02": "000000001099", "9F03": "000000000000", "9F06": "010101010101", "9F07": "0101", "9F09": "0101", "9F10": "06011103A000000A0100000000000BB0ABAD", "9F1A": "826", "9F1E": "0123ABCD", "9F26": "D1F722D47FCA8273", "9F27": "40", "9F33": "E0B8C8", "9F34": "1E0300", "9F35": "12", "9F36": "0002", "9F37": "2A4E1690", "9F41": "0123", "9F53": "A", "9F6E": "0101" }, "expiry": { "month": "01", "year": "39" }, "number": "5123456789012346" } }, "type": "CARD" }, "transaction": { "source": "CARD_PRESENT" }, "posTerminal": { "address": { "country": "AUS" }, "attended": "UNATTENDED", "cardholderActivated": "SELF_SERVICE_TERMINAL", "inputCapability": "CONTACTLESS_CHIP", "lane": "CBAS2I02", "location": "MERCHANT_TERMINAL_ON_PREMISES", "panEntryMode": "CONTACTLESS", "pinEntryCapability": "PIN_NOT_SUPPORTED" } } ``` ```json { "authorizationResponse": { "transactionIdentifier": "825894572" }, "gatewayEntryPoint": "WEB_SERVICES_API", "merchant": "CYG_S2I_MER2", "order": { "amount": 0.00, "chargeback": { "amount": 0, "currency": "USD" }, "creationTime": "2025-04-09T06:14:51.742Z", "currency": "USD", "id": "AKS_716482252", "lastUpdatedTime": "2025-04-09T06:14:51.932Z", "merchantAmount": 0.00, "merchantCategoryCode": "4111", "merchantCurrency": "USD", "status": "VERIFIED", "totalAuthorizedAmount": 0.00, "totalCapturedAmount": 0.00, "totalDisbursedAmount": 0.00, "totalRefundedAmount": 0.00 }, "posTerminal": { "address": { "country": "AUS" }, "attended": "UNATTENDED", "cardholderActivated": "SELF_SERVICE_TERMINAL", "inputCapability": "CONTACTLESS_CHIP", "lane": "CBAS2I02", "location": "MERCHANT_TERMINAL_ON_PREMISES", "panEntryMode": "CONTACTLESS", "pinEntryCapability": "PIN_NOT_SUPPORTED", "serialNumber": "0123ABCD" }, "response": { "acquirerCode": "00", "gatewayCode": "APPROVED" }, "result": "SUCCESS", "sourceOfFunds": { "provided": { "card": { "brand": "MASTERCARD", "emvRequest": { "5F2A": "826", "82": "0000", "84": "010101010101", "95": "0000000000", "9A": "161021", "9B": "0101", "9C": "00", "9F02": "000000001099", "9F03": "000000000000", "9F06": "010101010101", "9F07": "0101", "9F09": "0101", "9F10": "06011103A000000A0100000000000BB0ABAD", "9F1A": "826", "9F1E": "0123ABCD", "9F26": "D1F722D47FCA8273", "9F27": "40", "9F33": "E0B8C8", "9F34": "1E0300", "9F35": "12", "9F36": "0002", "9F37": "2A4E1690", "9F41": "0123", "9F53": "A", "9F6E": "0101" }, "expiry": { "month": "1", "year": "39" }, "fundingMethod": "DEBIT", "number": "512345xxxxxx2346", "paymentAccountReference": "1234567890123456TC020MDESDE56", "scheme": "MASTERCARD", "storedOnFile": "NOT_STORED" } }, "type": "CARD" }, "timeOfLastUpdate": "2025-04-09T06:14:51.932Z", "timeOfRecord": "2025-04-09T06:14:51.817Z", "transaction": { "acquirer": { "id": "CYG_TESTACQ_S2I", "merchantId": "9808" }, "amount": 0.00, "currency": "USD", "id": "AKS_955011777", "receipt": "509906127124", "source": "CARD_PRESENT", "stan": "127124", "terminal": "0002", "type": "VERIFICATION" }, "version": "100" } ``` ### [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) {#authorizehahahugoshortcodes23hbhb} ```json { "apiOperation": "AUTHORIZE", "order": { "amount": "7", "currency": "USD" }, "sourceOfFunds": { "provided": { "card": { "emvRequest": { "5F2A": "826", "82": "0000", "84": "010101010101", "95": "0000000000", "9A": "161021", "9B": "0101", "9C": "00", "9F02": "000000001099", "9F03": "000000000000", "9F06": "010101010101", "9F07": "0101", "9F09": "0101", "9F10": "06011103A000000A0100000000000BB0ABAD", "9F1A": "826", "9F1E": "0123ABCD", "9F26": "D1F722D47FCA8273", "9F27": "40", "9F33": "E0B8C8", "9F34": "1E0300", "9F35": "12", "9F36": "0002", "9F37": "2A4E1690", "9F41": "0123", "9F53": "A", "9F6E": "0101" }, "expiry": { "month": "01", "year": "39" }, "number": "5123456789012346" } }, "type": "CARD" }, "transaction": { "source": "CARD_PRESENT", "transit": { "aggregatedFare": { "type": "FARE", "aggregationStartDate": "2024-05-14", "transportationMode": "TRAIN" } } }, "posTerminal": { "address": { "country": "AUS" }, "attended": "UNATTENDED", "cardholderActivated": "SELF_SERVICE_TERMINAL", "inputCapability": "CONTACTLESS_CHIP", "lane": "CBAS2I02", "location": "MERCHANT_TERMINAL_ON_PREMISES", "panEntryMode": "CONTACTLESS", "pinEntryCapability": "PIN_NOT_SUPPORTED" } } ``` ```json { "authorizationResponse": { "commercialCard": "123", "commercialCardIndicator": "1", "date": "0409", "financialNetworkCode": "MCC", "posData": "1000004002300", "posEntryMode": "072", "processingCode": "003000", "responseCode": "00", "stan": "128164", "time": "061734", "transactionIdentifier": "794480394", "transactionIntegrityClass": "A1" }, "gatewayEntryPoint": "WEB_SERVICES_API", "merchant": "CYG_S2I_MER2", "order": { "amount": 7.00, "authenticationStatus": "AUTHENTICATION_NOT_IN_EFFECT", "certainty": "FINAL", "chargeback": { "amount": 0, "currency": "USD" }, "creationTime": "2025-04-09T06:17:33.964Z", "currency": "USD", "id": "AKS_990316764", "lastUpdatedTime": "2025-04-09T06:17:34.191Z", "merchantAmount": 7.00, "merchantCategoryCode": "4111", "merchantCurrency": "USD", "status": "AUTHORIZED", "totalAuthorizedAmount": 7.00, "totalCapturedAmount": 0.00, "totalDisbursedAmount": 0.00, "totalRefundedAmount": 0.00 }, "posTerminal": { "address": { "country": "AUS" }, "attended": "UNATTENDED", "cardholderActivated": "SELF_SERVICE_TERMINAL", "inputCapability": "CONTACTLESS_CHIP", "lane": "CBAS2I02", "location": "MERCHANT_TERMINAL_ON_PREMISES", "panEntryMode": "CONTACTLESS", "pinEntryCapability": "PIN_NOT_SUPPORTED", "serialNumber": "0123ABCD" }, "response": { "acquirerCode": "00", "acquirerMessage": "Approved", "gatewayCode": "APPROVED", "gatewayRecommendation": "NO_ACTION" }, "result": "SUCCESS", "sourceOfFunds": { "provided": { "card": { "brand": "MASTERCARD", "emvRequest": { "5F2A": "826", "82": "0000", "84": "010101010101", "95": "0000000000", "9A": "161021", "9B": "0101", "9C": "00", "9F02": "000000001099", "9F03": "000000000000", "9F06": "010101010101", "9F07": "0101", "9F09": "0101", "9F10": "06011103A000000A0100000000000BB0ABAD", "9F1A": "826", "9F1E": "0123ABCD", "9F26": "D1F722D47FCA8273", "9F27": "40", "9F33": "E0B8C8", "9F34": "1E0300", "9F35": "12", "9F36": "0002", "9F37": "2A4E1690", "9F41": "0123", "9F53": "A", "9F6E": "0101" }, "emvResponse": { "72": "9F180408041215860E04DA9F5809030691D72E6F027DC6", "91": "B7D5309D4B3E6CDB3030" }, "expiry": { "month": "1", "year": "39" }, "fundingMethod": "DEBIT", "number": "512345xxxxxx2346", "paymentAccountReference": "1234567890123456TC020MDESDE56", "scheme": "MASTERCARD", "storedOnFile": "NOT_STORED" } }, "type": "CARD" }, "timeOfLastUpdate": "2025-04-09T06:17:34.191Z", "timeOfRecord": "2025-04-09T06:17:34.040Z", "transaction": { "acquirer": { "batch": 20250409, "date": "0409", "id": "CYG_TESTACQ_S2I", "merchantId": "9808", "transactionId": "794480394" }, "amount": 7.00, "authenticationStatus": "AUTHENTICATION_NOT_IN_EFFECT", "authorizationCode": "112233", "currency": "USD", "id": "AKS_478310073", "receipt": "509906128164", "source": "CARD_PRESENT", "stan": "128164", "terminal": "0002", "transit": { "aggregatedFare": { "aggregationStartDate": "2024-05-14", "transportationMode": "TRAIN", "type": "FARE" } }, "type": "AUTHORIZATION" }, "version": "100" } ``` ### [Capture](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) {#capturehahahugoshortcodes25hbhb} ```json { "apiOperation": "CAPTURE", "transaction": { "amount": "10", "currency": "USD" } } ``` ```json { "authorizationResponse": { "commercialCard": "123", "commercialCardIndicator": "1", "date": "0409", "financialNetworkCode": "MCC", "posData": "1000004002300", "posEntryMode": "072", "processingCode": "003000", "responseCode": "00", "stan": "128164", "time": "061734", "transactionIdentifier": "794480394", "transactionIntegrityClass": "A1" }, "gatewayEntryPoint": "WEB_SERVICES_API", "merchant": "CYG_S2I_MER2", "order": { "amount": 7.00, "certainty": "FINAL", "chargeback": { "amount": 0, "currency": "USD" }, "creationTime": "2025-04-09T06:17:33.964Z", "currency": "USD", "id": "AKS_990316764", "lastUpdatedTime": "2025-04-09T06:19:41.049Z", "merchantAmount": 7.00, "merchantCategoryCode": "4111", "merchantCurrency": "USD", "status": "CAPTURED", "totalAuthorizedAmount": 7.00, "totalCapturedAmount": 10.00, "totalDisbursedAmount": 0.00, "totalRefundedAmount": 0.00 }, "posTerminal": { "address": { "country": "AUS" }, "attended": "UNATTENDED", "cardholderActivated": "SELF_SERVICE_TERMINAL", "inputCapability": "CONTACTLESS_CHIP", "lane": "CBAS2I02", "location": "MERCHANT_TERMINAL_ON_PREMISES", "panEntryMode": "CONTACTLESS", "pinEntryCapability": "PIN_NOT_SUPPORTED", "serialNumber": "0123ABCD" }, "response": { "acquirerCode": "00", "acquirerMessage": "Approved", "gatewayCode": "APPROVED" }, "result": "SUCCESS", "sourceOfFunds": { "provided": { "card": { "brand": "MASTERCARD", "expiry": { "month": "1", "year": "39" }, "fundingMethod": "DEBIT", "number": "512345xxxxxx2346", "scheme": "MASTERCARD", "storedOnFile": "NOT_STORED" } }, "type": "CARD" }, "timeOfLastUpdate": "2025-04-09T06:19:41.049Z", "timeOfRecord": "2025-04-09T06:19:41.002Z", "transaction": { "acquirer": { "batch": 20250409, "date": "0409", "id": "CYG_TESTACQ_S2I", "merchantId": "9808", "settlementDate": "2025-04-09", "timeZone": "+1000", "transactionId": "794480394" }, "amount": 10.00, "authorizationCode": "112233", "currency": "USD", "id": "AKS_184400968", "receipt": "509906128164", "source": "CARD_PRESENT", "stan": "129204", "terminal": "0002", "transit": { "aggregatedFare": { "aggregationStartDate": "2024-05-14", "transportationMode": "TRAIN", "type": "FARE" } }, "type": "CAPTURE" }, "version": "100" } ``` ## First Ride Risk {#first-ride-risk-1} ### [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) {#authorizehahahugoshortcodes27hbhb} ```json { "apiOperation": "AUTHORIZE", "order": { "amount": 11.25, "currency": "USD", "certainty": "FINAL" }, "sourceOfFunds": { "provided": { "card": { "emvRequest": { "5A": 5555555555554444, "5F2A": "826", "82": "0000", "84": "010101010101", "95": "0000000000", "9A": "161021", "9B": "0101", "9C": "00", "9F02": "000000001099", "9F03": "000000000000", "9F06": "010101010101", "9F07": "0101", "9F09": "0101", "9F10": "06011103A000000A0100000000000BB0ABAD", "9F1A": "826", "9F1E": "0123ABCD", "9F26": "D1F722D47FCA8273", "9F27": "40", "9F33": "E0B8C8", "9F34": "1E0300", "9F35": "12", "9F36": "0002", "9F37": "2A4E1690", "9F41": "0123", "9F53": "A", "9F6E": "0101" }, "expiry": { "month": "12", "year": "24" }, "number": 5555555555554444 } }, "type": "CARD" }, "transaction": { "source": "CARD_PRESENT", "transit": { "knownFare": { "type": "FARE_DEFERRED_AUTHORIZATION", "transportationMode": "TRAIN" } } }, "posTerminal": { "attended": "UNATTENDED", "location": "MERCHANT_TERMINAL_ON_PREMISES", "cardholderActivated": "NOT_CARDHOLDER_ACTIVATED", "panEntryMode": "CONTACTLESS", "inputCapability": "CONTACTLESS_CHIP", "lane": "street1", "pinEntryCapability": "PIN_NOT_SUPPORTED" } } ``` ```json { "authorizationResponse": { "date": "0409", "financialNetworkCode": "MCC", "posData": "1000004000300", "posEntryMode": "072", "processingCode": "003000", "responseCode": "51", "stan": "10560", "time": "113934", "transactionIdentifier": "953089271" }, "gatewayEntryPoint": "WEB_SERVICES_API", "merchant": "CYG_S2I_MER2", "order": { "amount": 11.25, "authenticationStatus": "AUTHENTICATION_NOT_IN_EFFECT", "certainty": "FINAL", "chargeback": { "amount": 0, "currency": "USD" }, "creationTime": "2025-04-09T11:39:34.664Z", "currency": "USD", "id": "A_9", "lastUpdatedTime": "2025-04-09T11:39:34.938Z", "merchantAmount": 11.25, "merchantCategoryCode": "4111", "merchantCurrency": "USD", "status": "FAILED", "totalAuthorizedAmount": 0.00, "totalCapturedAmount": 0.00, "totalDisbursedAmount": 0.00, "totalRefundedAmount": 0.00 }, "posTerminal": { "address": { "country": "GBR" }, "attended": "UNATTENDED", "cardholderActivated": "NOT_CARDHOLDER_ACTIVATED", "inputCapability": "CONTACTLESS_CHIP", "lane": "street1", "location": "MERCHANT_TERMINAL_ON_PREMISES", "panEntryMode": "CONTACTLESS", "pinEntryCapability": "PIN_NOT_SUPPORTED", "serialNumber": "0123ABCD" }, "response": { "acquirerCode": "51", "acquirerMessage": "Not sufficient funds", "gatewayCode": "INSUFFICIENT_FUNDS", "gatewayRecommendation": "RESUBMIT_WITH_ALTERNATIVE_PAYMENT_DETAILS" }, "result": "FAILURE", "sourceOfFunds": { "provided": { "card": { "brand": "MASTERCARD", "emvRequest": { "5F2A": "826", "82": "0000", "84": "010101010101", "95": "0000000000", "9A": "161021", "9B": "0101", "9C": "00", "9F02": "000000001099", "9F03": "000000000000", "9F06": "010101010101", "9F07": "0101", "9F09": "0101", "9F10": "06011103A000000A0100000000000BB0ABAD", "9F1A": "826", "9F1E": "0123ABCD", "9F26": "D1F722D47FCA8273", "9F27": "40", "9F33": "E0B8C8", "9F34": "1E0300", "9F35": "12", "9F36": "0002", "9F37": "2A4E1690", "9F41": "0123", "9F53": "A", "9F6E": "0101" }, "emvResponse": { "72": "9F180408041215860E04DA9F5809030691D72E6F027DC6", "91": "B7D5309D4B3E6CDB3030" }, "expiry": { "month": "12", "year": "24" }, "fundingMethod": "DEBIT", "number": "555555xxxxxx4444", "scheme": "MASTERCARD", "storedOnFile": "NOT_STORED" } }, "type": "CARD" }, "timeOfLastUpdate": "2025-04-09T11:39:34.938Z", "timeOfRecord": "2025-04-09T11:39:34.735Z", "transaction": { "acquirer": { "batch": 20250409, "date": "0409", "id": "CYG_TESTACQ_S2I", "merchantId": "9808", "transactionId": "953089271" }, "amount": 11.25, "authenticationStatus": "AUTHENTICATION_NOT_IN_EFFECT", "currency": "USD", "id": "A_10", "receipt": "509911010560", "source": "CARD_PRESENT", "stan": "10560", "terminal": "0001", "transit": { "knownFare": { "transportationMode": "TRAIN", "type": "FARE_DEFERRED_AUTHORIZATION" } }, "type": "AUTHORIZATION" }, "version": "100" } ``` ### [Capture](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) {#capturehahahugoshortcodes29hbhb} ```json { "apiOperation": "CAPTURE", "sourceOfFunds": { "provided": { "card": { "emvRequest": { "5A": "5555555555554444", "5F2A": "826", "82": "0000", "84": "010101010101", "95": "0000000000", "9A": "161021", "9B": "0101", "9C": "00", "9F02": "000000001099", "9F03": "000000000000", "9F06": "010101010101", "9F07": "0101", "9F09": "0101", "9F10": "06011103A000000A0100000000000BB0ABAD", "9F1A": "826", "9F1E": "0123ABCD", "9F26": "D1F722D47FCA8273", "9F27": "40", "9F33": "E0B8C8", "9F34": "1E0300", "9F35": "12", "9F36": "0002", "9F37": "2A4E1690", "9F41": "0123", "9F53": "A", "9F6E": "0101" }, "expiry": { "month": "12", "year": "24" }, "number": "5555555555554444" } }, "type": "CARD" }, "transaction": { "authorizationCode": "VFT000", "amount": 7, "currency": "USD", "source": "CARD_PRESENT", "transit": { "aggregatedFare": { "type": "FIRST_RIDE_RISK", "aggregationStartDate": "2024-05-14", "transportationMode": "TRAIN" } } }, "posTerminal": { "attended": "UNATTENDED", "location": "MERCHANT_TERMINAL_ON_PREMISES", "cardholderActivated": "SELF_SERVICE_TERMINAL", "panEntryMode": "CONTACTLESS", "inputCapability": "CONTACTLESS_CHIP", "lane": "street1", "pinEntryCapability": "PIN_NOT_SUPPORTED" }, "authorizationResponse": { "transactionIdentifier": "829343904324606", "returnAci": "Y" } } ``` ```json { "authorizationResponse": { "date": "1021", "processingCode": "003000", "responseCode": "00", "returnAci": "Y", "stan": "1191", "transactionIdentifier": "829343904324606" }, "gatewayEntryPoint": "WEB_SERVICES_API", "merchant": "CYG_S2I_MER2", "order": { "amount": 7.00, "authenticationStatus": "AUTHENTICATION_NOT_IN_EFFECT", "chargeback": { "amount": 0, "currency": "USD" }, "creationTime": "2025-04-09T11:42:44.987Z", "currency": "USD", "id": "A_12", "lastUpdatedTime": "2025-04-09T11:42:45.221Z", "merchantAmount": 7.00, "merchantCategoryCode": "4111", "merchantCurrency": "USD", "status": "CAPTURED", "totalAuthorizedAmount": 7.00, "totalCapturedAmount": 7.00, "totalDisbursedAmount": 0.00, "totalRefundedAmount": 0.00 }, "posTerminal": { "address": { "country": "GBR" }, "attended": "UNATTENDED", "cardholderActivated": "SELF_SERVICE_TERMINAL", "inputCapability": "CONTACTLESS_CHIP", "lane": "street1", "location": "MERCHANT_TERMINAL_ON_PREMISES", "panEntryMode": "CONTACTLESS", "pinEntryCapability": "PIN_NOT_SUPPORTED", "serialNumber": "0123ABCD" }, "response": { "acquirerCode": "00", "acquirerMessage": "Approved", "gatewayCode": "APPROVED" }, "result": "SUCCESS", "sourceOfFunds": { "provided": { "card": { "brand": "MASTERCARD", "emvRequest": { "5F2A": "826", "82": "0000", "84": "010101010101", "95": "0000000000", "9A": "161021", "9B": "0101", "9C": "00", "9F02": "000000001099", "9F03": "000000000000", "9F06": "010101010101", "9F07": "0101", "9F09": "0101", "9F10": "06011103A000000A0100000000000BB0ABAD", "9F1A": "826", "9F1E": "0123ABCD", "9F26": "D1F722D47FCA8273", "9F27": "40", "9F33": "E0B8C8", "9F34": "1E0300", "9F35": "12", "9F36": "0002", "9F37": "2A4E1690", "9F41": "0123", "9F53": "A", "9F6E": "0101" }, "expiry": { "month": "12", "year": "24" }, "fundingMethod": "DEBIT", "number": "555555xxxxxx4444", "scheme": "MASTERCARD", "storedOnFile": "NOT_STORED" } }, "type": "CARD" }, "timeOfLastUpdate": "2025-04-09T11:42:45.221Z", "timeOfRecord": "2025-04-09T11:42:45.020Z", "transaction": { "acquirer": { "batch": 20250409, "date": "0409", "id": "CYG_TESTACQ_S2I", "merchantId": "9808", "settlementDate": "2025-04-09", "timeZone": "+1000" }, "amount": 7.00, "authenticationStatus": "AUTHENTICATION_NOT_IN_EFFECT", "currency": "USD", "id": "A_11", "receipt": "509911001191", "source": "CARD_PRESENT", "stan": "1191", "terminal": "0002", "transit": { "aggregatedFare": { "aggregationStartDate": "2024-05-14", "transportationMode": "TRAIN", "type": "FIRST_RIDE_RISK" } }, "type": "CAPTURE" }, "version": "100" } ``` ## Tap Initiated Debt Recovery {#tap-initiated-debt-recovery} ### [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) {#authorizehahahugoshortcodes31hbhb} ```json { "apiOperation": "AUTHORIZE", "order": { "amount": 100, "currency": "USD" }, "sourceOfFunds": { "provided": { "card": { "emvRequest": { "5A": 5555555555554444, "5F2A": "826", "82": "0000", "84": "010101010101", "95": "0000000000", "9A": "161021", "9B": "0101", "9C": "00", "9F02": "000000001099", "9F03": "000000000000", "9F06": "010101010101", "9F07": "0101", "9F09": "0101", "9F10": "06011103A000000A0100000000000BB0ABAD", "9F1A": "826", "9F1E": "0123ABCD", "9F26": "D1F722D47FCA8273", "9F27": "40", "9F33": "E0B8C8", "9F34": "1E0300", "9F35": "12", "9F36": "0002", "9F37": "2A4E1690", "9F41": "0123", "9F53": "A", "9F6E": "0101" }, "expiry": { "month": "12", "year": "24" }, "number": 5555555555554444 } }, "type": "CARD" }, "transaction": { "source": "CARD_PRESENT", "transit": { "knownFare": { "type": "DEBT_RECOVERY_TAP_INITIATED", "transportationMode": "TRAIN" } } }, "posTerminal": { "attended": "UNATTENDED", "location": "MERCHANT_TERMINAL_ON_PREMISES", "cardholderActivated": "NOT_CARDHOLDER_ACTIVATED", "panEntryMode": "CONTACTLESS", "inputCapability": "CONTACTLESS_CHIP", "lane": "street1", "pinEntryCapability": "PIN_NOT_SUPPORTED" } } ``` ```json { "authorizationResponse": { "commercialCard": "123", "commercialCardIndicator": "1", "date": "0410", "financialNetworkCode": "MCC", "posData": "1000004000300", "posEntryMode": "072", "processingCode": "003000", "responseCode": "00", "stan": "20120", "time": "085656", "transactionIdentifier": "983484593", "transactionIntegrityClass": "A1" }, "gatewayEntryPoint": "WEB_SERVICES_API", "merchant": "CYG_S2I_MER2", "order": { "amount": 100.00, "authenticationStatus": "AUTHENTICATION_NOT_IN_EFFECT", "certainty": "FINAL", "chargeback": { "amount": 0, "currency": "USD" }, "creationTime": "2025-04-10T08:56:56.804Z", "currency": "USD", "id": "A_14", "lastUpdatedTime": "2025-04-10T08:56:56.989Z", "merchantAmount": 100.00, "merchantCategoryCode": "4111", "merchantCurrency": "USD", "status": "AUTHORIZED", "totalAuthorizedAmount": 100.00, "totalCapturedAmount": 0.00, "totalDisbursedAmount": 0.00, "totalRefundedAmount": 0.00 }, "posTerminal": { "address": { "country": "GBR" }, "attended": "UNATTENDED", "cardholderActivated": "NOT_CARDHOLDER_ACTIVATED", "inputCapability": "CONTACTLESS_CHIP", "lane": "street1", "location": "MERCHANT_TERMINAL_ON_PREMISES", "panEntryMode": "CONTACTLESS", "pinEntryCapability": "PIN_NOT_SUPPORTED", "serialNumber": "0123ABCD" }, "response": { "acquirerCode": "00", "acquirerMessage": "Approved", "gatewayCode": "APPROVED", "gatewayRecommendation": "NO_ACTION" }, "result": "SUCCESS", "sourceOfFunds": { "provided": { "card": { "brand": "MASTERCARD", "emvRequest": { "5F2A": "826", "82": "0000", "84": "010101010101", "95": "0000000000", "9A": "161021", "9B": "0101", "9C": "00", "9F02": "000000001099", "9F03": "000000000000", "9F06": "010101010101", "9F07": "0101", "9F09": "0101", "9F10": "06011103A000000A0100000000000BB0ABAD", "9F1A": "826", "9F1E": "0123ABCD", "9F26": "D1F722D47FCA8273", "9F27": "40", "9F33": "E0B8C8", "9F34": "1E0300", "9F35": "12", "9F36": "0002", "9F37": "2A4E1690", "9F41": "0123", "9F53": "A", "9F6E": "0101" }, "emvResponse": { "72": "9F180408041215860E04DA9F5809030691D72E6F027DC6", "91": "B7D5309D4B3E6CDB3030" }, "expiry": { "month": "12", "year": "24" }, "fundingMethod": "DEBIT", "number": "555555xxxxxx4444", "scheme": "MASTERCARD", "storedOnFile": "NOT_STORED" } }, "type": "CARD" }, "timeOfLastUpdate": "2025-04-10T08:56:56.989Z", "timeOfRecord": "2025-04-10T08:56:56.838Z", "transaction": { "acquirer": { "batch": 20250410, "date": "0410", "id": "CYG_TESTACQ_S2I", "merchantId": "9808", "transactionId": "983484593" }, "amount": 100.00, "authenticationStatus": "AUTHENTICATION_NOT_IN_EFFECT", "authorizationCode": "112233", "currency": "USD", "id": "A_15", "receipt": "510008020120", "source": "CARD_PRESENT", "stan": "20120", "terminal": "0001", "transit": { "knownFare": { "type": "DEBT_RECOVERY_TAP_INITIATED" } }, "type": "AUTHORIZATION" }, "version": "100" } ``` ### [Capture](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) {#capturehahahugoshortcodes33hbhb} ```json { "apiOperation": "CAPTURE", "transaction": { "amount": "50", "currency": "USD" } } ``` ```json { "authorizationResponse": { "commercialCard": "123", "commercialCardIndicator": "1", "date": "0410", "financialNetworkCode": "MCC", "posData": "1000004000300", "posEntryMode": "072", "processingCode": "003000", "responseCode": "00", "stan": "20120", "time": "085656", "transactionIdentifier": "983484593", "transactionIntegrityClass": "A1" }, "gatewayEntryPoint": "WEB_SERVICES_API", "merchant": "CYG_S2I_MER2", "order": { "amount": 100.00, "certainty": "FINAL", "chargeback": { "amount": 0, "currency": "USD" }, "creationTime": "2025-04-10T08:56:56.804Z", "currency": "USD", "id": "A_14", "lastUpdatedTime": "2025-04-10T08:58:37.142Z", "merchantAmount": 100.00, "merchantCategoryCode": "4111", "merchantCurrency": "USD", "status": "PARTIALLY_CAPTURED", "totalAuthorizedAmount": 100.00, "totalCapturedAmount": 50.00, "totalDisbursedAmount": 0.00, "totalRefundedAmount": 0.00 }, "posTerminal": { "address": { "country": "GBR" }, "attended": "UNATTENDED", "cardholderActivated": "NOT_CARDHOLDER_ACTIVATED", "inputCapability": "CONTACTLESS_CHIP", "lane": "street1", "location": "MERCHANT_TERMINAL_ON_PREMISES", "panEntryMode": "CONTACTLESS", "pinEntryCapability": "PIN_NOT_SUPPORTED", "serialNumber": "0123ABCD" }, "response": { "acquirerCode": "00", "acquirerMessage": "Approved", "gatewayCode": "APPROVED" }, "result": "SUCCESS", "sourceOfFunds": { "provided": { "card": { "brand": "MASTERCARD", "expiry": { "month": "12", "year": "24" }, "fundingMethod": "DEBIT", "number": "555555xxxxxx4444", "scheme": "MASTERCARD", "storedOnFile": "NOT_STORED" } }, "type": "CARD" }, "timeOfLastUpdate": "2025-04-10T08:58:37.142Z", "timeOfRecord": "2025-04-10T08:58:37.042Z", "transaction": { "acquirer": { "batch": 20250410, "date": "0410", "id": "CYG_TESTACQ_S2I", "merchantId": "9808", "settlementDate": "2025-04-10", "timeZone": "+1000", "transactionId": "983484593" }, "amount": 50.00, "authorizationCode": "112233", "currency": "USD", "id": "A_17", "receipt": "510008020120", "source": "CARD_PRESENT", "stan": "21170", "terminal": "0002", "transit": { "knownFare": { "type": "DEBT_RECOVERY_TAP_INITIATED" } }, "type": "CAPTURE" }, "version": "100" } ``` ## Merchant Initiated Debt Recovery {#merchant-initiated-debt-recovery-1} ### [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) {#authorizehahahugoshortcodes35hbhb} ```json { "apiOperation": "AUTHORIZE", "order": { "amount": 100, "currency": "USD" }, "sourceOfFunds": { "provided": { "card": { "expiry": { "month": "12", "year": "24" }, "number": 5555555555554444 } }, "type": "CARD" }, "transaction": { "source": "MERCHANT", "transit": { "knownFare": { "type": "DEBT_RECOVERY_MERCHANT_INITIATED", "transportationMode": "TRAIN" } } } } ``` ```json { "authorizationResponse": { "commercialCard": "123", "commercialCardIndicator": "1", "date": "0410", "financialNetworkCode": "MCC", "posData": "2034104000000", "posEntryMode": "012", "processingCode": "003000", "responseCode": "00", "stan": "11592", "time": "090204", "transactionIdentifier": "411168519", "transactionIntegrityClass": "A1" }, "gatewayEntryPoint": "WEB_SERVICES_API", "merchant": "CYG_S2I_MER2", "order": { "amount": 100.00, "authenticationStatus": "AUTHENTICATION_NOT_IN_EFFECT", "certainty": "FINAL", "chargeback": { "amount": 0, "currency": "USD" }, "creationTime": "2025-04-10T09:02:03.847Z", "currency": "USD", "id": "A_18", "lastUpdatedTime": "2025-04-10T09:02:04.157Z", "merchantAmount": 100.00, "merchantCategoryCode": "4111", "merchantCurrency": "USD", "status": "AUTHORIZED", "totalAuthorizedAmount": 100.00, "totalCapturedAmount": 0.00, "totalDisbursedAmount": 0.00, "totalRefundedAmount": 0.00 }, "response": { "acquirerCode": "00", "acquirerMessage": "Approved", "gatewayCode": "APPROVED", "gatewayRecommendation": "NO_ACTION" }, "result": "SUCCESS", "sourceOfFunds": { "provided": { "card": { "brand": "MASTERCARD", "expiry": { "month": "12", "year": "24" }, "fundingMethod": "DEBIT", "number": "555555xxxxxx4444", "scheme": "MASTERCARD", "storedOnFile": "NOT_STORED" } }, "type": "CARD" }, "timeOfLastUpdate": "2025-04-10T09:02:04.157Z", "timeOfRecord": "2025-04-10T09:02:03.884Z", "transaction": { "acquirer": { "batch": 20250410, "date": "0410", "id": "CYG_TESTACQ_S2I", "merchantId": "9808", "transactionId": "411168519" }, "amount": 100.00, "authenticationStatus": "AUTHENTICATION_NOT_IN_EFFECT", "authorizationCode": "112233", "currency": "USD", "id": "A_19", "receipt": "510009011592", "source": "MERCHANT", "stan": "11592", "terminal": "0001", "transit": { "knownFare": { "type": "DEBT_RECOVERY_MERCHANT_INITIATED" } }, "type": "AUTHORIZATION" }, "version": "100" } ``` ### [Capture](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) {#capturehahahugoshortcodes37hbhb} ```json { "apiOperation": "CAPTURE", "transaction": { "amount": "50", "currency": "USD" } } ``` ```json { "authorizationResponse": { "commercialCard": "123", "commercialCardIndicator": "1", "date": "0410", "financialNetworkCode": "MCC", "posData": "2034104000000", "posEntryMode": "012", "processingCode": "003000", "responseCode": "00", "stan": "11592", "time": "090204", "transactionIdentifier": "411168519", "transactionIntegrityClass": "A1" }, "gatewayEntryPoint": "WEB_SERVICES_API", "merchant": "CYG_S2I_MER2", "order": { "amount": 100.00, "certainty": "FINAL", "chargeback": { "amount": 0, "currency": "USD" }, "creationTime": "2025-04-10T09:02:03.847Z", "currency": "USD", "id": "A_18", "lastUpdatedTime": "2025-04-10T09:02:43.148Z", "merchantAmount": 100.00, "merchantCategoryCode": "4111", "merchantCurrency": "USD", "status": "PARTIALLY_CAPTURED", "totalAuthorizedAmount": 100.00, "totalCapturedAmount": 50.00, "totalDisbursedAmount": 0.00, "totalRefundedAmount": 0.00 }, "response": { "acquirerCode": "00", "acquirerMessage": "Approved", "gatewayCode": "APPROVED" }, "result": "SUCCESS", "sourceOfFunds": { "provided": { "card": { "brand": "MASTERCARD", "expiry": { "month": "12", "year": "24" }, "fundingMethod": "DEBIT", "number": "555555xxxxxx4444", "scheme": "MASTERCARD", "storedOnFile": "NOT_STORED" } }, "type": "CARD" }, "timeOfLastUpdate": "2025-04-10T09:02:43.148Z", "timeOfRecord": "2025-04-10T09:02:43.081Z", "transaction": { "acquirer": { "batch": 20250410, "date": "0410", "id": "CYG_TESTACQ_S2I", "merchantId": "9808", "settlementDate": "2025-04-10", "timeZone": "+1000", "transactionId": "411168519" }, "amount": 50.00, "authorizationCode": "112233", "currency": "USD", "id": "A_20", "receipt": "510009011592", "source": "MERCHANT", "stan": "12661", "terminal": "0001", "transit": { "knownFare": { "type": "DEBT_RECOVERY_MERCHANT_INITIATED" } }, "type": "CAPTURE" }, "version": "100" } ``` ## Payer Initiated Debt Recovery {#payer-initiated-debt-recovery} ### [Authorize](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) {#authorizehahahugoshortcodes39hbhb} ```json { "apiOperation": "AUTHORIZE", "order": { "amount": 100, "currency": "USD" }, "sourceOfFunds": { "provided": { "card": { "emvRequest": { "5A": 5555555555554444, "5F2A": "826", "82": "0000", "84": "010101010101", "95": "0000000000", "9A": "161021", "9B": "0101", "9C": "00", "9F02": "000000001099", "9F03": "000000000000", "9F06": "010101010101", "9F07": "0101", "9F09": "0101", "9F10": "06011103A000000A0100000000000BB0ABAD", "9F1A": "826", "9F1E": "0123ABCD", "9F26": "D1F722D47FCA8273", "9F27": "40", "9F33": "E0B8C8", "9F34": "1E0300", "9F35": "12", "9F36": "0002", "9F37": "2A4E1690", "9F41": "0123", "9F53": "A", "9F6E": "0101" }, "expiry": { "month": "12", "year": "24" }, "number": 5555555555554444 } }, "type": "CARD" }, "transaction": { "source": "CARD_PRESENT", "transit": { "knownFare": { "type": "DEBT_RECOVERY_PAYER_INITIATED", "transportationMode": "TRAIN" } } }, "posTerminal": { "attended": "UNATTENDED", "location": "MERCHANT_TERMINAL_ON_PREMISES", "cardholderActivated": "NOT_CARDHOLDER_ACTIVATED", "panEntryMode": "CONTACTLESS", "inputCapability": "CONTACTLESS_CHIP", "lane": "street1", "pinEntryCapability": "PIN_NOT_SUPPORTED" } } ``` ```json { "authorizationResponse": { "commercialCard": "123", "commercialCardIndicator": "1", "date": "0410", "financialNetworkCode": "MCC", "posData": "1000004000300", "posEntryMode": "072", "processingCode": "003000", "responseCode": "00", "stan": "13751", "time": "090635", "transactionIdentifier": "477555397", "transactionIntegrityClass": "A1" }, "gatewayEntryPoint": "WEB_SERVICES_API", "merchant": "CYG_S2I_MER2", "order": { "amount": 100.00, "authenticationStatus": "AUTHENTICATION_NOT_IN_EFFECT", "certainty": "FINAL", "chargeback": { "amount": 0, "currency": "USD" }, "creationTime": "2025-04-10T09:06:35.046Z", "currency": "USD", "id": "A_21", "lastUpdatedTime": "2025-04-10T09:06:35.242Z", "merchantAmount": 100.00, "merchantCategoryCode": "4111", "merchantCurrency": "USD", "status": "AUTHORIZED", "totalAuthorizedAmount": 100.00, "totalCapturedAmount": 0.00, "totalDisbursedAmount": 0.00, "totalRefundedAmount": 0.00 }, "posTerminal": { "address": { "country": "GBR" }, "attended": "UNATTENDED", "cardholderActivated": "NOT_CARDHOLDER_ACTIVATED", "inputCapability": "CONTACTLESS_CHIP", "lane": "street1", "location": "MERCHANT_TERMINAL_ON_PREMISES", "panEntryMode": "CONTACTLESS", "pinEntryCapability": "PIN_NOT_SUPPORTED", "serialNumber": "0123ABCD" }, "response": { "acquirerCode": "00", "acquirerMessage": "Approved", "gatewayCode": "APPROVED", "gatewayRecommendation": "NO_ACTION" }, "result": "SUCCESS", "sourceOfFunds": { "provided": { "card": { "brand": "MASTERCARD", "emvRequest": { "5F2A": "826", "82": "0000", "84": "010101010101", "95": "0000000000", "9A": "161021", "9B": "0101", "9C": "00", "9F02": "000000001099", "9F03": "000000000000", "9F06": "010101010101", "9F07": "0101", "9F09": "0101", "9F10": "06011103A000000A0100000000000BB0ABAD", "9F1A": "826", "9F1E": "0123ABCD", "9F26": "D1F722D47FCA8273", "9F27": "40", "9F33": "E0B8C8", "9F34": "1E0300", "9F35": "12", "9F36": "0002", "9F37": "2A4E1690", "9F41": "0123", "9F53": "A", "9F6E": "0101" }, "emvResponse": { "72": "9F180408041215860E04DA9F5809030691D72E6F027DC6", "91": "B7D5309D4B3E6CDB3030" }, "expiry": { "month": "12", "year": "24" }, "fundingMethod": "DEBIT", "number": "555555xxxxxx4444", "scheme": "MASTERCARD", "storedOnFile": "NOT_STORED" } }, "type": "CARD" }, "timeOfLastUpdate": "2025-04-10T09:06:35.242Z", "timeOfRecord": "2025-04-10T09:06:35.080Z", "transaction": { "acquirer": { "batch": 20250410, "date": "0410", "id": "CYG_TESTACQ_S2I", "merchantId": "9808", "transactionId": "477555397" }, "amount": 100.00, "authenticationStatus": "AUTHENTICATION_NOT_IN_EFFECT", "authorizationCode": "112233", "currency": "USD", "id": "A_22", "receipt": "510009013751", "source": "CARD_PRESENT", "stan": "13751", "terminal": "0002", "transit": { "knownFare": { "type": "DEBT_RECOVERY_PAYER_INITIATED" } }, "type": "AUTHORIZATION" }, "version": "100" } ``` ### [Capture](https://developer.mastercard.com/mastercard-gateway/documentation/api-reference/v100/rest/api-ops/index.md#transaction) {#capturehahahugoshortcodes41hbhb} ```json { "apiOperation": "CAPTURE", "transaction": { "amount": "50", "currency": "USD" } } ``` ```json { "authorizationResponse": { "commercialCard": "123", "commercialCardIndicator": "1", "date": "0410", "financialNetworkCode": "MCC", "posData": "1000004000300", "posEntryMode": "072", "processingCode": "003000", "responseCode": "00", "stan": "13751", "time": "090635", "transactionIdentifier": "477555397", "transactionIntegrityClass": "A1" }, "gatewayEntryPoint": "WEB_SERVICES_API", "merchant": "CYG_S2I_MER2", "order": { "amount": 100.00, "certainty": "FINAL", "chargeback": { "amount": 0, "currency": "USD" }, "creationTime": "2025-04-10T09:06:35.046Z", "currency": "USD", "id": "A_21", "lastUpdatedTime": "2025-04-10T09:07:07.559Z", "merchantAmount": 100.00, "merchantCategoryCode": "4111", "merchantCurrency": "USD", "status": "PARTIALLY_CAPTURED", "totalAuthorizedAmount": 100.00, "totalCapturedAmount": 50.00, "totalDisbursedAmount": 0.00, "totalRefundedAmount": 0.00 }, "posTerminal": { "address": { "country": "GBR" }, "attended": "UNATTENDED", "cardholderActivated": "NOT_CARDHOLDER_ACTIVATED", "inputCapability": "CONTACTLESS_CHIP", "lane": "street1", "location": "MERCHANT_TERMINAL_ON_PREMISES", "panEntryMode": "CONTACTLESS", "pinEntryCapability": "PIN_NOT_SUPPORTED", "serialNumber": "0123ABCD" }, "response": { "acquirerCode": "00", "acquirerMessage": "Approved", "gatewayCode": "APPROVED" }, "result": "SUCCESS", "sourceOfFunds": { "provided": { "card": { "brand": "MASTERCARD", "expiry": { "month": "12", "year": "24" }, "fundingMethod": "DEBIT", "number": "555555xxxxxx4444", "scheme": "MASTERCARD", "storedOnFile": "NOT_STORED" } }, "type": "CARD" }, "timeOfLastUpdate": "2025-04-10T09:07:07.559Z", "timeOfRecord": "2025-04-10T09:07:07.035Z", "transaction": { "acquirer": { "batch": 20250410, "date": "0410", "id": "CYG_TESTACQ_S2I", "merchantId": "9808", "settlementDate": "2025-04-10", "timeZone": "+1000", "transactionId": "477555397" }, "amount": 50.00, "authorizationCode": "112233", "currency": "USD", "id": "A_23", "receipt": "510009013751", "source": "CARD_PRESENT", "stan": "14801", "terminal": "0002", "transit": { "knownFare": { "type": "DEBT_RECOVERY_PAYER_INITIATED" } }, "type": "CAPTURE" }, "version": "100" } ```