{"openapi":"3.1.0","info":{"title":"LINK4TECH Kykeon Payment API","description":"**LINK4TECH Kykeon ā Advanced Payment Processing API**\n\nLINK4TECH Kykeon is a powerful and secure payment processing API designed for E-commerce and POS (Point of Sale) systems. It enables businesses to seamlessly process transactions, ensuring fast, reliable, and secure payments** across multiple channels.\n\n---\n\n**Key Features:**\n- **Pre-Authorization (Pre-Auth):** Reserve funds on a customer's card before finalizing a transaction.\n- **Capture:** Confirm and finalize a previously authorized transaction.\n- **Void:** Cancel an authorized transaction before settlement.\n- **Refund:** Process full or partial refunds for completed transactions.\n- **Payout:** Transfer OCT funds.\n- **Hosted Payment Page (HPP):** Redirect cardholders to a Kykeon-hosted checkout with 3-D Secure, Apple Pay and Google Pay; read the outcome via the session API.\n- **Transaction Status Inquiry:** Retrieve real-time transaction details for transparency and reconciliation.\n- **DCC (Dynamic Currency Conversion):** Allow customers to pay in their preferred currency while merchants receive settled amounts in their local currency.\n- **Heartbeat API:** A real-time monitoring system that checks the status of services to ensure high availability.\n- **Reporting API:** Generate detailed transaction reports, including settlement details and reconciliation insights.\n\n---\n\n**Why Choose LINK4TECH Kykeon?**\n- **Seamless API Integration:** Designed for easy integration with E-commerce platforms, POS terminals, and custom applications.\n- **High Security & Compliance:** Supports PCI DSS compliance, tokenization, and secure encryption.\n- **Fast & Scalable:** Handles high-volume transactions with low latency and real-time processing.\n- **Multi-Currency & Global Reach:** Supports various currencies and payment providers (Visa, Mastercard, etc.).\n- **Comprehensive Reporting:** Access real-time and historical transaction data via the Reporting API.\n- **Robust Error Handling & Logging:** Ensures transparent transaction tracking and debugging.\n\n---\n\n**Developer-Friendly API**\n\nWith comprehensive documentation, clear error messages, and real-time monitoring, LINK4TECH Kykeon provides developers with the tools they need to build efficient and scalable payment solutions.\n\n---\n\n**Contact Us**\n\n\n\n","version":"3.1.0","x-logo":{"url":"/static/link4tech.svg"}},"paths":{"/ecomapi/preauth/":{"post":{"tags":["E-commerce payment"],"summary":"Pre-authorization of a payment","description":"This endpoint handles the pre-authorization process of a payment, validating card information and ensuring available credit.","operationId":"run_pre_auth_ecomapi_preauth__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreAuthRequest"},"examples":{"VISA3d":{"summary":"VISA with 3DSecure","description":"A sample request using a VISA card for pre-authorization.","value":{"amount":"12.00","card_number":"4005529999000123","cardholder_name":"John Doe","cavv":"AAAAAAAAAAAAAAAAAAAAAAAAAAA=","currency":"EUR","cvv":"196","expiry_date":"12/31","eci":"05","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"VISA3d_instant":{"summary":"VISA with 3DSecure is instant capture","description":"A sample request using a VISA card for pre-authorization.","value":{"amount":"12.00","card_number":"4005529999000123","cardholder_name":"John Doe","cavv":"AAAAAAAAAAAAAAAAAAAAAAAAAAA=","currency":"EUR","cvv":"196","expiry_date":"12/31","eci":"05","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030","is_instant_capture":true}},"MASTERCARD3d":{"summary":"MASTERCARD with 3DSecure","description":"A sample request using a MASTERCARD card for pre-authorization.","value":{"amount":"207.44","card_number":"5346932100108113","cardholder_name":"Jane Smith","cavv":"kBAYYgZVLBwElztQZ4AN8peB2CW6","ds_transaction_id":"f4c9f127-69b9-40f3-8d07-475d1dbs4d3f","currency":"EUR","cvv":"123","expiry_date":"11/25","emv_3d_secure_ver":"2.2","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"MASTERCARD3dAVS":{"summary":"MASTERCARD Address Verification Service (AVS)","description":"A sample request using a MASTERCARD card for pre-authorization with AVS","value":{"amount":"207.44","card_number":"5346932100108113","cardholder_name":"Jane Smith","cavv":"kBAYYgZVLBwElztQZ4AN8peB2CW6","ds_transaction_id":"f4c9f127-69b9-40f3-8d07-475d1dbs4d3f","currency":"EUR","cvv":"123","expiry_date":"11/25","emv_3d_secure_ver":"2.2","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030","avs":{"service_indicator":"01","postal_code":"2013","address":"60 LEMESOU AVE"}}},"VISAnon3d":{"summary":"VISA without 3DSecure","description":"A sample request using a VISA card for pre-authorization.","value":{"amount":"12.00","card_number":"4005529999000123","cardholder_name":"John Doe","currency":"EUR","cvv":"196","expiry_date":"12/31","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"MASTERCARDnon3d":{"summary":"MASTERCARD without 3DSecure","description":"A sample request using a MASTERCARD card for pre-authorization.","value":{"amount":"87.61","card_number":"5346932100108113","cardholder_name":"Igo Ria","currency":"EUR","cvv":"123","expiry_date":"12/25","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"VISAseriestypeinit":{"summary":"VISA INITIAL FOR recurring or unscheduled (UCOF, Unscheduled Credential on File)","description":"VISA INITIAL FOR recurring or unscheduled. \n Possible values for 'series_type' are 'recurring' or 'unscheduled' (UCOF, Unscheduled Credential on File)","value":{"amount":"12.00","card_number":"4005529999000123","cardholder_name":"John Doe","currency":"EUR","cvv":"196","expiry_date":"12/31","cavv":"AAAAAAAAAAAAAAAAAAAAAAAAAAA=","series_type":"unscheduled","eci":"05","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"VISAseriestypesubsequent":{"summary":"VISA SUBSEQUENT FOR recurring or unscheduled (UCOF, Unscheduled Credential on File)","description":"VISA SUBSEQUENT FOR recurring or unscheduled (UCOF, Unscheduled Credential on File)","value":{"amount":"12.00","card_number":"4005529999000123","cardholder_name":"John Doe","currency":"EUR","cvv":"196","expiry_date":"12/31","initial_transaction_id":"120312472701006919250123433812131353","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"MASTERCARDseriestypeinit":{"summary":"MASTERCARD INITIAL FOR variable_amount_recurring, fix_amount_recurring or unscheduled (UCOF, Unscheduled Credential on File)","description":"MASTERCARD INITIAL FOR recurring or unscheduled. (UCOF, Unscheduled Credential on File)\n Possible values for 'series_type' are 'variable_amount_recurring', 'fix_amount_recurring' or 'unscheduled'","value":{"amount":"14.00","card_number":"5185520070000016","cardholder_name":"Jane Smith","currency":"EUR","cvv":"001","expiry_date":"12/25","cavv":"kBAYYgZVLBwElztQZ4AN8peB2CW6","ds_transaction_id":"f4c9f127-69b9-40f3-8d07-475d1dbs4d3f","series_type":"fix_amount_recurring","emv_3d_secure_ver":"2.2","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"MASTERCARDseriestypesubsequent":{"summary":"MASTERCARD SUBSEQUENT FOR variable_amount_recurring, fix_amount_recurring or unscheduled (UCOF, Unscheduled Credential on File)","description":"MASTERCARD SUBSEQUENT FOR recurring or unscheduled.","value":{"amount":"14.00","card_number":"5185520070000016","cardholder_name":"Jane Smith","currency":"EUR","cvv":"001","expiry_date":"12/25","initial_transaction_id":"120312472701006919250123433812131353","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"VISA3dAFT":{"summary":"VISA AFT with 3DSecure","description":"A sample request using a VISA AFT card for pre-authorization.","value":{"amount":"12.00","card_number":"4005529999000123","cardholder_name":"John Doe","cavv":"AAAAAAAAAAAAAAAAAAAAAAAAAAA=","currency":"EUR","cvv":"196","expiry_date":"12/31","eci":"05","aft":{"sender":{"name":"John Doe","address":"Street House 123","city":"Nicosia","country":"CYP"},"recipient":{"account_number":"CY74PATC40021100101122","account_number_type":"IBAN","country":"CYP","address":{"line1":"60","street":"Lemesou Avenue","city":"Nicosia","postal_code":"2014"},"name":{"full_name":"John R Doe"}},"transaction_purpose":"Other"},"transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"VISA_AFT_UNSCHEDULED_INIT":{"summary":"VISA AFT initial unscheduled payment","description":"A sample request using a VISA AFT initial unscheduled payment.","value":{"amount":"2.01","card_number":"4005529999000123","cavv":"AAAAAAAAAAAAAAAAAAAAAAAAAAA=","currency":"EUR","cvv":"196","expiry_date":"12/31","eci":"05","series_type":"unscheduled","aft":{"sender":{"name":"John Doe","address":"Street House 123","city":"Nicosia","country":"CYP"},"recipient":{"account_number":"CY74PATC40021100101122","account_number_type":"IBAN","country":"CYP","address":{"line1":"60","street":"Lemesou Avenue","city":"Nicosia","postal_code":"2014"},"name":{"full_name":"John R Doe"}},"transaction_purpose":"Other"}}},"VISA_AFT_UNSCHEDULED_SUBSEQUENT":{"summary":"VISA AFT subsequent unscheduled payment","description":"A sample request using a VISA AFT subsequent unscheduled payment.","value":{"amount":"2.22","card_number":"4005529999000123","currency":"EUR","expiry_date":"12/31","series_type":"unscheduled","eci":"07","initial_transaction_id":"090409470901004186060123624709418606","aft":{"sender":{"name":"John Doe Second","address":"Street House 321","city":"Nicosia","country":"CYP"},"recipient":{"account_number":"CY74PATC40021100101122","account_number_type":"IBAN","country":"CYP","address":{"line1":"60","street":"Lemesou Avenue","city":"Nicosia","postal_code":"2014"},"name":{"full_name":"John F Doe"}},"transaction_purpose":"Other"}}},"VISA_AFT_UNSCHEDULED_SUBSEQUENT_EXTERNAL":{"summary":"VISA AFT subsequent unscheduled payment using external initial transaction data","description":"A sample request using a VISA AFT subsequent unscheduled payment.","value":{"amount":"1.23","card_number":"4005529999000123","currency":"EUR","expiry_date":"12/31","series_type":"unscheduled","cardholder_name":"John Doe","external_init_transaction":{"transaction_id":"306247352296637"},"aft":{"sender":{"name":"John Doe","address":"Street House 123","city":"Nicosia","country":"CYP"},"recipient":{"account_number":"CY74PATC40021100101122","account_number_type":"IBAN","country":"CYP","address":{"line1":"60","street":"Lemesou Avenue","city":"Nicosia","postal_code":"2014"},"name":{"full_name":"John R Doe"}},"transaction_purpose":"Other"}}},"VISA_AFT_RECURRING_INITIAL":{"summary":"VISA AFT initial recurring payment","description":"A sample request using a VISA AFT initial recurring payment.","value":{"amount":"3.01","card_number":"4005529999000123","cavv":"AAAAAAAAAAAAAAAAAAAAAAAAAAA=","currency":"EUR","cvv":"196","expiry_date":"12/31","eci":"05","series_type":"recurring","aft":{"sender":{"name":"John Doe","address":"Street House 123","city":"Nicosia","country":"CYP"},"recipient":{"account_number":"CY74PATC40021100101122","account_number_type":"IBAN","country":"CYP","address":{"line1":"60","street":"Lemesou Avenue","city":"Nicosia","postal_code":"2014"},"name":{"full_name":"John R Doe"}},"transaction_purpose":"Other"}}},"VISA_AFT_RECURRING_SUBSEQUENT":{"summary":"VISA AFT subsequent recurring payment","description":"A sample request using a VISA AFT subsequent recurring payment.","value":{"amount":"4.01","card_number":"4005529999000123","currency":"EUR","cvv":"196","expiry_date":"12/31","eci":"07","series_type":"recurring","initial_transaction_id":"090411054601003208190123624711320819","aft":{"sender":{"name":"John Doe","address":"Street House 123","city":"Nicosia","country":"CYP"},"recipient":{"account_number":"CY74PATC40021100101122","account_number_type":"IBAN","country":"CYP","address":{"line1":"60","street":"Lemesou Avenue","city":"Nicosia","postal_code":"2014"},"name":{"full_name":"John R Doe"}},"transaction_purpose":"Other"}}},"VISA_AFT_RECURRING_SUBSEQUENT_EXTERNAL":{"summary":"VISA AFT subsequent recurring payment with external initiation transaction","description":"A sample request using a VISA AFT subsequent recurring payment using external initiation transaction data.","value":{"amount":"5.01","card_number":"4005529999000123","currency":"EUR","expiry_date":"12/31","series_type":"recurring","external_init_transaction":{"transaction_id":"306247399473550"},"aft":{"sender":{"name":"John Doe","address":"Street House 123","city":"Nicosia","country":"CYP"},"recipient":{"account_number":"CY74PATC40021100101122","account_number_type":"IBAN","country":"CYP","address":{"line1":"60","street":"Lemesou Avenue","city":"Nicosia","postal_code":"2014"},"name":{"full_name":"John R Doe"}},"transaction_purpose":"Other"}}},"MASTERCARD3dAFT_person":{"summary":"MASTERCARD FT with 3DSecure to person","description":"A sample request using a MASTERCARD Funding Transaction for pre-authorization.","value":{"amount":"15.00","card_number":"5346932100108113","cardholder_name":"John Doe","currency":"EUR","cvv":"001","expiry_date":"12/29","cavv":"kBAYYgZVLBwElztQZ4AN8peB2CW6","emv_3d_secure_ver":"2.2","aft":{"recipient":{"account_number":"+17653032020","account_number_type":"Phone_Number","country":"USA","state":"IN","address":{"line1":"3270 Kirkbride Way","city":"Indianapolis","postal_code":"46222"},"name":{"first_name":"John","last_name":"Doe"}},"transaction_purpose":"High_Risk_Securities"},"transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"MASTERCARD3dAFT_business":{"summary":"MASTERCARD FT with 3DSecure to business","description":"A sample request to business using a MASTERCARD Funding Transaction for pre-authorization.","value":{"amount":"15.00","card_number":"5346932100108113","cardholder_name":"John Doe","currency":"EUR","cvv":"001","expiry_date":"12/29","cavv":"kBAYYgZVLBwElztQZ4AN8peB2CW6","ds_transaction_id":"f4c9f127-69b9-40f3-8d07-475d1dbs4d3f","emv_3d_secure_ver":"2.2","aft":{"recipient":{"account_number":"CY74PATC40021100101122","account_number_type":"IBAN","name":{"first_name":"LINK4TECH","last_name":"LINK4TECH"},"country":"CYP","address":{"line1":"60 Lemesou Ave.","city":"Nicosia","postal_code":"2014"}},"transaction_purpose":"High_Risk_Securities"},"transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"MASTERCARD_AFT_initial_recurring_to_person":{"summary":"MASTERCARD FT. Initial recurring to person","description":"A sample request using a MASTERCARD recurring Funding Transaction to person","value":{"amount":"25.25","card_number":"5346932100108113","currency":"EUR","cvv":"001","expiry_date":"12/29","cavv":"kBAYYgZVLBwElztQZ4AN8peB2CW6","emv_3d_secure_ver":"2.2","series_type":"fix_amount_recurring","aft":{"recipient":{"account_number":"+17653032020","account_number_type":"Phone_Number","country":"USA","state":"IN","address":{"line1":"3270 Kirkbride Way","city":"Indianapolis","postal_code":"46222"},"name":{"first_name":"Jim","last_name":"Hopper"}},"transaction_purpose":"Savings"}}},"MASTERCARD_AFT_subsequent_recurring_to_person":{"summary":"MASTERCARD FT. Subsequent recurring to person","description":"A sample request using a MASTERCARD subsequent recurring Funding Transaction to person","value":{"amount":"25.25","card_number":"5346932100108113","currency":"EUR","expiry_date":"12/29","series_type":"fix_amount_recurring","initial_transaction_id":"090909182801004179258113625209534518","aft":{"recipient":{"account_number":"+17653032020","account_number_type":"Phone_Number","name":{"first_name":"Jim","last_name":"Hopper"},"address":{"line1":"3270 Kirkbride Way","city":"Indianapolis","postal_code":"46222"}},"transaction_purpose":"Savings"}}},"MASTERCARD_AFT_subsequent_recurring_to_person_external":{"summary":"MASTERCARD FT. Subsequent recurring to person wiht external initial transaction","description":"A sample request using a MASTERCARD subsequent recurring Funding Transaction to person with external initial data","value":{"amount":"25.25","card_number":"5346932100108113","currency":"EUR","expiry_date":"12/29","series_type":"fix_amount_recurring","external_init_transaction":{"transaction_id":"MCCC5DZUB","date":"0909","tlid":"XsthOg0LR-qPSdcoHKi7Ig"},"aft":{"recipient":{"account_number":"+17653032020","account_number_type":"Phone_Number","name":{"first_name":"Jim","last_name":"Hopper"},"address":{"line1":"3270 Kirkbride Way","city":"Indianapolis","postal_code":"46222"}},"transaction_purpose":"Savings"}}},"MASTERCARD_AFT_initial_unscheduled_to_business":{"summary":"MASTERCARD FT. Initial unscheduled to business","description":"A sample request using a MASTERCARD initial unscheduled Funding Transaction to business","value":{"amount":"5.25","currency":"EUR","card_number":"5346932100108113","cvv":"001","expiry_date":"12/29","emv_3d_secure_ver":"2.2","cardholder_name":"Igo Ria","cavv":"kBAYYgZVLBwElztQZ4AN8peB2CW6","series_type":"unscheduled","aft":{"recipient":{"account_number":"CY74PATC40021100101122","account_number_type":"IBAN","name":{"first_name":"LINK4TECH","last_name":"LINK4TECH"},"country":"CYP","address":{"line1":"60 Lemesou Ave.","city":"Nicosia","postal_code":"2014"}},"transaction_purpose":"High_Risk_Securities"}}},"MASTERCARD_AFT_subsequent_unscheduled_to_business":{"summary":"MASTERCARD FT. Subsequent unscheduled to business","description":"A sample request using a MASTERCARD subsequent unscheduled Funding Transaction to business","value":{"amount":"1.25","currency":"EUR","card_number":"5346932100108113","expiry_date":"12/29","cardholder_name":"Igo Ria","series_type":"unscheduled","initial_transaction_id":"090909265201008784498113625209197352","aft":{"recipient":{"account_number":"CY74PATC40021100101122","account_number_type":"IBAN","name":{"first_name":"LINK4TECH","last_name":"LINK4TECH"},"country":"CYP","address":{"line1":"60 Lemesou Ave.","city":"Nicosia","postal_code":"2014"}},"transaction_purpose":"High_Risk_Securities"}}},"VISA_wallet":{"summary":"VISA GooglePay, ApplePay","description":"request using digital payment cryptogram","value":{"amount":"8.00","card_number":"4005529999000123","cardholder_name":"John Doe","cavv":"AAAAAAAAAAAAAAAAAAAAAAAAAAA=","currency":"EUR","cvv":"196","expiry_date":"12/31","eci":"05","wallet":"google_pay","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"VISATOKEN":{"summary":"VISA - TOKEN COF","description":"A sample request using a VISA tokenized card for transaction.","value":{"card_number":"4895370016097492","expiry_date":"12/31","amount":"33.00","currency":"USD","tavv":"AwAAAAAA3i/8YH7QQ22kQHsAAAA=","eci":"07","wallet":"merchant","pan_entry_mode":"card_on_file"}},"VISATOKENSECURE":{"summary":"VISA - TOKEN COF with SCA","description":"A sample request using a VISA tokenized card with SCA for transaction.","value":{"card_number":"4895370016097492","expiry_date":"12/31","amount":"33.00","currency":"USD","tavv":"AwAAAAAA3i/8YH7QQ22kQHsAAAA=","cavv":"AAAAAAAAAAAAAAAAAAAAAAAAAAA=","eci":"05","wallet":"merchant","pan_entry_mode":"card_on_file"}},"VISATOKENSERIESINIT":{"summary":"VISA - TOKEN COF initial series type","description":"A sample request using a VISA tokenized card for initiate first series transaction","value":{"card_number":"4895370016097492","expiry_date":"12/31","amount":"33.00","currency":"USD","cavv":"AAAAAAAAAAAAAAAAAAAAAAAAAAA=","series_type":"unscheduled","eci":"05","wallet":"merchant","pan_entry_mode":"card_on_file"}},"VISATOKENSERIESSUBSEQUENT":{"summary":"VISA - TOKEN COF subsequent","description":"A sample request using a VISA tokenized card for subsequent series type transaction","value":{"card_number":"4895370016097492","expiry_date":"12/31","amount":"33.00","currency":"USD","tavv":"AAAAAAAAAAAAAAAAAAAAAAAAAAA=","series_type":"unscheduled","eci":"02","wallet":"merchant","external_init_transaction":{"transaction_id":"0265786446346328"}}},"VISAMOTOECOM":{"summary":"VISA - MOTO","description":"A sample request using a VISA as MOTO","value":{"card_number":"4123569999000282","expiry_date":"12/31","amount":"33.01","currency":"EUR","eci":"01","pan_entry_mode":"manual"}},"MCMOTOECOM":{"summary":"Mastercard - MOTO","description":"A sample request using a Mastercard as MOTO","value":{"card_number":"5346932100108113","expiry_date":"12/26","amount":"23.00","currency":"EUR","pan_entry_mode":"manual","cvv":"123"}},"MCTOKEN":{"summary":"Mastercard - TOKEN COF","description":"A sample request using a Mastercard tokenized card for transaction.","value":{"card_number":"5204736020001303","expiry_date":"12/25","amount":"23.00","currency":"USD","wallet":"merchant","token":{"requestor_id":"50132904993"}}},"MCTOKENSUBSEQUENTRECURRING":{"summary":"Mastercard - TOKEN subsequent recurring payment","description":"A sample request using a Mastercard subsequent recurring payment token transaction","value":{"card_number":"5204736020001303","expiry_date":"12/25","amount":"23.00","currency":"USD","wallet":"merchant","series_type":"fix_amount_recurring","external_init_transaction":{"transaction_id":"MCDTJL5GV","date":"0609"},"token":{"device_type":"04","mastercard_assigned_ID":"034123"}}},"MASTERCARD_wallet":{"summary":"MASTERCARD ApplePay","description":"A sample request using digital payment cryptogram","value":{"amount":"7.44","card_number":"5346932100108113","cardholder_name":"Jane Smith","cavv":"AAAAAAAAAAAAAAAAAAAAAAAAAAA=","currency":"EUR","cvv":"123","expiry_date":"11/25","eci":"05","wallet":"apple_pay","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"MASTERCARD_GooglePay":{"summary":"MASTERCARD GooglePay","description":"A sample request using digital payment cryptogram","value":{"cvv":"123","tavv":"AwAAAAABVgovzfsAmcOPgoQAAAA=","amount":"1.52","wallet":"google_pay","currency":"EUR","card_number":"5346932100108113","expiry_date":"12/26","cardholder_name":"JOHN DOE","ds_transaction_id":"21503638-4970-48ed-8109-c1b3d4d62e02","emv_3d_secure_ver":"2.2","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"VISAseriestypesubsequentExternal":{"summary":"VISA SUBSEQUENT FOR recurring or unscheduled with external initial transaction data","description":"VISA SUBSEQUENT FOR recurring or unscheduled using external initial transaction data","value":{"amount":"22.00","card_number":"4005529999000123","cardholder_name":"John Doe","currency":"EUR","cvv":"196","expiry_date":"12/31","series_type":"unscheduled","external_init_transaction":{"transaction_id":"384106495009871"},"transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"MASTERCARDseriestypesubsequentExternal":{"summary":"MASTERCARD SUBSEQUENT FOR recurring or unscheduled with external initial transaction data","description":"MASTERCARD SUBSEQUENT FOR recurring or unscheduled using external initial transaction data","value":{"amount":"24.00","card_number":"5185520070000016","cardholder_name":"Jane Smith","currency":"EUR","cvv":"001","expiry_date":"12/25","series_type":"fix_amount_recurring","external_init_transaction":{"transaction_id":"MCCSSTJ9O","date":"0122","tlid":"7WFe1LqMR7WT3FqPlA_6rQ"},"transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"invalid":{"summary":"Invalid data example","description":"An example of invalid data rejected by the API.","value":{"amount":"abc","card_number":"1234","cardholder_name":"Invalid User","cavv":"InvalidCAVV","currency":"XYZ","cvv":"12","expiry_date":"99/99"}}}}}},"responses":{"200":{"description":"Pre-authentication successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreAuthResponse"},"example":{"status":"Transaction success","message":"Pre-authentication successful","transaction_id":"112109074601004227550123432609182310","authorized_amount":"12.00","status_code":200,"processed_at":"2024-11-18T17:47:21","bank_status_code":"00","bank_status":"Approved","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030","rrn":"607514207399","authorization_code":"LH4Q5J","system_trace_number":"476107","processing_code_resp":"003000","card_acceptor_id":"123490570889 ","transaction_link_id":"v1i08F_WQWe2FPoLPQyoMg","host_txid":"MCCM5ZWFW","additional_resp_data":"0511","validation_code":""}}}},"400":{"description":"Bad Request ā Payment declined or invalid input","content":{"application/json":{"example":{"status":"Transaction declined","message":"Pre-authentication failed","transaction_id":"112109074601004227550123432609182310","authorized_amount":"12.00","status_code":400,"processed_at":"2024-11-18T17:47:21","bank_status_code":"05","bank_status":"Insufficient funds","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030","rrn":"607514207399","authorization_code":"LH4Q5J","system_trace_number":"476107","processing_code_resp":"003000","card_acceptor_id":"123490570889 ","transaction_link_id":"v1i08F_WQWe2FPoLPQyoMg","host_txid":"MCCM5ZWFW","additional_resp_data":"0511","validation_code":"","merchant_advice":"03"}}}},"500":{"description":"Internal Server Error ā Unexpected error occurred","content":{"application/json":{"example":{"detail":"Internal Server Error","message":"An error occurred during pre-authentication"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/ecomapi/capture/":{"post":{"tags":["E-commerce payment"],"summary":"Capture a payment","description":"This endpoint captures an authorized payment, completing the transaction and transferring funds.","operationId":"run_capture_ecomapi_capture__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptureRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptureResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/ecomapi/refund/":{"post":{"tags":["E-commerce payment"],"summary":"Refund a payment","description":"This endpoint processes a refund for a completed payment, returning funds to the customer.","operationId":"run_refund_ecomapi_refund__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundRequest"},"examples":{"refund":{"summary":"ECOM VISA refund","description":"A sample request using a VISA card for refund.","value":{"transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030","transaction_id":"120415164401005769960123433915967345","amount":"12.00","deviceFingerprint":{"timezone":"330","browserColorDepth":"24","browserLanguage":"en-GB","browserScreenHeight":"1080","browserScreenWidth":"1920","os":"Windows","browserAcceptHeader":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*","userAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Safari/537.36","browserJavascriptEnabled":"false","browserJavaEnabled":"true","acceptContent":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3","browserIP":"192.1.1.1"}}},"unlined_refund":{"summary":"ECOM VISA UNLINKED refund","description":"A sample request using a VISA card for UNLINKED refund.","value":{"amount":"13.30","currency":"EUR","card_number":"4123569999000282","expiry_date":"12/31"}},"external_initiated_refund_visa":{"summary":"ECOM VISA EXTERNAL AUTHORIZED refund","description":"A request using a VISA card for refund transaction which authorized another processor.","value":{"amount":"1.30","currency":"EUR","expiry_date":"12/31","card_number":"4005529999000123","dynamic_descriptor":"SOME DDR","external_init_transaction":{"transaction_id":"306147281812342"}}},"external_initiated_refund_mc":{"summary":"ECOM MASTERCARD EXTERNAL AUTHORIZED refund","description":"A request using a MASTERCARD card for refund transaction which authorized another processor.","value":{"amount":"1.32","card_number":"5204740000000004","currency":"EUR","expiry_date":"11/26","external_init_transaction":{"date":"0527","tlid":"6LepJn9OT-miJfqGNqNl9A","transaction_id":"MCCCV4APY"}}}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/ecomapi/void/":{"post":{"tags":["E-commerce payment"],"summary":"Void a payment","description":"This endpoint voids a previously authorized or captured payment, cancelling the transaction before settlement.","operationId":"run_void_ecomapi_void__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/ecomapi/void-refund/":{"post":{"tags":["E-commerce payment"],"summary":"Void a refund","description":"This endpoint voids a previously authorized refund, cancelling the transaction before settlement.","operationId":"run_void_refund_ecomapi_void_refund__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/ecomapi/payout/":{"post":{"tags":["E-commerce payment"],"summary":"Payout","description":"This endpoint handles the payout process, validating card information and ensuring available credit.","operationId":"run_payout_ecomapi_payout__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutRequest"},"examples":{"VISA_payout":{"summary":"VISA OCT","description":"A sample request using a VISA card for OCT.","value":{"amount":"12.00","card_number":"4005529999000123","cardholder_name":"Ig Riapayout","currency":"EUR","expiry_date":"12/31","dynamic_descriptor":"VISA OCT Transfer","payer_account_number":"CY74PATC40021100101122","payer_full_name":"Ig Riapayout","payer_address":"Lemesos Ave 60","payer_city":"Nicosia","payer_country":"CYP","payer_postal_code":"2014","payee_full_name":"Igor Riapayout","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"MASTERCARD_payout":{"summary":"MASTERCARD OCT","description":"A sample request using a MASTERCARD card for OCT.","value":{"amount":"12.00","card_number":"5346932100108113","cardholder_name":"Ig Riapayout","currency":"EUR","expiry_date":"12/31","dynamic_descriptor":"MC OCT Transfer","payer_account_number":"BG41PATC40022312219709","payer_first_name":"John","payer_last_name":"Doe","payer_address":"Lyas 46","payer_city":"Nicosia","payer_country":"CYP","payer_postal_code":"1510","payee_first_name":"Igor","payee_last_name":"Riabushkin","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}}}}}},"responses":{"200":{"description":"Payout successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutResponse"},"example":{"status":"Transaction success","message":"Payout successful","transaction_id":"112109074601004227550123432609182310","authorized_amount":"12.01","status_code":200,"processed_at":"2025-04-25T17:47:21","bank_status_code":"00","bank_status":"Approved","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030","rrn":"607514207399","authorization_code":"046810","system_trace_number":"207399","processing_code_resp":"003000","card_acceptor_id":"123490570889 ","transaction_link_id":"v1i08F_WQWe2FPoLPQyoMg","host_txid":"MCCM5ZWFW"}}}},"400":{"description":"Bad Request ā Payout declined or invalid input","content":{"application/json":{"example":{"status":"Transaction declined","message":"Payout failed","transaction_id":"112109074601004227550123432609182310","authorized_amount":"12.01","status_code":400,"processed_at":"2025-04-25T17:47:21","bank_status_code":"05","bank_status":"Insufficient funds","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030","rrn":"607514207399","authorization_code":"046810","system_trace_number":"207399","processing_code_resp":"003000","card_acceptor_id":"123490570889 ","transaction_link_id":"v1i08F_WQWe2FPoLPQyoMg","host_txid":"MCCM5ZWFW"}}}},"500":{"description":"Internal Server Error ā Unexpected error occurred","content":{"application/json":{"example":{"detail":"Internal Server Error","message":"An error occurred during pre-authentication"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/ecomapi/transactionstatus/":{"post":{"tags":["E-commerce payment"],"summary":"Check the Transaction status","description":"This endpoint provides the current Transaction status of the Kykeon payment service.","operationId":"run_status_ecomapi_transactionstatus__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionStatusRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/posapi/auth/":{"post":{"tags":["POS payment"],"summary":"Authorization of a POS payment","description":"# Authorization of a POS Payment\n\nThis endpoint is responsible for processing the authorization of POS payments, utilizing card scheme specifications for proper data formatting and validation.\n\n## š Reference Documentation\n\nThe field values used in the authorization request are derived based on the official specifications:\n\n- **VISA** ā Full Service POS Online Messages Technical Specifications \n- **MASTERCARD** ā Customer Interface Specification \n\nThese specifications define how transaction-related data should be structured and interpreted.\n\n---\n\n## š Understanding the `\"icc\"` Value\n\nThe `\"icc\"` field contains a **Base64-encoded** string representing an **ICC (Integrated Circuit Card) Data Block**. \nThis block is a structured sequence of transaction-related data elements obtained from the EMV chip during a payment transaction.\n\n### š ļø Steps to Generate the `\"icc\"` Value:\n\n1ļøā£ **Transaction Data Retrieval** \n - The system collects raw transaction data from the payment terminal (e.g., card number, transaction amount, terminal details, cryptographic elements).\n\n2ļøā£ **Data Formatting into EMV Tags** \n - The collected information is formatted according to **EMV (Europay, Mastercard, and Visa) standards**. \n - Each data point is represented as a **Tag-Length-Value (TLV) structure**, where:\n - **Tag**: Identifies the type of data (e.g., `5F2A` for currency code).\n - **Length**: Defines the byte size of the value.\n - **Value**: Contains the actual transaction details.\n\n3ļøā£ **Concatenation of EMV Data** \n - The formatted **TLV elements** are concatenated into a single **binary data sequence** that represents all required transaction parameters.\n\n4ļøā£ **Encoding to Base64** \n - The resulting **binary sequence** is then encoded using **Base64**, producing a string-safe representation suitable for transmission in the API request.\n\n---\n\n## š·ļø Example of `\"icc\"` Value:\n5F2A0209785F340111820279008407A0000000041010950500000080009A032502059C01009F02060000000098009F090200029F10120110A5000F040000000000000000000000FF9F1A0201969F26081516A4C140CFA53C9F2701809F330360D8C89F34034103029F3501249F360200029F3704E82EE8569F40056000F01001\n### š **Decoded ICC Value:**\nNUYyQTAyMDk3ODVGMzQwMTExODIwMjc5MDA4NDA3QTAwMDAwMDAwNDEwMTA5NTA1MDAwMDAwODAwMDlBMDMyNTAyMDU5QzAxMDA5RjAyMDYwMDAwMDAwMDk4MDA5RjA5MDIwMDAyOUYxMDEyMDExMEE1MDAwRjA0MDAwMDAwMDAwMDAwMDAwMDAwMDAwMEZGOUYxQTAyMDE5NjlGMjYwODE1MTZBNEMxNDBDRkE1M0M5RjI3MDE4MDlGMzMwMzYwRDhDODlGMzQwMzQxMDMwMjlGMzUwMTI0OUYzNjAyMDAwMjlGMzcwNEU4MkVFODU2OUY0MDA1NjAwMEYwMTAwMQ==\n\n## š DUKPT Encryption Requirements \n\nCertain fields in the authorization request must be **encrypted** using **DUKPT (Derived Unique Key Per Transaction)** to ensure secure transmission of sensitive data.\n\n### **š Fields That Require DUKPT Encryption** \n\n- **Card Number (`cardNumber`)** \n ```json\n \"cardNumber\": \"EBE017EBD3BD186E72876963DBDCDA95\"\n- **Track2 (`track2`)** \n ```json\n \"track2\": \"EBE017EBD3BD186EBC5E646953F4C20897AB277D2356E971\"\n \nIf the transaction includes an Online PIN, the following additional field must be encrypted using DUKPT:\n- **onlinePinBlock (`onlinePinBlock`)** \n ```json\n \"onlinePinBlock\": \"A0D83C77EAC5324C\"\n\n## š Message Integrity Verification with HMAC \n\nEach message **must include an HMAC (Hash-based Message Authentication Code) value** to ensure data integrity and authenticity. \nThe HMAC is calculated over the **full body** of the request using a shared secret key.\n\n### **š HMAC Calculation Steps** \n\n1ļøā£ **Serialize the Full Message Body** into a deterministic format (e.g., JSON with sorted keys). \n2ļøā£ **Hash the Serialized Data** using a cryptographic hash function (e.g., SHA-256). \n3ļøā£ **Generate the HMAC** using the shared secret key and the hashed message body. \n4ļøā£ **Include the HMAC in the request mac** as: \nFor example for MASTERCARD -CVM CHIP message and SECRET_KEY = '1234567890' MAC value = below\n- **mac (`mac`)** \n ```json\n \"mac\": \"'MuQvNe9GSA+3AZkw4f0DrkeohIWT17Y7k1wieociL9o='\"","operationId":"run_pos_auth_posapi_auth__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosAuthRequest"},"examples":{"MCCHIPCVM98":{"summary":"MASTERCARD - CVM CHIP","description":"A sample request using a MASTERCARD card for POS authorization.","value":{"trxnType":"PURCHASE","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"051","icc":"NUYyQTAyMDk3ODVGMzQwMTExODIwMjc5MDA4NDA3QTAwMDAwMDAwNDEwMTA5NTA1MDAwMDAwODAwMDlBMDMyNTAyMDU5QzAxMDA5RjAyMDYwMDAwMDAwMDk4MDA5RjA5MDIwMDAyOUYxMDEyMDExMEE1MDAwRjA0MDAwMDAwMDAwMDAwMDAwMDAwMDAwMEZGOUYxQTAyMDE5NjlGMjYwODE1MTZBNEMxNDBDRkE1M0M5RjI3MDE4MDlGMzMwMzYwRDhDODlGMzQwMzQxMDMwMjlGMzUwMTI0OUYzNjAyMDAwMjlGMzcwNEU4MkVFODU2OUY0MDA1NjAwMEYwMTAwMQ==","keyId":"0001"},"cardData":{"cardNumber":"EBE017EBD3BD186E72876963DBDCDA95","expDate":"4912","track2":"EBE017EBD3BD186EBC5E646953F4C20897AB277D2356E971","ksn":"1044201196FC40001162","mskdPAN":"541333******0653","cardSeqNum":"0011","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"MASTERCARD CREDIT"},"mac":"N0FDMjE5NkZGODEzQ0E1NTM4QTU5NzU3OTY3QUQ2NzdCRjgzNkQzMDMyQ0QwMTUxNzc2RENGN0FCOEFEMzE0Ng==","trxnAmount":"9800","trxnCcyCd":"978"}},"MCCONLINEPINCONTACTLES101":{"summary":"MASTERCARD - ONLINE PIN CONTACTLESS","description":"A sample request using a MASTERCARD card for POS authorization.","value":{"trxnType":"PURCHASE","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"071","icc":"NUYyQTAyMDk3ODVGMzQwMTAxODIwMjE5ODE4NDA3QTAwMDAwMDAwNDEwMTA5NTA1MDAwMDA0ODAwRTlBMDMyNTAzMDU5QzAxMDA5RjAyMDYwMDAwMDAwMTAxMDA5RjA5MDIwMDAyOUYxMDEyMDExMEEwMDAwRjA0MDAwMDAwMDAwMDAwMDAwMDAwMDAwMEZGOUYxQTAyMDE5NjlGMjYwODg5ODhDMDM4ODEzRDMzMjY5RjI3MDE4MDlGMzMwMzYwRDAwODlGMzQwMzQyMDMwMDlGMzUwMTI0OUYzNjAyMDAwMjlGMzcwNEQwQzU4RjExOUY0MDA1NjAwMEYwMTAwMQ==","keyId":"0001"},"cardData":{"cardNumber":"882AC7E7CDD20803F4139FD436D10C1B","expDate":"4912","track2":"882AC7E7CDD20803B4A5B0B2D4B8832D59108B8554171D72","ksn":"1044201196FC40001184","onlinePinBlock":"77183106C6E5BF41","mskdPAN":"541333******0505","cardSeqNum":"0001","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"MASTERCARD CREDIT"},"mac":"Q0FCNjhBMjBCRkY1RURCQjE5NUJGOTJDQkEyQjBCNjU4QUY5RTlDODA2NUYzNzFCMUMxQzQ0QzFGQUMyQjc2RA==","trxnAmount":"10100","trxnCcyCd":"978"}},"MCCONLINEPINCHIP102":{"summary":"MASTERCARD - ONLINE PIN CHIP","description":"A sample request using a MASTERCARD card for POS authorization.","value":{"trxnType":"PURCHASE","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"051","icc":"NUYyQTAyMDk3ODgyMDI3OTAwODQwN0EwMDAwMDAwMDQxMDEwOTUwNTAwMDAwNDgwMDA5QTAzMjUwMjA1OUMwMTAwOUYwMjA2MDAwMDAwMDA0MDAwOUYwOTAyMDAwMjlGMTAxMjAxMTBBMDAwMEYwNDAwMDAwMDAwMDAwMDAwMDAwMDAwMDBGRjlGMUEwMjAxOTY5RjI2MDhEQzNGODBCOTA4RENGQUFBOUYyNzAxODA5RjMzMDM2MEQ4Qzg5RjM0MDM0MjAzMDA5RjM1MDEyNDlGMzYwMjAwMDI5RjM3MDRDNkE3RjU3NDlGNDAwNTYwMDBGMDEwMDE=","keyId":"0001"},"cardData":{"cardNumber":"AEC7256BD8EEA32898B9402C869496CA","expDate":"4912","track2":"AEC7256BD8EEA32898D2FD1C48EF06C511640C1D395A7E08","ksn":"1044201196FC4000115A","onlinePinBlock":"E6173A7FF09C9235","mskdPAN":"541333******0508","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"MASTERCARD CREDIT"},"mac":"Q0FCNjhBMjBCRkY1RURCQjE5NUJGOTJDQkEyQjBCNjU4QUY5RTlDODA2NUYzNzFCMUMxQzQ0QzFGQUMyQjc2RA==","trxnAmount":"4000","trxnCcyCd":"978"}},"MCCON101":{"summary":"MASTERCARD - CONTACTLESS","description":"A sample request using a MASTERCARD card for POS authorization.","value":{"trxnType":"PURCHASE","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"071","icc":"NUYyQTAyMDk3ODVGMzQwMTQ5ODIwMjE5ODA4NDA3QTAwMDAwMDAwNDEwMTA5NTA1MDAwMDAwODAwMTlBMDMyNTAxMjk5QzAxMDA5RjAyMDYwMDAwMDAwMTAxMDA5RjA5MDIwMDAyOUYxMDEyMDExMEEwMDAwRjA0MDAwMDAwMDAwMDAwMDAwMDAwMDAwMEZGOUYxQTAyMDE5NjlGMjYwODBBODEzNEMyQTRFQkU5RjM5RjI3MDE4MDlGMzMwMzYwRDgwODlGMzQwMzFGMDMwMjlGMzUwMTI0OUYzNjAyMDAwMjlGMzcwNDU1MDUwMDlEOUY0MDA1NjAwMEYwMTAwMQ==","keyId":"0001"},"cardData":{"cardNumber":"0B20AB6B7C31A560C0AC6CAFB75606DA","expDate":"4912","track2":"0B20AB6B7C31A5602DBBA341B2FBF6F33FA79BD15517F157","ksn":"1044201196FC400010DB","mskdPAN":"541333******0943","cardSeqNum":"0049","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"MASTERCARD CREDIT"},"mac":"QjAyNDE4Q0M3MTM0MkIwQTFDRDk5MDhFRDVFNjcyQzU1NzZDNTk3RkFBNkUyRDcxNUVCREYzNjc2NEQyRjM2RA==","trxnAmount":"10100","trxnCcyCd":"978"}},"MAESTROCON101":{"summary":"MAESTRO - CVM CONTACTLESS","description":"A sample request using a MAESTRO card for POS authorization.","value":{"trxnType":"PURCHASE","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"071","icc":"NUYyQTAyMDk3ODVGMzQwMTAxODIwMjFCODA4NDA3QTAwMDAwMDAwNDMwNjA5NTA1MDAyMDAwODAwMTlBMDMyNTAxMjk5QzAxMDA5RjAyMDYwMDAwMDAwMTAxMDA5RjA5MDIwMDAyOUYxMDEyMDExMEEwMDAwRjA0MDAwMDAwMDAwMDAwMDAwMDAwMDAwMEZGOUYxQTAyMDE5NjlGMjYwODI5ODc3MEVCRDlGMDUyNUQ5RjI3MDE4MDlGMzMwMzYwRDgwODlGMzQwMzAxMDAwMjlGMzUwMTI0OUYzNjAyMDAwMjlGMzcwNDgzRjI5M0MxOUY0MDA1NjAwMEYwMTAwMTlGNkUwNzAwNTYwMDAwMzEzNDAw","keyId":"0001"},"cardData":{"cardNumber":"E011B95B3EC964943B08393C17609ECF","expDate":"3112","track2":"E011B95B3EC96494F8855C396E8EC451433B6F384160487A","ksn":"1044201196FC400010DF","mskdPAN":"679999*********0041","cardSeqNum":"0001","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"MAESTRO"},"mac":"RENBQkEwMzBDMzY5NEU1OUJDRUY5NTI3NTRFRDlEMUI2OEMwMDEzODQyOUY0ODMzQzE1QTA4RkY3MzU2ODA4RA==","trxnAmount":"10100","trxnCcyCd":"978"}},"MAESTROONPINCON1000":{"summary":"MAESTRO - ONLINE PIN CONTACTLESS","description":"A sample request using a MAESTRO card for POS authorization.","value":{"trxnType":"PURCHASE","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"071","icc":"NUYyQTAyMDk3ODVGMzQwMTAxODIwMjE5ODA4NDA3QTAwMDAwMDAwNDMwNjA5NTA1MDAwMDA0ODAwMTlBMDMyNTAxMjk5QzAxMDA5RjAyMDYwMDAwMDAxMDAwMDA5RjA5MDIwMDAyOUYxMDEyMDExMEEwMDAwRjA0MDAwMDAwMDAwMDAwMDAwMDAwMDAwMEZGOUYxQTAyMDE5NjlGMjYwOEM2MDUzNkY5MTc4Nzk3MUU5RjI3MDE4MDlGMzMwMzYwRDgwODlGMzQwMzQyMDMwMDlGMzUwMTI0OUYzNjAyMDAwMjlGMzcwNDFDNzU0OUNGOUY0MDA1NjAwMEYwMTAwMTlGNkUwQjA4NDAwMDAwMzAzMDAwMDEwMjA4ODA=","keyId":"0001"},"cardData":{"cardNumber":"DB1734A22553012BE2F2422BE147AE6A","expDate":"4912","track2":"DB1734A22553012B0748A7E24E2C65BACDDE3DE3E7AA6FDB","ksn":"1044201196FC400010DC","onlinePinBlock":"D3955629F948861D","mskdPAN":"679999*********0017","cardSeqNum":"0001","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"MAESTRO"},"mac":"RTkzNDcyNzBGRDVBQzg0MDIwMzk2RDVBMTk5MkQxODZBMkVEN0RDMjlFQzJEQ0ZGMzIxOUNCNUUwNjJEQ0JBRA==","trxnAmount":"100000","trxnCcyCd":"978"}},"MCMAGSTR":{"summary":"MASTERCARD - MAGSTRIPE","description":"A sample request using a MASTERCARD card for POS authorization.","value":{"trxnType":"PURCHASE","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"901","keyId":"0001"},"cardData":{"cardNumber":"35F8B47192F5170556E1AF506AE56F6A","expDate":"3112","track2":"35F8B47192F5170546041331AFEBB0A2235852439C1B5A8D","ksn":"1044201196FC400010B8","mskdPAN":"541333******0037","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"MASTERCARD CREDIT"},"mac":"N0FDMjE5NkZGODEzQ0E1NTM4QTU5NzU3OTY3QUQ2NzdCRjgzNkQzMDMyQ0QwMTUxNzc2RENGN0FCOEFEMzE0Ng==","trxnAmount":"2000","trxnCcyCd":"978"}},"MCMOTO":{"summary":"MASTERCARD - MOTO","description":"A sample request using a MASTERCARD card for MOTO authorization.","value":{"trxnType":"MOTO","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"901","keyId":"0001"},"cardData":{"cardNumber":"35F8B47192F5170556E1AF506AE56F6A","expDate":"3112","track2":"35F8B47192F5170546041331AFEBB0A2235852439C1B5A8D","ksn":"1044201196FC400010B8","mskdPAN":"541333******0037","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"MASTERCARD CREDIT","cvv":"123"},"mac":"N0FDMjE5NkZGODEzQ0E1NTM4QTU5NzU3OTY3QUQ2NzdCRjgzNkQzMDMyQ0QwMTUxNzc2RENGN0FCOEFEMzE0Ng==","trxnAmount":"2000","trxnCcyCd":"978"}},"MCPREAUTH":{"summary":"MASTERCARD - PREAUTH","description":"A sample request using a MASTERCARD card for POS PREAUTH authorization.","value":{"trxnType":"PREAUTH","trxnDateTime":"0914144012","merchantData":{"mId":"912290573400","tId":"11000906"},"terminalReqData":{"entryMode":"051","icc":"NUYyQTAyMDk3ODVGMzQwMTExODIwMjc5MDA4NDA3QTAwMDAwMDAwNDEwMTA5NTA1MDAwMDAwODAwMDlBMDMyNTAyMDU5QzAxMDA5RjAyMDYwMDAwMDAwMDk4MDA5RjA5MDIwMDAyOUYxMDEyMDExMEE1MDAwRjA0MDAwMDAwMDAwMDAwMDAwMDAwMDAwMEZGOUYxQTAyMDE5NjlGMjYwODE1MTZBNEMxNDBDRkE1M0M5RjI3MDE4MDlGMzMwMzYwRDhDODlGMzQwMzQxMDMwMjlGMzUwMTI0OUYzNjAyMDAwMjlGMzcwNEU4MkVFODU2OUY0MDA1NjAwMEYwMTAwMQ==","keyId":"0001"},"cardData":{"cardNumber":"EBE017EBD3BD186E72876963DBDCDA95","expDate":"4912","track2":"EBE017EBD3BD186EBC5E646953F4C20897AB277D2356E971","ksn":"1044201196FC40001162","mskdPAN":"541333******0653","cardSeqNum":"0011","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":""},"trxnAmount":"500","trxnCcyCd":"978","mac":"WixoHF63K3RXXrPyGBgCN3/ycJAQL2nVCZmsHN9N6As="}},"MCADJUSTMENT":{"summary":"MASTERCARD - ADJUSTMENT","description":"A sample request using a MASTERCARD card for POS ADJUSTMENT.","value":{"trxnType":"ADJUSTMENT","trxnDateTime":"0914144012","merchantData":{"mId":"912290573400","tId":"11000906"},"terminalReqData":{"keyId":"0001"},"parentAuthCd":"010306","parentRrn":"615413963657","mac":"L9DdpaVWPlmdptznajzOUiXsKarwKejFbtwIm5h1tM==","trxnAmount":"12900","trxnCcyCd":"978"}},"MCCOMPLETION":{"summary":"MASTERCARD - COMPLETION","description":"A sample request using a MASTERCARD card for POS COMPLETION.","value":{"trxnType":"COMPLETION","trxnDateTime":"0914144012","merchantData":{"mId":"912290573400","tId":"11000906"},"terminalReqData":{"keyId":"0001"},"trxnAmount":"900","trxnCcyCd":"978","parentAuthCd":"001475","parentRrn":"615413397025","mac":"yLU/gIKb71IE3w71eWjAOVyN9jq1nGWsenvVaHU="}},"MCDEFERRED":{"summary":"MASTERCARD - DEFERRED","description":"A sample request using a MASTERCARD card for POS DEFERRED transaction","value":{"trxnType":"PURCHASE","trxnDateTime":"0914144012","merchantData":{"mId":"912290570951","tId":"11000998"},"terminalReqData":{"entryMode":"051","icc":"NUYyQTAyMDk3ODVGMzQwMTExODIwMjc5MDA4NDA3QTAwMDAwMDAwNDEwMTA5NTA1MDAwMDAwODAwMDlBMDMyNTAyMDU5QzAxMDA5RjAyMDYwMDAwMDAwMDk4MDA5RjA5MDIwMDAyOUYxMDEyMDExMEE1MDAwRjA0MDAwMDAwMDAwMDAwMDAwMDAwMDAwMEZGOUYxQTAyMDE5NjlGMjYwODE1MTZBNEMxNDBDRkE1M0M5RjI3MDE4MDlGMzMwMzYwRDhDODlGMzQwMzQxMDMwMjlGMzUwMTI0OUYzNjAyMDAwMjlGMzcwNEU4MkVFODU2OUY0MDA1NjAwMEYwMTAwMQ==","keyId":"0001"},"cardData":{"cardNumber":"EBE017EBD3BD186E72876963DBDCDA95","expDate":"4912","track2":"EBE017EBD3BD186EBC5E646953F4C20897AB277D2356E971","ksn":"1044201196FC40001162","mskdPAN":"541333******0653","cardSeqNum":"0011","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"MASTERCARD CREDIT"},"mac":"29+DxAaqhXZQvhU+FTFDxisEHUdliteG5G1UTyyg=","trxnAmount":"1700","trxnCcyCd":"978","isDeferred":true}},"VISAONPCON":{"summary":"VISA - ONLINE PIN CONTACTLESS","description":"A sample request using a VISA card for POS authorization.","value":{"trxnType":"PURCHASE","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"071","icc":"NUYyQTAyMDk3ODVGMzQwMTAzODIwMjIwMDA4NDA3QTAwMDAwMDAwMzEwMTA5NTA1MDAwMDAwMDAwMDlBMDMyNTAyMDQ5QzAxMDA5RjAyMDYwMDAwMDAwMDE1MDA5RjA5MDIwMDk2OUYxMDIwMUYyMjAxMDBBMDAwMDAwMDAwNTY0OTUzNDE0QzMzNTQ0NTUzNTQ0MzQxNTM0NTAwMDAwMDAwMDAwMDAwMDAwMDlGMUEwMjAxOTY5RjI2MDgyOEQwMzYwNjhBODZFMDlCOUYyNzAxODA5RjMzMDM2MEQ4Qzg5RjM0MDMzRjAwMDI5RjM1MDEyNDlGMzYwMjAwMDI5RjM3MDRBRkQ1MzI1MjlGNDAwNTYwMDBGMDEwMDE5RjZFMDQyMDcwMDAwMA==","keyId":"0001"},"cardData":{"cardNumber":"01953DF283F036CDCF090186799717ED","expDate":"3112","track2":"01953DF283F036CD26B28526387E1D01F195FF3D59E8B570","ksn":"1044201196FC40001129","onlinePinBlock":"CD691D810F86939F","mskdPAN":"417666******0034","cardSeqNum":"0003","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"VISA CREDIT"},"mac":"QkY2RkQ0RjM3RjQwODI1NERDRTZBN0E3RTE0REZDOUM2OTIzNDVGQTU2QTQ0OUFFQkREREY4MkJBMTE3Q0Y5Qg==","trxnAmount":"1500","trxnCcyCd":"978"}},"VISAONPCH":{"summary":"VISA - ONLINE PIN CHIP","description":"A sample request using a VISA card for POS authorization.","value":{"trxnType":"PURCHASE","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"051","icc":"NUYyQTAyMDk3ODVGMzQwMTAxODIwMjE4MDA4NDA3QTAwMDAwMDAwMzEwMTA5NTA1ODA4MDA0ODAwMDlBMDMyNTAyMDQ5QzAxMDA5RjAyMDYwMDAwMDAwMDEzMDA5RjA5MDIwMDk2OUYxMDE3MDYwMTEyMDNBMDAwMDAwRjAwNTY0OTUzNDE0QzMzNTQ0NTUzNTQ0MzQxNTM0NTlGMUEwMjAxOTY5RjI2MDgxNUE4MEVFMzMzREIzQjNBOUYyNzAxODA5RjMzMDM2MEQ4Qzg5RjM0MDMwMjAzMDA5RjM1MDEyNDlGMzYwMjAwMDI5RjM3MDRGN0VCODc1MzlGNDAwNTYwMDBGMDEwMDE=","keyId":"0001"},"cardData":{"cardNumber":"0DA0D2872A6ADE0F76A1756CB9D5E3E6","expDate":"3112","track2":"0DA0D2872A6ADE0FAB54E8870B887F0B0BF9DE6D3075CF6B","ksn":"1044201196FC4000112B","onlinePinBlock":"5A183A1893115FFA","mskdPAN":"476173******0102","cardSeqNum":"0001","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"VISA DEBIT"},"mac":"NTk1Q0JFQUU1NkZCNDQ2OThGMUE1RDUzMzBGOUQ3RDNDNzgyMDkwQ0VBRTAzMkY2NkZCRkZBODczMTU3MTY0NQ==","trxnAmount":"1300","trxnCcyCd":"978"}},"VISACHNOCVM":{"summary":"VISA - NOCVM CHIP","description":"A sample request using a VISA card for POS authorization.","value":{"trxnType":"PURCHASE","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"051","icc":"NUYyQTAyMDk3ODVGMzQwMTAxODIwMjE4MDA4NDA3QTAwMDAwMDAwMzEwMTA5NTA1ODA4MDAwODAwMDlBMDMyNTAyMDQ5QzAxMDA5RjAyMDYwMDAwMDAwMDExMDA5RjA5MDIwMDk2OUYxMDE3MDYwMTEyMDNBMDAwMDAwRjAwNTY0OTUzNDE0QzMzNTQ0NTUzNTQ0MzQxNTM0NTlGMUEwMjAxOTY5RjI2MDg2Q0VGRkJEQ0VEQUYwRkE5OUYyNzAxODA5RjMzMDM2MEQ4Qzg5RjM0MDMxRjAzMDI5RjM1MDEyNDlGMzYwMjAwMDI5RjM3MDRDMERDMjE1MjlGNDAwNTYwMDBGMDEwMDE=","keyId":"0001"},"cardData":{"cardNumber":"E5208DFFE572B4B7575DE5A81F37F6F8","expDate":"3112","track2":"E5208DFFE572B4B7A28B293656DD225684BE4BFEC5A0D670","ksn":"1044201196FC4000112A","mskdPAN":"476173******0029","cardSeqNum":"0001","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"VISA DEBIT"},"mac":"MjkxQUE1REIwODg3RUJBRTUwMjQ0RjMyOUE5Q0Q3OEIxQjQ4M0QyQ0Y3MDc0Q0ExRDBCMTAzNkRDMjk3QTlEMQ==","trxnAmount":"1100","trxnCcyCd":"978"}},"VISAMSRNOCVM":{"summary":"VISA - MAGSTRIPE","description":"A sample request using a VISA card for POS authorization.","value":{"trxnType":"PURCHASE","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"901","keyId":"0001"},"cardData":{"cardNumber":"1970B640C9466AA3B76B92C03F0C557A","expDate":"3112","track2":"1970B640C9466AA3C37856DB48EAFE56464DB22574D82FFB","ksn":"1044201196FC4000112C","mskdPAN":"476173******0267","cardSeqNum":"0001","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"VISA DEBIT"},"mac":"NTJBNkE4MjNEREI2MkFFMzU4RDk0QjFBQjM4Qzc4MjlGOEU5MUE4MThFRTI5NEUxNjAwNTBGMDlGQ0ExMkRCNA==","trxnAmount":"1400","trxnCcyCd":"978"}},"VISAONPCONDCC":{"summary":"VISA - DCC ONLINE PIN CONTACTLESS","description":"A sample request using a VISA card for POS authorization.","value":{"trxnType":"PURCHASE","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"071","icc":"NUYyQTAyMDk3ODVGMzQwMTAzODIwMjIwMDA4NDA3QTAwMDAwMDAwMzEwMTA5NTA1MDAwMDAwMDAwMDlBMDMyNTAyMDQ5QzAxMDA5RjAyMDYwMDAwMDAwMDE1MDA5RjA5MDIwMDk2OUYxMDIwMUYyMjAxMDBBMDAwMDAwMDAwNTY0OTUzNDE0QzMzNTQ0NTUzNTQ0MzQxNTM0NTAwMDAwMDAwMDAwMDAwMDAwMDlGMUEwMjAxOTY5RjI2MDgyOEQwMzYwNjhBODZFMDlCOUYyNzAxODA5RjMzMDM2MEQ4Qzg5RjM0MDMzRjAwMDI5RjM1MDEyNDlGMzYwMjAwMDI5RjM3MDRBRkQ1MzI1MjlGNDAwNTYwMDBGMDEwMDE5RjZFMDQyMDcwMDAwMA==","keyId":"0001"},"dcc":{"dccStatus":"ACCEPTED","dccData":{"isoAmount":"1590","isoConversionRate":"71010000","conversionRateDate":"2025-02-05","currency":"USD"}},"cardData":{"cardNumber":"01953DF283F036CDCF090186799717ED","expDate":"3112","track2":"01953DF283F036CD26B28526387E1D01F195FF3D59E8B570","ksn":"1044201196FC40001129","onlinePinBlock":"CD691D810F86939F","mskdPAN":"417666******0034","cardSeqNum":"0003","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"VISA CREDIT"},"mac":"QkY2RkQ0RjM3RjQwODI1NERDRTZBN0E3RTE0REZDOUM2OTIzNDVGQTU2QTQ0OUFFQkREREY4MkJBMTE3Q0Y5Qg==","trxnAmount":"1500","trxnCcyCd":"978"}},"VISAMOTO":{"summary":"VISA - MOTO","description":"A sample request using a VISA card for POS MOTO authorization.","value":{"trxnType":"MOTO","trxnDateTime":"0914144012","merchantData":{"mId":"912290570951","tId":"11000998"},"terminalReqData":{"entryMode":"071","keyId":"0001"},"cardData":{"cardNumber":"01953DF283F036CDCF090186799717ED","expDate":"3112","track2":"01953DF283F036CD26B28526387E1D01F195FF3D59E8B570","ksn":"1044201196FC40001129","onlinePinBlock":"CD691D810F86939F","mskdPAN":"417666******0034","cardSeqNum":"0003","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"VISA CREDIT","cvv":"123"},"mac":"Ko289Q5XYkJkiNgl7ChTRPDfjI2NI+0qINf0D1OTpz8=","trxnAmount":"1500","trxnCcyCd":"978"}},"VISAPREAUTH":{"summary":"VISA - PREAUTH","description":"A sample request using a VISA card for POS PREAUTH authorization.","value":{"trxnType":"PREAUTH","trxnDateTime":"0914144012","merchantData":{"mId":"912290573400","tId":"11000906"},"terminalReqData":{"entryMode":"071","icc":"NUYyQTAyMDk3ODVGMzQwMTAzODIwMjIwMDA4NDA3QTAwMDAwMDAwMzEwMTA5NTA1MDAwMDAwMDAwMDlBMDMyNTAyMDQ5QzAxMDA5RjAyMDYwMDAwMDAwMDE1MDA5RjA5MDIwMDk2OUYxMDIwMUYyMjAxMDBBMDAwMDAwMDAwNTY0OTUzNDE0QzMzNTQ0NTUzNTQ0MzQxNTM0NTAwMDAwMDAwMDAwMDAwMDAwMDlGMUEwMjAxOTY5RjI2MDgyOEQwMzYwNjhBODZFMDlCOUYyNzAxODA5RjMzMDM2MEQ4Qzg5RjM0MDMzRjAwMDI5RjM1MDEyNDlGMzYwMjAwMDI5RjM3MDRBRkQ1MzI1MjlGNDAwNTYwMDBGMDEwMDE5RjZFMDQyMDcwMDAwMA==","keyId":"0001"},"cardData":{"cardNumber":"01953DF283F036CDCF090186799717ED","expDate":"3112","track2":"01953DF283F036CD26B28526387E1D01F195FF3D59E8B570","ksn":"1044201196FC40001129","onlinePinBlock":"CD691D810F86939F","mskdPAN":"417666******0034","cardSeqNum":"0003","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"VISA CREDIT"},"mac":"WixoHF63K3RXXrPyGBgCN3/ycJAQL2nVCZmsHN9N6As=","trxnAmount":"5000","trxnCcyCd":"978"}},"VISAADJUSTMENT":{"summary":"VISA - ADJUSTMENT","description":"A sample request using a VISA card for POS ADJUSTMENT.","value":{"trxnType":"ADJUSTMENT","trxnDateTime":"0914144012","merchantData":{"mId":"912290573400","tId":"11000906"},"terminalReqData":{"keyId":"0001"},"parentAuthCd":"010306","parentRrn":"615413963657","mac":"L9DdpaVWPlmdptznajzOUiXsKarwKejFbtwIm5h1tM==","trxnAmount":"9000","trxnCcyCd":"978"}},"VISACOMPLETION":{"summary":"VISA - COMPLETION","description":"A sample request using a VISA card for POS COMPLETION.","value":{"trxnType":"COMPLETION","trxnDateTime":"0914144012","merchantData":{"mId":"912290573400","tId":"11000906"},"terminalReqData":{"keyId":"0001"},"trxnAmount":"8900","trxnCcyCd":"978","parentAuthCd":"001475","parentRrn":"615413397025","mac":"yLU/gIKb71IE3w71eWjAOVyN9jq1nGWsenvVaHU="}},"VISADEFERRED":{"summary":"VISA - DEFERRED","description":"A sample request using a VISA card for DEFERRED POS transaction.","value":{"trxnType":"PURCHASE","trxnDateTime":"0914144012","merchantData":{"mId":"912290570951","tId":"11000998"},"terminalReqData":{"entryMode":"071","icc":"NUYyQTAyMDk3ODVGMzQwMTAzODIwMjIwMDA4NDA3QTAwMDAwMDAwMzEwMTA5NTA1MDAwMDAwMDAwMDlBMDMyNTAyMDQ5QzAxMDA5RjAyMDYwMDAwMDAwMDE1MDA5RjA5MDIwMDk2OUYxMDIwMUYyMjAxMDBBMDAwMDAwMDAwNTY0OTUzNDE0QzMzNTQ0NTUzNTQ0MzQxNTM0NTAwMDAwMDAwMDAwMDAwMDAwMDlGMUEwMjAxOTY5RjI2MDgyOEQwMzYwNjhBODZFMDlCOUYyNzAxODA5RjMzMDM2MEQ4Qzg5RjM0MDMzRjAwMDI5RjM1MDEyNDlGMzYwMjAwMDI5RjM3MDRBRkQ1MzI1MjlGNDAwNTYwMDBGMDEwMDE5RjZFMDQyMDcwMDAwMA==","keyId":"0001"},"cardData":{"cardNumber":"01953DF283F036CDCF090186799717ED","expDate":"3112","track2":"01953DF283F036CD26B28526387E1D01F195FF3D59E8B570","ksn":"1044201196FC40001129","onlinePinBlock":"CD691D810F86939F","mskdPAN":"417666******0034","cardSeqNum":"0003","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"VISA CREDIT"},"isDeferred":true,"mac":"DmCqhViIS0eHALsYqMBuTZzVhLocW2hVm6swSqzA=","trxnAmount":"1700","trxnCcyCd":"978"}},"DANKORTCHIP":{"summary":"DANKORT - CHIP","description":"A sample request using a DANKORT card for POS authorization.","value":{"mac":"MjkxQUE1REIwODg3RUJBRTUwMjQ0RjMyOUE5Q0Q3OEIxQjQ4M0=","cardData":{"ksn":"0000000000000000078A","track2":"CB5FA18E4010AD34C4D252D6313AB74CE2F7F148A2C2A03D","expDate":"2901","mskdPAN":"457199******5238","cardBrnd":"DANKORT","cardCcyCd":"208","cardCtryCd":"208","cardNumber":"CB5FA18E4010AD340D06C6498CD8356E","cardSeqNum":"0000"},"trxnType":"PURCHASE","trxnCcyCd":"208","trxnAmount":"3000","merchantData":{"mId":"000000090000365","tId":"11000983"},"trxnDateTime":"0914144012","terminalReqData":{"icc":"nxoCAgiaAyYCJp8CBgAAAAAwAJ8DBgAAAAAAAJ8JAgMAhAegAAABIUcSnzcERoXrJ58zA+D4yF8qAgIInzUBIoICOQBfNAEAnAEAlQUAAACAAJ80A0QDAp8mCKbD2NPpEOC+nycBgJ82AgALnxAXFgQEB6BgMEAAKQAAAAAAAAAAAAIAAAA=","keyId":"0001","entryMode":"951"},"cashbackTrxnCcyCd":"208","surchargeTrxnAmount":"0"}},"DANKORTPIN":{"summary":"DANKORT - ONLINE PIN CONTACTLES","description":"A sample request using a DANKORT card for POS authorization.","value":{"mac":"MjkxQUE1REIwODg3RUJBRTUwMjQ0RjMyOUE5Q0Q3OEIxQjQ4M0=","cardData":{"ksn":"00000000000000000772","track2":"1C976AB587343B7569E29FFFB95F0BCBA7A8130656DA44BA","expDate":"2812","mskdPAN":"501980******9659","cardBrnd":"DANKORT","cardCcyCd":"208","cardCtryCd":"208","cardNumber":"1C976AB587343B752AAC56BEA2E19B24","cardSeqNum":"0000","onlinePinBlock":"E3FE2B12629E4689"},"trxnType":"PURCHASE","trxnCcyCd":"208","trxnAmount":"2000","merchantData":{"mId":"000000090000365","tId":"11000983"},"trxnDateTime":"0914144012","terminalReqData":{"icc":"nxoCAgiaAyYCJZ8CBgAAAAAgAJ8DBgAAAAAAAJ8mCEQdznYkWa/UggIZgF80AQCfNgIAEZ8JAgACnycBgJ80Ax8DAoQHoAAAASFHE58QHAERoEIDogQAAAAAAAAAAAAA/wAAAAAAAAD/AAGfMwPgCAifNQEilQUAAACAAV8qAgIInAEAnzcE1dV/kJ9uBwIIAAAwMAA=","keyId":"0001","entryMode":"971"},"cashbackTrxnCcyCd":"208","surchargeTrxnAmount":"0"}},"DANKORTCONTACTLES":{"summary":"DANKORT - CONTACTLES","description":"A sample request using a DANKORT card for POS authorization.","value":{"mac":"MjkxQUE1REIwODg3RUJBRTUwMjQ0RjMyOUE5Q0Q3OEIxQjQ4M0=","cardData":{"ksn":"00000000000000000773","track2":"EB283BB30C2D5E7726377A949278C5DCD2D0AB83DBD248CF","expDate":"2807","mskdPAN":"457199******5230","cardBrnd":"DANKORT","cardCcyCd":"208","cardCtryCd":"208","cardNumber":"EB283BB30C2D5E77313F000CE9D5136C","cardSeqNum":"0000"},"trxnType":"PURCHASE","trxnCcyCd":"208","trxnAmount":"2000","merchantData":{"mId":"000000090000365","tId":"11000983"},"trxnDateTime":"0914144012","terminalReqData":{"icc":"nxoCCCaaAyYCJZ8CBgAAAAAgAJ8DBgAAAAAAAJ9uBCBwAACfZgQ2oEAAhAegAAABIUcRnycBgJUFAAAAAACfJgg7+0wxx/oJbpwBAJ80Az8AAJ8zA+C4yJ81ASKfCQIAjF8qAggmggIAIJ82AgARnxAXBgMSA6AAAA8DAAAIAAAAAAAAAOLoflpfNAEAnzcEMJYQjw==","keyId":"0001","entryMode":"971"},"cashbackTrxnCcyCd":"208","surchargeTrxnAmount":"0"}},"AMEXCONTACTLES":{"summary":"AMEX - CONTACTLES","description":"A sample request using a AMEX card for POS authorization.","value":{"trxnType":"PURCHASE","trxnDateTime":"0914144012","merchantData":{"mId":"000000090000365","tId":"11000983"},"terminalReqData":{"entryMode":"051","icc":"nxoCAgiaAyYDAp8CBgAAAAAwAJ8DBgAAAAAAAJ8JAgABhAigAAAAJQEEA583BOWbG8CfMwPg+MhfKgICCJ81ASKCAjwAXzQBAJwBAJUFAAAAgACfNANEAwKfJgi/baPLB4Orep8nAYCfNgIAAp8QBwYCAQOgAAA=","keyId":"0001"},"cardData":{"cardNumber":"E8DBD9BC801E5A79EC80D93ABEB55B83","expDate":"3012","track2":"58A170D748F8D7159E39332704317BEF4CD58CF90B1A1A66","ksn":"000000000000000007AC","mskdPAN":"***********1007","cardSeqNum":"0000","cardCtryCd":"208","cardCcyCd":"208","cardBrnd":""},"mac":"MjkxQUE1REIwODg3RUJBRTUwMjQ0RjMyOUE5Q0Q3OEIxQjQ4M0=","trxnAmount":"3000","trxnCcyCd":"208","cashbackTrxnCcyCd":"208","surchargeTrxnAmount":"0"}},"AMEXCHIP":{"summary":"AMEX - CHIP","description":"A sample request using a AMEX card for POS authorization.","value":{"mac":"MjkxQUE1REIwODg3RUJBRTUwMjQ0RjMyOUE5Q0Q3OEIxQjQ4M0=","cardData":{"ksn":"000000000000000007E9","track2":"FFB49DB96507AC9084203A1B0DC0BADFA64C0C286B671427","expDate":"3012","mskdPAN":"***********1009","cardBrnd":"","cardCcyCd":"208","cardCtryCd":"208","cardNumber":"2DC3BCB1F8D805E0A90DF2CED04DF573","cardSeqNum":"0002"},"trxnType":"PURCHASE","trxnCcyCd":"208","trxnAmount":"3300","merchantData":{"mId":"000000090000365","tId":"11000983"},"trxnDateTime":"0914144012","terminalReqData":{"icc":"nxoCAgiaAyYDAp8CBgAAAAAzAJ8DBgAAAAAAAJ8JAgABhAigAAAAJQEEA583BOK84hWfMwPg+MhfKgICCJ81ASKCAjwAXzQBApwBAJUFAAAAgACfNANBAwKfJghTtBeIoewdop8nAYCfNgIAAp8QBwYCAQOgAAA=","keyId":"0001","entryMode":"051"},"cashbackTrxnCcyCd":"208","surchargeTrxnAmount":"0"}}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosAuthResponse"}}},"merchantData":{"mId":"62941828","tId":"11000998"},"mskdPAN":"222360******0011","trxnAmount":"1000","trxnCcyCd":"978","respCd":"00","respMsg":"Approve","icc":"MDEwMDBGOUYzNjAyMDAwMjkxMDhBMUE1N0JERTAwODYwMDAw","trxnId":"120415164401005769960123433915967345","authCd":"013489","stan":"300531","rrn":"503111509114","trxnDateTime":"0131113609","mac":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA==","addData":"R220504011"},"400":{"description":"Bad Request ā Payment declined or invalid input","content":{"application/json":{"example":{"merchantData":{"mId":"62941828","tId":"11000998"},"mskdPAN":"222360******0011","trxnAmount":"1000","trxnCcyCd":"978","respCd":"06","respMsg":"Error","trxnId":"","authCd":"","stan":"","rrn":"","trxnDateTime":"0131113609","mac":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA=="}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/posapi/reversal/":{"post":{"tags":["POS payment"],"summary":"Reversal of a POS payment","description":"# Reversal of a POS Payment\n\nThis endpoint handles the reversal process of a payment \n\n## š Reference Documentation\n\nš” **trxnDateTime** field:\nThis field must contain local terminal time of the current reversal transaction. \nFormat is \"mmddHHMMSS\". Example: \"0611153720\" meaning the 11 of June 03 PM 37 minutes and 20 seconds for local timezone of the terminal. \n\n---","operationId":"run_pos_reversal_posapi_reversal__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosAuthReversalRequest"},"examples":{"VISAAUTHREVERSAL":{"summary":"VISA - REVERSAL","description":"A sample request using a VISA card for POS reversal.","value":{"trxnType":"REVERSAL","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"071","keyId":"0001"},"cardData":{"cardNumber":"01953DF283F036CDCF090186799717ED","expDate":"3112","track2":"01953DF283F036CD26B28526387E1D01F195FF3D59E8B570","ksn":"1044201196FC40001129","mskdPAN":"417666******0034","cardSeqNum":"0003","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"VISA CREDIT"},"mac":"QkY2RkQ0RjM3RjQwODI1NERDRTZBN0E3RTE0REZDOUM2OTIzNDVGQTU2QTQ0OUFFQkREREY4MkJBMTE3Q0Y5Qg==","trxnId":"020716584401009771580034503817102156","trxnAmount":"1500","trxnCcyCd":"978"}},"VISATECHREVERSAL":{"summary":"VISA - technical REVERSAL","description":"The Reversal of the latest transaction by transaction reference","value":{"trxnType":"REVERSAL","trxnDateTime":"0914144012","merchantData":{"mId":"912290573400","tId":"11000906"},"terminalReqData":{"entryMode":"051","keyId":"0001"},"mac":"VycdVo+hKAh3beTuP7LRd3NIBrUXFjNGwpyPWo=","trxnCcyCd":"978","transaction_reference":"8b7e4b5d-4d17-42d4-9b9e-2f9c4c0d8f7a"}},"VISARRNREVERSAL":{"summary":"VISA - REVERSAL by parentRrn and parentAuthCd","description":"The Reversal by parentRrn and parentAuthCd","value":{"trxnType":"REVERSAL","trxnDateTime":"0914144012","merchantData":{"mId":"912290573400","tId":"11000906"},"terminalReqData":{"entryMode":"051","keyId":"0001"},"mac":"VycdVo+hKAh3beTuP7LRd3NIBrUXFjNGwpyPWo=","parentAuthCd":"010306","parentRrn":"615413963657","trxnCcyCd":"978","trxnAmount":"1500"}},"MCAUTHREVERSAL":{"summary":"MASTERCARD - REVERSAL","description":"A sample request using a VISA card for POS reversal.","value":{"trxnType":"REVERSAL","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"010","keyId":"0001"},"cardData":{"cardNumber":"CCE4448091ED369005FABA373F3DAA57","expDate":"4912","track2":"CCE4448091ED3690E0991922982224B14E3BEC5B1CED57F4","ksn":"1044201196FC4000101B","mskdPAN":"541333******0067","cardSeqNum":"0001","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"MASTERCARD CREDIT"},"mac":"RkRCQjQ1Rjk0MUQ1RDM1OTc2NjBFQjU3OUQxQjFBNEJGMDVCN0UxM0IzMEZFRDFFNjMwOUIwMjhENDM5Qjg0Ng==","trxnId":"021014034501001732340067504114236631","trxnAmount":"10100","trxnCcyCd":"978"}},"MCTECHREVERSAL":{"summary":"MASTERCARD - technical REVERSAL","description":"The Reversal of the latest transaction by transaction_reference","value":{"trxnType":"REVERSAL","trxnDateTime":"0914144012","merchantData":{"mId":"912290573400","tId":"11000906"},"terminalReqData":{"entryMode":"051","keyId":"0001"},"mac":"VycdVo+hKAh3beTuP7LRd3NIBrUXFjNGwpyPWo=","trxnCcyCd":"978","transaction_reference":"8b7e4b5d-4d17-42d4-9b9e-2f9c4c0d8f7a"}},"MCRRNREVERSAL":{"summary":"MASTERCARD - REVERSAL by parentRrn and parentAuthCd","description":"The Reversal by parentRrn and parentAuthCd","value":{"trxnType":"REVERSAL","trxnDateTime":"0914144012","merchantData":{"mId":"912290573400","tId":"11000906"},"terminalReqData":{"entryMode":"051","keyId":"0001"},"mac":"BVliebfh3beTuEiobWflGIao=","parentAuthCd":"LH4Q5J","parentRrn":"615321963657","trxnCcyCd":"978","trxnAmount":"12500"}}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosAuthReversalResponse"}}},"merchantData":{"mId":"62941828","tId":"11000998"},"mskdPAN":"222360******0011","trxnAmount":"1000","trxnCcyCd":"978","respCd":"00","respMsg":"Approve","trxnId":"120415164401005769960123433915967345","authCd":"013489","stan":"300531","rrn":"503111509114","trxnDateTime":"0131113609","mac":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA=="},"400":{"description":"Bad Request ā Payment declined or invalid input","content":{"application/json":{"example":{"merchantData":{"mId":"62941828","tId":"11000998"},"mskdPAN":"222360******0011","trxnAmount":"1000","trxnCcyCd":"978","respCd":"06","respMsg":"Error","trxnId":"","authCd":"","stan":"","rrn":"","trxnDateTime":"0131113609","mac":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA=="}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/posapi/reversal-refund/":{"post":{"tags":["POS payment"],"summary":"Reversal of a POS refund","description":"# Reversal of a POS Payment\n\nThis endpoint handles the reversal process of a payment \n\n## š Reference Documentation\n\nš” **trxnDateTime** field:\nThis field must contain local terminal time of the current reversal transaction. \nFormat is \"mmddHHMMSS\". Example: \"0611153720\" meaning the 11 of June 03 PM 37 minutes and 20 seconds for local timezone of the terminal. \n\n---","operationId":"run_pos_reversal_refund_posapi_reversal_refund__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosAuthReversalRequest"},"examples":{"VISAAUTHREVERSAL":{"summary":"VISA - REVERSAL","description":"A sample request using a VISA card for POS reversal.","value":{"trxnType":"REVERSAL","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"071","keyId":"0001"},"cardData":{"cardNumber":"01953DF283F036CDCF090186799717ED","expDate":"3112","track2":"01953DF283F036CD26B28526387E1D01F195FF3D59E8B570","ksn":"1044201196FC40001129","mskdPAN":"417666******0034","cardSeqNum":"0003","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"VISA CREDIT"},"mac":"QkY2RkQ0RjM3RjQwODI1NERDRTZBN0E3RTE0REZDOUM2OTIzNDVGQTU2QTQ0OUFFQkREREY4MkJBMTE3Q0Y5Qg==","trxnId":"020716584401009771580034503817102156","trxnAmount":"1500","trxnCcyCd":"978"}},"VISATECHREVERSAL":{"summary":"VISA - technical REVERSAL","description":"The Reversal of the latest transaction by transaction reference","value":{"trxnType":"REVERSAL","trxnDateTime":"0914144012","merchantData":{"mId":"912290573400","tId":"11000906"},"terminalReqData":{"entryMode":"051","keyId":"0001"},"mac":"VycdVo+hKAh3beTuP7LRd3NIBrUXFjNGwpyPWo=","trxnCcyCd":"978","transaction_reference":"8b7e4b5d-4d17-42d4-9b9e-2f9c4c0d8f7a"}},"VISARRNREVERSAL":{"summary":"VISA - REVERSAL by parentRrn and parentAuthCd","description":"The Reversal by parentRrn and parentAuthCd","value":{"trxnType":"REVERSAL","trxnDateTime":"0914144012","merchantData":{"mId":"912290573400","tId":"11000906"},"terminalReqData":{"entryMode":"051","keyId":"0001"},"mac":"VycdVo+hKAh3beTuP7LRd3NIBrUXFjNGwpyPWo=","parentAuthCd":"010306","parentRrn":"615413963657","trxnCcyCd":"978","trxnAmount":"1500"}},"MCAUTHREVERSAL":{"summary":"MASTERCARD - REVERSAL","description":"A sample request using a VISA card for POS reversal.","value":{"trxnType":"REVERSAL","trxnDateTime":"0914144012","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"010","keyId":"0001"},"cardData":{"cardNumber":"CCE4448091ED369005FABA373F3DAA57","expDate":"4912","track2":"CCE4448091ED3690E0991922982224B14E3BEC5B1CED57F4","ksn":"1044201196FC4000101B","mskdPAN":"541333******0067","cardSeqNum":"0001","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"MASTERCARD CREDIT"},"mac":"RkRCQjQ1Rjk0MUQ1RDM1OTc2NjBFQjU3OUQxQjFBNEJGMDVCN0UxM0IzMEZFRDFFNjMwOUIwMjhENDM5Qjg0Ng==","trxnId":"021014034501001732340067504114236631","trxnAmount":"10100","trxnCcyCd":"978"}},"MCTECHREVERSAL":{"summary":"MASTERCARD - technical REVERSAL","description":"The Reversal of the latest transaction by transaction_reference","value":{"trxnType":"REVERSAL","trxnDateTime":"0914144012","merchantData":{"mId":"912290573400","tId":"11000906"},"terminalReqData":{"entryMode":"051","keyId":"0001"},"mac":"VycdVo+hKAh3beTuP7LRd3NIBrUXFjNGwpyPWo=","trxnCcyCd":"978","transaction_reference":"8b7e4b5d-4d17-42d4-9b9e-2f9c4c0d8f7a"}},"MCRRNREVERSAL":{"summary":"MASTERCARD - REVERSAL by parentRrn and parentAuthCd","description":"The Reversal by parentRrn and parentAuthCd","value":{"trxnType":"REVERSAL","trxnDateTime":"0914144012","merchantData":{"mId":"912290573400","tId":"11000906"},"terminalReqData":{"entryMode":"051","keyId":"0001"},"mac":"BVliebfh3beTuEiobWflGIao=","parentAuthCd":"LH4Q5J","parentRrn":"615321963657","trxnCcyCd":"978","trxnAmount":"12500"}}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosAuthReversalResponse"}}},"merchantData":{"mId":"62941828","tId":"11000998"},"mskdPAN":"222360******0011","trxnAmount":"1000","trxnCcyCd":"978","respCd":"00","respMsg":"Approve","trxnId":"120415164401005769960123433915967345","authCd":"013489","stan":"300531","rrn":"503111509114","trxnDateTime":"0131113609","mac":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA=="},"400":{"description":"Bad Request ā Payment declined or invalid input","content":{"application/json":{"example":{"merchantData":{"mId":"62941828","tId":"11000998"},"mskdPAN":"222360******0011","trxnAmount":"1000","trxnCcyCd":"978","respCd":"06","respMsg":"Error","trxnId":"","authCd":"","stan":"","rrn":"","trxnDateTime":"0131113609","mac":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA=="}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/posapi/partial_reversal/":{"post":{"tags":["POS payment"],"summary":"Partial reversal of a POS payment","description":"# Partial reversal of a POS Payment\n\nThis endpoint handles the partial reversal process of a payment \n\n## š Reference Documentation\n\nš” **trxnDateTime** field:\nThis field must contain local terminal time of the current reversal transaction. \nFormat is \"mmddHHMMSS\". Example: \"0611153720\" meaning the 11 of June 03 PM 37 minutes and 20 seconds for local timezone of the terminal.\n\nš” **trxnAmount** field:\nThis field must contain amount in minor units of the current reversal transaction.\n\nš” **trxnId** field:\nThis field must contain unique identifier from the original AUTH transaction that should be reversed. \n---","operationId":"run_pos_partial_reversal_posapi_partial_reversal__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosAuthPartialReversalRequest"},"examples":{"PARTIAL_REVERSAL":{"summary":"PARTIAL REVERSAL","description":"A sample request using the trxnId of AUTH and an amount for POS reversal.","value":{"trxnType":"REVERSAL","trxnDateTime":"0131113609","merchantData":{"mId":"62552880","tId":"11000998"},"mac":"QkY2RkQ0RjM3RjQwODI1NERDRTZBN0E3RTE0REZDOUM2OTIzNDVGQTU2QTQ0OUFFQkREREY4MkJBMTE3Q0Y5Qg==","trxnId":"020716584401009771580034503817102156","trxnAmount":"1500","trxnCcyCd":"978"}}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosAuthPartialReversalResponse"}}},"merchantData":{"mId":"62941828","tId":"11000998"},"trxnAmount":"1000","trxnCcyCd":"978","respCd":"00","respMsg":"Approve","trxnId":"120415164401005769960123433915967345","authCd":"013489","stan":"300531","rrn":"503111509114","trxnDateTime":"0131113609","mac":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA=="},"400":{"description":"Bad Request ā Payment declined or invalid input","content":{"application/json":{"example":{"merchantData":{"mId":"62941828","tId":"11000998"},"trxnAmount":"1000","trxnCcyCd":"978","respCd":"06","respMsg":"Error","trxnId":"","authCd":"","stan":"","rrn":"","trxnDateTime":"0131113609","mac":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA=="}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/posapi/refund/":{"post":{"tags":["POS payment"],"summary":"Refund of a POS payment","description":"This endpoint handles the refund process of a payment","operationId":"run_pos_refund_posapi_refund__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosAuthRefundRequest"},"examples":{"VISAAUTHREFUND":{"summary":"VISA - REFUND","description":"A sample request using a VISA card for POS refund","value":{"trxnType":"REFUND","trxnDateTime":"0131113609","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"071","keyId":"0001"},"cardData":{"cardNumber":"01953DF283F036CDCF090186799717ED","expDate":"3112","track2":"01953DF283F036CD26B28526387E1D01F195FF3D59E8B570","ksn":"1044201196FC40001129","mskdPAN":"417666******0034","cardSeqNum":"0003","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"VISA CREDIT"},"mac":"QkY2RkQ0RjM3RjQwODI1NERDRTZBN0E3RTE0REZDOUM2OTIzNDVGQTU2QTQ0OUFFQkREREY4MkJBMTE3Q0Y5Qg==","trxnId":"020716584401009771580034503817102156","trxnAmount":"1500","trxnCcyCd":"978"}},"VISAAUTHREFUNDBYRRN":{"summary":"VISA - REFUND by parentRrn and parentAuthCd","description":"A sample request using a VISA card for POS refund using rrn and authCd","value":{"trxnType":"REFUND","trxnDateTime":"0616113609","merchantData":{"mId":"912290573400","tId":"11000906"},"mac":"QkY2RkQ0RjM3RjQwODI1NERDRTZBN0E3RTE0REZDOUM2OTIzNDVGQTU2QTQ0OUFFQkREREY4MkJBMTE3Q0Y5Qg==","parentRrn":"010306","parentAuthCd":"615413963657","trxnAmount":"1500","trxnCcyCd":"978"}},"MCAUTHREFUND":{"summary":"MASTERCARD - REFUND","description":"A sample request using a MASTERCARD card for POS refund","value":{"trxnType":"REFUND","trxnDateTime":"0210140345","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"010","keyId":"0001"},"cardData":{"cardNumber":"CCE4448091ED369005FABA373F3DAA57","expDate":"4912","track2":"CCE4448091ED3690E0991922982224B14E3BEC5B1CED57F4","ksn":"1044201196FC4000101B","mskdPAN":"541333******0067","cardSeqNum":"0001","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"MASTERCARD CREDIT"},"mac":"RkRCQjQ1Rjk0MUQ1RDM1OTc2NjBFQjU3OUQxQjFBNEJGMDVCN0UxM0IzMEZFRDFFNjMwOUIwMjhENDM5Qjg0Ng==","trxnId":"021014034501001732340067504114236631","trxnAmount":"10100","trxnCcyCd":"978"}},"MCAUTHREFUNDBYRRN":{"summary":"MASTERCARD - REFUND by rrn and authCd","description":"A sample request using a MASTERCARD card for POS refund using rrn and authCd","value":{"trxnType":"REFUND","trxnDateTime":"0616140345","merchantData":{"mId":"62552880","tId":"11000998"},"mac":"RkRCQjQ1Rjk0MUQ1RDM1OTc2NjBFQjU3OUQxQjFBNEJGMDVCN0UxM0IzMEZFRDFFNjMwOUIwMjhENDM5Qjg0Ng==","parentAuthCd":"LH4Q5J","parentRrn":"615321963657","trxnAmount":"10100","trxnCcyCd":"978"}}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosAuthReversalResponse"}}},"merchantData":{"mId":"62941828","tId":"11000998"},"mskdPAN":"222360******0011","trxnAmount":"1000","trxnCcyCd":"978","respCd":"00","respMsg":"Approve","trxnId":"120415164401005769960123433915967345","authCd":"013489","stan":"300531","rrn":"503111509114","trxnDateTime":"0131113609","mac":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA=="},"400":{"description":"Bad Request ā Payment declined or invalid input","content":{"application/json":{"example":{"merchantData":{"mId":"62941828","tId":"11000998"},"mskdPAN":"222360******0011","trxnAmount":"1000","trxnCcyCd":"978","respCd":"06","respMsg":"Error","trxnId":"","authCd":"","stan":"","rrn":"","trxnDateTime":"0131113609","mac":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA=="}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/posapi/payout/":{"post":{"tags":["POS payment"],"summary":"Payout of a POS payment","description":"# Payout of a POS Payment\nThis endpoint is responsible for processing the OCT of POS, utilizing card scheme specifications for proper data formatting and validation.","operationId":"run_pos_oct_posapi_payout__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosOCTRequest"},"examples":{"MCCHIPCVM98":{"summary":"MASTERCARD - CVM CHIP","description":"A sample request using a MASTERCARD card for POS PAYOUT.","value":{"trxnType":"PAYMENT","trxnDateTime":"0205115522","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"051","icc":"NUYyQTAyMDk3ODVGMzQwMTExODIwMjc5MDA4NDA3QTAwMDAwMDAwNDEwMTA5NTA1MDAwMDAwODAwMDlBMDMyNTAyMDU5QzAxMDA5RjAyMDYwMDAwMDAwMDk4MDA5RjA5MDIwMDAyOUYxMDEyMDExMEE1MDAwRjA0MDAwMDAwMDAwMDAwMDAwMDAwMDAwMEZGOUYxQTAyMDE5NjlGMjYwODE1MTZBNEMxNDBDRkE1M0M5RjI3MDE4MDlGMzMwMzYwRDhDODlGMzQwMzQxMDMwMjlGMzUwMTI0OUYzNjAyMDAwMjlGMzcwNEU4MkVFODU2OUY0MDA1NjAwMEYwMTAwMQ==","keyId":"0001"},"cardData":{"cardNumber":"EBE017EBD3BD186E72876963DBDCDA95","expDate":"4912","track2":"EBE017EBD3BD186EBC5E646953F4C20897AB277D2356E971","ksn":"1044201196FC40001162","mskdPAN":"541333******0653","cardSeqNum":"0011","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"MASTERCARD CREDIT"},"mac":"N0FDMjE5NkZGODEzQ0E1NTM4QTU5NzU3OTY3QUQ2NzdCRjgzNkQzMDMyQ0QwMTUxNzc2RENGN0FCOEFEMzE0Ng==","trxnAmount":"9800","trxnCcyCd":"978"}},"MCCON101":{"summary":"MASTERCARD - CONTACTLESS","description":"A sample request using a MASTERCARD card for POS PAYOUT.","value":{"trxnType":"PAYMENT","trxnDateTime":"0129144049","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"071","icc":"NUYyQTAyMDk3ODVGMzQwMTQ5ODIwMjE5ODA4NDA3QTAwMDAwMDAwNDEwMTA5NTA1MDAwMDAwODAwMTlBMDMyNTAxMjk5QzAxMDA5RjAyMDYwMDAwMDAwMTAxMDA5RjA5MDIwMDAyOUYxMDEyMDExMEEwMDAwRjA0MDAwMDAwMDAwMDAwMDAwMDAwMDAwMEZGOUYxQTAyMDE5NjlGMjYwODBBODEzNEMyQTRFQkU5RjM5RjI3MDE4MDlGMzMwMzYwRDgwODlGMzQwMzFGMDMwMjlGMzUwMTI0OUYzNjAyMDAwMjlGMzcwNDU1MDUwMDlEOUY0MDA1NjAwMEYwMTAwMQ==","keyId":"0001"},"cardData":{"cardNumber":"0B20AB6B7C31A560C0AC6CAFB75606DA","expDate":"4912","track2":"0B20AB6B7C31A5602DBBA341B2FBF6F33FA79BD15517F157","ksn":"1044201196FC400010DB","mskdPAN":"541333******0943","cardSeqNum":"0049","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"MASTERCARD CREDIT"},"mac":"QjAyNDE4Q0M3MTM0MkIwQTFDRDk5MDhFRDVFNjcyQzU1NzZDNTk3RkFBNkUyRDcxNUVCREYzNjc2NEQyRjM2RA==","trxnAmount":"10100","trxnCcyCd":"978"}},"MAESTROCON101":{"summary":"MAESTRO - CVM CONTACTLESS","description":"A sample request using a MAESTRO card for POS PAYOUT.","value":{"trxnType":"PAYMENT","trxnDateTime":"0129144607","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"071","icc":"NUYyQTAyMDk3ODVGMzQwMTAxODIwMjFCODA4NDA3QTAwMDAwMDAwNDMwNjA5NTA1MDAyMDAwODAwMTlBMDMyNTAxMjk5QzAxMDA5RjAyMDYwMDAwMDAwMTAxMDA5RjA5MDIwMDAyOUYxMDEyMDExMEEwMDAwRjA0MDAwMDAwMDAwMDAwMDAwMDAwMDAwMEZGOUYxQTAyMDE5NjlGMjYwODI5ODc3MEVCRDlGMDUyNUQ5RjI3MDE4MDlGMzMwMzYwRDgwODlGMzQwMzAxMDAwMjlGMzUwMTI0OUYzNjAyMDAwMjlGMzcwNDgzRjI5M0MxOUY0MDA1NjAwMEYwMTAwMTlGNkUwNzAwNTYwMDAwMzEzNDAw","keyId":"0001"},"cardData":{"cardNumber":"E011B95B3EC964943B08393C17609ECF","expDate":"3112","track2":"E011B95B3EC96494F8855C396E8EC451433B6F384160487A","ksn":"1044201196FC400010DF","mskdPAN":"679999*********0041","cardSeqNum":"0001","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"MAESTRO"},"mac":"RENBQkEwMzBDMzY5NEU1OUJDRUY5NTI3NTRFRDlEMUI2OEMwMDEzODQyOUY0ODMzQzE1QTA4RkY3MzU2ODA4RA==","trxnAmount":"10100","trxnCcyCd":"978"}},"MCMAGSTR":{"summary":"MASTERCARD - MAGSTRIPE","description":"A sample request using a MASTERCARD card for POS PAYOUT.","value":{"trxnType":"PAYMENT","trxnDateTime":"0129134159","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"901","keyId":"0001"},"cardData":{"cardNumber":"35F8B47192F5170556E1AF506AE56F6A","expDate":"3112","track2":"35F8B47192F5170546041331AFEBB0A2235852439C1B5A8D","ksn":"1044201196FC400010B8","mskdPAN":"541333******0037","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"MASTERCARD CREDIT"},"mac":"N0FDMjE5NkZGODEzQ0E1NTM4QTU5NzU3OTY3QUQ2NzdCRjgzNkQzMDMyQ0QwMTUxNzc2RENGN0FCOEFEMzE0Ng==","trxnAmount":"2000","trxnCcyCd":"978"}},"VISACHNOCVM":{"summary":"VISA - NOCVM CHIP","description":"A sample request using a VISA card for POS PAYOUT.","value":{"trxnType":"PAYMENT","trxnDateTime":"0204150233","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"051","icc":"NUYyQTAyMDk3ODVGMzQwMTAxODIwMjE4MDA4NDA3QTAwMDAwMDAwMzEwMTA5NTA1ODA4MDAwODAwMDlBMDMyNTAyMDQ5QzAxMDA5RjAyMDYwMDAwMDAwMDExMDA5RjA5MDIwMDk2OUYxMDE3MDYwMTEyMDNBMDAwMDAwRjAwNTY0OTUzNDE0QzMzNTQ0NTUzNTQ0MzQxNTM0NTlGMUEwMjAxOTY5RjI2MDg2Q0VGRkJEQ0VEQUYwRkE5OUYyNzAxODA5RjMzMDM2MEQ4Qzg5RjM0MDMxRjAzMDI5RjM1MDEyNDlGMzYwMjAwMDI5RjM3MDRDMERDMjE1MjlGNDAwNTYwMDBGMDEwMDE=","keyId":"0001"},"cardData":{"cardNumber":"E5208DFFE572B4B7575DE5A81F37F6F8","expDate":"3112","track2":"E5208DFFE572B4B7A28B293656DD225684BE4BFEC5A0D670","ksn":"1044201196FC4000112A","mskdPAN":"476173******0029","cardSeqNum":"0001","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"VISA DEBIT"},"mac":"MjkxQUE1REIwODg3RUJBRTUwMjQ0RjMyOUE5Q0Q3OEIxQjQ4M0QyQ0Y3MDc0Q0ExRDBCMTAzNkRDMjk3QTlEMQ==","trxnAmount":"1100","trxnCcyCd":"978"}},"VISAMSRNOCVM":{"summary":"VISA - MAGSTRIPE","description":"A sample request using a VISA card for POS PAYOUT.","value":{"trxnType":"PAYMENT","trxnDateTime":"0204150858","merchantData":{"mId":"62552880","tId":"11000998"},"terminalReqData":{"entryMode":"901","keyId":"0001"},"cardData":{"cardNumber":"1970B640C9466AA3B76B92C03F0C557A","expDate":"3112","track2":"1970B640C9466AA3C37856DB48EAFE56464DB22574D82FFB","ksn":"1044201196FC4000112C","mskdPAN":"476173******0267","cardSeqNum":"0001","cardCtryCd":"196","cardCcyCd":"978","cardBrnd":"VISA DEBIT"},"mac":"NTJBNkE4MjNEREI2MkFFMzU4RDk0QjFBQjM4Qzc4MjlGOEU5MUE4MThFRTI5NEUxNjAwNTBGMDlGQ0ExMkRCNA==","trxnAmount":"1400","trxnCcyCd":"978"}}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosOCTResponse"}}},"merchantData":{"mId":"62941828","tId":"11000998"},"mskdPAN":"222360******0011","trxnAmount":"1000","trxnCcyCd":"978","respCd":"00","respMsg":"Approve","icc":"MDEwMDBGOUYzNjAyMDAwMjkxMDhBMUE1N0JERTAwODYwMDAw","trxnId":"120415164401005769960123433915967345","authCd":"013489","stan":"300531","rrn":"503111509114","trxnDateTime":"0131113609","mac":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA==","addData":"R220504011"},"400":{"description":"Bad Request ā Payment declined or invalid input","content":{"application/json":{"example":{"merchantData":{"mId":"62941828","tId":"11000998"},"mskdPAN":"222360******0011","trxnAmount":"1000","trxnCcyCd":"978","respCd":"06","respMsg":"Error","trxnId":"","authCd":"","stan":"","rrn":"","trxnDateTime":"0131113609","mac":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA=="}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/tokenization/card":{"post":{"tags":["Tokenization"],"summary":"Save card","description":"# tokenization","operationId":"save_card_tokenization_card_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveCardRequest"},"examples":{"Clean card":{"summary":"Plain PAN card save request","description":"Example of saving a card using a plain PAN without KSN encryption. Use this scenario for direct card tokenization requests from trusted integrations.","value":{"card_number":"4111101011111003","exp_year":"2035","exp_month":"12","cardholder_name":"YORGO RIA","mid":"9876654342099","tid":"10002363","transaction_reference":"tok-save-plain-20260318-0001"}},"Encrypted card":{"summary":"Encrypted PAN card save request","description":"Example of saving a card using an encrypted PAN together with KSN. This scenario is intended for encrypted device-originated card data.","value":{"card_number":"5d0e5b97b513780c4abf1d05937b288e","exp_year":"2030","exp_month":"12","cardholder_name":"YORGO RIA","ksn":"1044201196027ec0000a","mid":"9876654342099","tid":"110002363","transaction_reference":"tok-save-encrypted-20260318-0002"}}}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveCardResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/tokenization/sale":{"post":{"tags":["Tokenization"],"summary":"Token payin","description":"# Perform SALE using a tokenized card","operationId":"token_payin_tokenization_sale_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenPayInRequest"},"examples":{"Visa card":{"summary":"Test tokenization payin","description":"Clean card request","value":{"amount":"10.01","currency":"EUR","token_id":"agg86094-1338-43a0-1ct4-bt913c156030"}}}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenPayInResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/tokenization/payout":{"post":{"tags":["Tokenization"],"summary":"Token payout","description":"# Perform payout using a tokenized card","operationId":"token_payout_tokenization_payout_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenPayoutRequest"},"examples":{"Visa card":{"summary":"Test tokenization payout","description":"Clean card request","value":{"amount":"10.01","currency":"EUR","token_id":"996236693436463385"}}}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenPayoutResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/tokenization/token":{"post":{"tags":["Tokenization"],"summary":"GET token","operationId":"get_token_tokenization_token_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTokenRequest"},"examples":{"by_authcd_rrn":{"summary":"Find by authCd and rrn","value":{"authCd":"013489","rrn":"503111509114"}},"by_processor_transaction_reference":{"summary":"Find by processor transaction reference","value":{"processor_transaction_reference":"013111360901003093570034609618686879"}}}}},"required":true},"responses":{"200":{"description":"Token found successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTokenResponse"},"example":{"status":"Success","status_code":200,"token":{"id":2,"tito_token":"990073647339802745","uuid_token":"0e2c3993-a543-4afe-aa52-be3f0124321f","card_id":535211,"transaction_id":987654,"is_used":false,"masked_pan":"411110******1003","expired":"3512"}}}}},"400":{"description":"Invalid request","content":{"application/json":{"example":{"detail":"Provide either processor_transaction_reference or both authCd and rrn"}}}},"404":{"description":"Transaction or token not found","content":{"application/json":{"example":{"detail":"Token not found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/webhooks/":{"post":{"tags":["Webhooks","Webhooks"],"summary":"Create webhook","description":"Create a new webhook configuration for a given event type.","operationId":"webhook_create_webhooks__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateRequest"},"examples":{"sale_webhook_example":{"summary":"Sale webhook","description":"Webhook that will be called when a sale transaction event is created.","value":{"merchant_identity":"62552880","terminal_identity":"11000998","url":"https://merchant.example.com/webhooks/kykeon","event_type":"sale","secret_key":"c4c99b8c8a8d4b1bb5f5189bd6e23da0","is_active":true,"max_retries":3,"timeout_ms":3000,"extra_headers":{"X-Merchant-Id":"62552880"}}},"refund_webhook_example":{"summary":"Refund webhook","description":"Webhook that will be called when a refund event is created.","value":{"merchant_identity":"62552880","url":"https://merchant.example.com/webhooks/refunds","event_type":"refund","secret_key":"a9f12b7c28d74d17aa59cbb8f129f000","is_active":true,"max_retries":5,"timeout_ms":5000,"extra_headers":{"X-Environment":"production","X-Webhook-Source":"kykeon-payment-api"}}}}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookOperationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/webhooks/{webhook_id}":{"get":{"tags":["Webhooks","Webhooks"],"summary":"Get webhook","description":"Get webhook configuration by its ID.","operationId":"webhook_get_webhooks__webhook_id__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Webhook Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookOperationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Webhooks","Webhooks"],"summary":"Update webhook","description":"Update existing webhook configuration (full/partial update).","operationId":"webhooks_update_patch","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Webhook Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUpdateRequest"},"examples":{"deactivate_webhook_example":{"summary":"Deactivate webhook","value":{"is_active":false}},"increase_retries_example":{"summary":"Increase max retries and timeout","value":{"max_retries":5,"timeout_ms":7000}},"change_event_type_example":{"summary":"Change event type and endpoint","value":{"event_type":"settled","url":"https://merchant.example.com/webhooks/settlements"}}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookOperationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Webhooks","Webhooks"],"summary":"Delete webhook","description":"Delete webhook configuration by its ID.","operationId":"webhook_delete_webhooks__webhook_id__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Webhook Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookOperationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/webhooks/{webhook_id}/test":{"post":{"tags":["Webhooks","Webhooks"],"summary":"Test webhook","description":"Send a test event to the endpoint configured for the given webhook subscription.","operationId":"webhook_test_webhooks__webhook_id__test_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Webhook Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookTestResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/webhooks/deliveries/{delivery_id}/resend":{"post":{"tags":["Webhooks","Webhooks"],"summary":"Resend webhook delivery","description":"Re-queue an existing webhook delivery so it is sent again. The delivery is reset to pending (lock and retry cleared) and re-published to RabbitMQ; if RabbitMQ is unavailable the background poller will pick it up. Returns immediately, before delivery is attempted.","operationId":"webhook_delivery_resend_webhooks_deliveries__delivery_id__resend_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"delivery_id","in":"path","required":true,"schema":{"type":"integer","title":"Delivery Id"}}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDeliveryOperationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/taprelay/sale":{"post":{"tags":["TapRelay"],"summary":"TapRelay Sale","description":"Start a SALE transaction on a connected TapRelay device.","operationId":"sale_taprelay_sale_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelaySaleRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleResponse"}}}},"401":{"description":"Unauthorized (missing or invalid X-API-Key)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"06","respMsg":"Invalid or missing API key","message":"Please provide valid API key"}}}},"403":{"description":"Forbidden (API key valid but not allowed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"57","respMsg":"Operation not permitted","message":"API key does not have permission for this operation"}}}},"404":{"description":"Requested TapRelay device not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"25","respMsg":"Device not found","message":"Requested terminal is not connected"}}}},"409":{"description":"Conflict (no TapRelay devices connected)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"91","respMsg":"No TapRelay devices connected","message":"No active terminals available"}}}},"422":{"description":"Validation error (invalid request payload)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"30","respMsg":"Format error","message":"Invalid request parameters"}}}},"502":{"description":"TapRelay or terminal backend unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"96","respMsg":"System malfunction","message":"TapRelay service unavailable"}}}}},"security":[{"APIKeyHeader":[]}]}},"/taprelay/preauth":{"post":{"tags":["TapRelay"],"summary":"TapRelay Pre-auth","description":"Start a PRE-AUTH transaction (sale with subtype \"preauth\") on a connected TapRelay device.","operationId":"preauth_taprelay_preauth_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayPreauthRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreauthResponse"}}}},"401":{"description":"Unauthorized (missing or invalid X-API-Key)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"06","respMsg":"Invalid or missing API key","message":"Please provide valid API key"}}}},"403":{"description":"Forbidden (API key valid but not allowed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"57","respMsg":"Operation not permitted","message":"API key does not have permission for this operation"}}}},"404":{"description":"Requested TapRelay device not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"25","respMsg":"Device not found","message":"Requested terminal is not connected"}}}},"409":{"description":"Conflict (no TapRelay devices connected)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"91","respMsg":"No TapRelay devices connected","message":"No active terminals available"}}}},"422":{"description":"Validation error (invalid request payload)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"30","respMsg":"Format error","message":"Invalid request parameters"}}}},"502":{"description":"TapRelay or terminal backend unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"96","respMsg":"System malfunction","message":"TapRelay service unavailable"}}}}},"security":[{"APIKeyHeader":[]}]}},"/taprelay/adjustment":{"post":{"tags":["TapRelay"],"summary":"TapRelay Pre-auth Adjustment","description":"Adjust an existing pre-authorization (sale with subtype \"adjustment\") on a connected TapRelay device.","operationId":"adjustment_taprelay_adjustment_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayAdjustmentRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdjustmentResponse"}}}},"401":{"description":"Unauthorized (missing or invalid X-API-Key)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"06","respMsg":"Invalid or missing API key","message":"Please provide valid API key"}}}},"403":{"description":"Forbidden (API key valid but not allowed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"57","respMsg":"Operation not permitted","message":"API key does not have permission for this operation"}}}},"404":{"description":"Requested TapRelay device not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"25","respMsg":"Device not found","message":"Requested terminal is not connected"}}}},"409":{"description":"Conflict (no TapRelay devices connected)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"91","respMsg":"No TapRelay devices connected","message":"No active terminals available"}}}},"422":{"description":"Validation error (invalid request payload)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"30","respMsg":"Format error","message":"Invalid request parameters"}}}},"502":{"description":"TapRelay or terminal backend unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"96","respMsg":"System malfunction","message":"TapRelay service unavailable"}}}}},"security":[{"APIKeyHeader":[]}]}},"/taprelay/completion":{"post":{"tags":["TapRelay"],"summary":"TapRelay Pre-auth Completion","description":"Complete an existing pre-authorization (sale with subtype \"completion\") on a connected TapRelay device.","operationId":"completion_taprelay_completion_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayCompletionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompletionResponse"}}}},"401":{"description":"Unauthorized (missing or invalid X-API-Key)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"06","respMsg":"Invalid or missing API key","message":"Please provide valid API key"}}}},"403":{"description":"Forbidden (API key valid but not allowed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"57","respMsg":"Operation not permitted","message":"API key does not have permission for this operation"}}}},"404":{"description":"Requested TapRelay device not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"25","respMsg":"Device not found","message":"Requested terminal is not connected"}}}},"409":{"description":"Conflict (no TapRelay devices connected)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"91","respMsg":"No TapRelay devices connected","message":"No active terminals available"}}}},"422":{"description":"Validation error (invalid request payload)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"30","respMsg":"Format error","message":"Invalid request parameters"}}}},"502":{"description":"TapRelay or terminal backend unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"96","respMsg":"System malfunction","message":"TapRelay service unavailable"}}}}},"security":[{"APIKeyHeader":[]}]}},"/taprelay/reversal":{"post":{"tags":["TapRelay"],"summary":"TapRelay Reversal","description":"Start a REVERSAL transaction on a connected TapRelay device.","operationId":"reversal_taprelay_reversal_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayReversalRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayReversalResponse"}}}},"401":{"description":"Unauthorized (missing or invalid X-API-Key)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"06","respMsg":"Invalid or missing API key","message":"Please provide valid API key"}}}},"403":{"description":"Forbidden (API key valid but not allowed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"57","respMsg":"Operation not permitted","message":"API key does not have permission for this operation"}}}},"404":{"description":"Requested TapRelay device not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"25","respMsg":"Device not found","message":"Requested terminal is not connected"}}}},"409":{"description":"Conflict (no TapRelay devices connected)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"91","respMsg":"No TapRelay devices connected","message":"No active terminals available"}}}},"422":{"description":"Validation error (invalid request payload)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"30","respMsg":"Format error","message":"Invalid request parameters"}}}},"502":{"description":"TapRelay or terminal backend unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayHTTPError"},"example":{"respCd":"96","respMsg":"System malfunction","message":"TapRelay service unavailable"}}}}},"security":[{"APIKeyHeader":[]}]}},"/taprelay/refund":{"post":{"tags":["TapRelay"],"summary":"TapRelay Refund","description":"Start a REFUND transaction on a connected TapRelay device.","operationId":"refund_taprelay_refund_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayRefundRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayRefundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/taprelay/cancel":{"post":{"tags":["TapRelay"],"summary":"TapRelay Cancel","description":"Cancel the currently running transaction on a connected TapRelay device.","operationId":"cancel_taprelay_cancel_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayCancelRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/taprelay/screen":{"post":{"tags":["TapRelay"],"summary":"TapRelay Screen","description":"Get the current screen/status from a connected TapRelay device.","operationId":"taprelay_screen_status_taprelay_screen_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayCurrentScreenStatusRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/taprelay/last":{"post":{"tags":["TapRelay"],"summary":"TapRelay Transaction Status","description":"Get last transaction status from a connected TapRelay device.","operationId":"taprelay_last_transaction_taprelay_last_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayLastTransactionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayLastTransactionStatusResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/taprelay/reconciliation":{"post":{"tags":["TapRelay"],"summary":"TapRelay Reconciliation","description":"Start terminal reconciliation on a connected TapRelay device.","operationId":"taprelay_reconciliation_taprelay_reconciliation_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TapRelayReconciliationRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReconciliationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/helper/heartbeat/":{"get":{"tags":["Helper"],"summary":"Heartbeat service check","description":"# Internal System Status Check\n\nThis endpoint provides a real-time status check of various internal system components. \nClients can use this GET request to determine if specific services are operational.\n\n## š Response Details\n\nThe response will be a JSON object where each key represents a system component, \nand its value (`True` or `False`) indicates whether the component is currently functioning.\n\n## š Example Response\n\n```json\n{\n \"nodeA\": true,\n \"nodeB\": true,\n \"nodeC\": true,\n \"apiPOS\": true,\n \"apiECOM\": true,\n \"apiFraud\": true,\n \"apiPortal\": true\n}","operationId":"helper_heartbeat_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemStatusResponse"}}}}}},"post":{"tags":["Helper"],"summary":"Heartbeat service check","description":"# Internal System Status Check\n\nThis endpoint provides a real-time status check of various internal system components. \nClients can use this GET request to determine if specific services are operational.\n\n## š Response Details\n\nThe response will be a JSON object where each key represents a system component, \nand its value (`True` or `False`) indicates whether the component is currently functioning.\n\n## š Example Response\n\n```json\n{\n \"nodeA\": true,\n \"nodeB\": true,\n \"nodeC\": true,\n \"apiPOS\": true,\n \"apiECOM\": true,\n \"apiFraud\": true,\n \"apiPortal\": true\n}","operationId":"helper_heartbeat_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemStatusResponse"}}}}}}},"/report/trxnreport/":{"post":{"tags":["Reports"],"summary":"Transaction report","description":"# Transaction Report\n\nThis endpoint allows clients to retrieve **transaction reports** with a paginated response. \nIt provides transaction details based on **merchant, terminal, and date filters**.\n\n## š Request Details\n\n- The request **must include**:\n - `merchant_id`: ID of the merchant.\n - `terminal_id`: ID of the terminal.\n - `date_from`: Start date for the report.\n - `date_to`: End date for the report.\n - `page` (optional, default=`1`): Page number to retrieve.\n\n- The API **returns a maximum of 100 transactions per request**.\n- To fetch additional records, increase the `page` parameter (`page=2`, `page=3`, etc.).\n\n---\n\n## š Example Request\n\n```http\nPOST /trxnreport/?page=1\nContent-Type: application/json\n\n{\n \"merchant_id\": 2,\n \"terminal_id\": 7,\n \"date_from\": \"2024-10-23\",\n \"date_to\": \"2025-03-07\"\n}","operationId":"get_trxn_report_report_trxnreport__post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Page"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionReportRequest"},"examples":{"trxnreportex01":{"summary":"TRANSACTION REPORT","description":"A sample request for TRANSACTION REPORT with pagination support.","value":{"merchant_id":2,"terminal_id":7,"date_from":"2024-10-23","date_to":"2025-03-07","page":1}}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedTransactionReportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/bin-lookup/":{"post":{"tags":["BIN Lookup"],"summary":"Bin Lookup","operationId":"bin_lookup_bin_lookup__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BinLookupRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BinLookupResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/ecomapi/hpp/session":{"post":{"tags":["Hosted Payment Page"],"summary":"Create a Hosted Payment Page session","description":"Creates a Hosted Payment Page session and returns the `payment_url` the cardholder must be sent to\n(full-page redirect; the page refuses to be embedded in an iframe).\n\n\n![\"Hosted](\"/static/hpp_flow.svg\")
\n\nOpen the flow diagram full size Ā· Download SVG\n\nFlow as text
\n\n```\nMerchant backend Kykeon (HPP + core) Cardholder browser LINK4DSecure / Issuer\n 1. POST /ecomapi/hpp/session āāāāāāāāŗ create session (Redis + PostgreSQL)\n 2. āāāā 201 session_id, payment_url\n 3. redirect cardholder āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāŗ 4. GET /hpp/{token} (payment page)\n āāāāāāāāāāāāāāāāāāāāā 5. POST /hpp/api/pay/init (card, browser data)\n 6. 3DS /preauth āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāŗ threeDSServerTransID\n 7. optional 3DS Method iframe (ā¤ 5 s)\n āāāāāāāāāāāāāāāāāāāāā 8. POST /hpp/api/pay/authorize\n 9. 3DS /auth āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāŗ ARes: Y/A frictionless | C challenge\n challenge only: 10. creq ā acsURL (iframe, OTP / app approval)\n āāāāāāāāāāāāāāāāāāāāā 11. ACS posts cres ā /hpp/3ds/notify/{sid}\n āāāāāāāāāāāāāāāāāāāāā 12. POST /hpp/api/pay/complete ā 3DS /postauth\n 13. authorization (same core as /ecomapi/preauth) āāāŗ host: approved / declined\n āāāāāāāāāāāāāāāāāāāāāŗ 14. result screen ā redirect success / failure / cancel URL\n15. āāāā cardholder lands on the redirect URL (session_id, transaction_reference, status appended)\n16. GET /ecomapi/hpp/sessions/{session_id} āāāāŗ status + transaction + card_token (always verify server-side)\n```\n\n