{"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- **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
šŸ“Ø Email: support@link4.tech
šŸ”— Website: LINK4TECH
\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"}},"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_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"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"}},"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"}},"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 "}}}},"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 "}}}},"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"}}},"required":true},"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":"MASTERCARD 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"}}}},"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"}}}},"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":"0419084647","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":"0419084647","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":"0419084647","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":"0419084647","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":"0419084647","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":"0419084647","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":"0419084647","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"}},"VISAONPCON":{"summary":"VISA - ONLINE PIN CONTACTLESS","description":"A sample request using a VISA card for POS authorization.","value":{"trxnType":"PURCHASE","trxnDateTime":"0419084647","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":"0419084647","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":"0419084647","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":"0419084647","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":"0419084647","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"}},"DANKORTCHIP":{"summary":"DANKORT - CHIP","description":"A sample request using a DANKORT card for POS authorization.","value":{"mac":"ZQ8vicfat86fApG9NUs5Vd9C+lYJQXbCuZYyZpy6Pl0=","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":"0419084647","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":"1gyNd4Ut5CC9wEI7YESMszxw69IN+SKeWw+U0l40nWY=","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":"0419084647","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":"HXU91VAOldwXbXJftY567X2nIszHRi+phRkyosbmP8Y=","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":"0419084647","terminalReqData":{"icc":"nxoCCCaaAyYCJZ8CBgAAAAAgAJ8DBgAAAAAAAJ9uBCBwAACfZgQ2oEAAhAegAAABIUcRnycBgJUFAAAAAACfJgg7+0wxx/oJbpwBAJ80Az8AAJ8zA+C4yJ81ASKfCQIAjF8qAggmggIAIJ82AgARnxAXBgMSA6AAAA8DAAAIAAAAAAAAAOLoflpfNAEAnzcEMJYQjw==","keyId":"0001","entryMode":"971"},"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":"0419084647","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"}},"MCAUTHREVERSAL":{"summary":"MASTERCARD - REVERSAL","description":"A sample request using a VISA card for POS reversal.","value":{"trxnType":"REVERSAL","trxnDateTime":"0419084647","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"}}}}}},"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":"0419084647","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"}},"MCAUTHREVERSAL":{"summary":"MASTERCARD - REVERSAL","description":"A sample request using a VISA card for POS reversal.","value":{"trxnType":"REVERSAL","trxnDateTime":"0419084647","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"}}}}}},"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"}},"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"}}}}}},"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":[]}]}},"/webhook/webhooks/":{"post":{"tags":["Webhooks","Webhooks"],"summary":"Create webhook","description":"Create a new webhook configuration for a given event type.","operationId":"webhook_create_webhook_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":[]}]}},"/webhook/webhooks/{webhook_id}":{"get":{"tags":["Webhooks","Webhooks"],"summary":"Get webhook","description":"Get webhook configuration by its ID.","operationId":"webhook_get_webhook_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"}}}}}},"put":{"tags":["Webhooks","Webhooks"],"summary":"Update webhook","description":"Update existing webhook configuration (full update).","operationId":"webhooks_update_put","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"}}}}}},"patch":{"tags":["Webhooks","Webhooks"],"summary":"Update webhook","description":"Update existing webhook configuration (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_webhook_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"}}}}}}},"/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/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"}}}}}}}},"components":{"schemas":{"AFT":{"properties":{"sender":{"anyOf":[{"$ref":"#/components/schemas/SenderInfo"},{"type":"null"}],"description":"Sender information for Visa"},"recipient":{"$ref":"#/components/schemas/RecipientInfo","description":"Recipient information"},"transaction_purpose":{"anyOf":[{"$ref":"#/components/schemas/TransactionPurpose"},{"type":"null"}],"description":"Transaction purpose for Mastercard Funding Transaction","example":"High_Risk_Securities"}},"type":"object","required":["recipient"],"title":"AFT"},"AccountNumberType":{"type":"string","enum":["Other","RTN_and_BankAccount","IBAN","Card_Account","Email","Phone_Number","Bank_Account_Number_and_BIC","Wallet_ID","SocialNetwork_ID"],"title":"AccountNumberType"},"CancelInnerResponse":{"properties":{"success":{"type":"boolean","title":"Success"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["success"],"title":"CancelInnerResponse"},"CancelResponse":{"properties":{"selected_serial":{"type":"string","title":"Selected Serial"},"selected_ip":{"type":"string","title":"Selected Ip"},"response":{"$ref":"#/components/schemas/CancelInnerResponse"}},"type":"object","required":["selected_serial","selected_ip","response"],"title":"CancelResponse","description":"Cancel transaction response"},"CaptureRequest":{"properties":{"transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Reference","description":"Merchant internal transaction reference","example":"agg86094-1338-43a0-1ct4-bt913c156030"},"transaction_id":{"type":"string","title":"Transaction Id","description":"The transaction ID from the pre-authorized payment response.","example":"120415164401005769960123433915967345"},"amount":{"type":"string","title":"Amount","description":"Amount to be captured (as a string).","example":"12.00"}},"type":"object","required":["transaction_id","amount"],"title":"CaptureRequest"},"CaptureResponse":{"properties":{"transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Reference","description":"Merchant internal transaction reference","example":"agg86094-1338-43a0-1ct4-bt913c156030"},"status":{"type":"string","title":"Status","description":"The status of the capture request.","example":"Capture success"},"message":{"type":"string","title":"Message","description":"A message describing the result of the capture.","example":"Capture successful"},"transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Id","description":"A unique identifier for the transaction.","example":"2a6c9719-c680-4239-b6a7-f9d6ad2e1f1d"},"captured_amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Captured Amount","description":"The amount that was captured (as a string).","example":"12.00"},"status_code":{"type":"integer","title":"Status Code","description":"HTTP status code representing the result of the request.","example":200},"processed_at":{"type":"string","format":"date-time","title":"Processed At","description":"Timestamp when the request was processed.","example":"2024-11-18T17:47:21"},"bank_status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Status Code","description":"The status code returned by the bank or payment processor.","example":"12345"},"bank_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Status","description":"The status message returned by the bank or payment processor.","example":"Transaction approved"},"capture_id":{"type":"string","title":"Capture Id","description":"The original capture identificator.","example":"e8e80135-f478-4fb7-b70c-3380a2782dd5"}},"type":"object","required":["status","message","status_code","processed_at","capture_id"],"title":"CaptureResponse","example":{"bank_status":"Approved","bank_status_code":"00","capture_id":"e8e80135-f478-4fb7-b70c-3380a2782dd5","captured_amount":"12.00","message":"Capture successful","processed_at":"2024-11-18T17:47:21","status":"success","status_code":200,"transaction_id":"2a6c9719-c680-4239-b6a7-f9d6ad2e1f1d","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"CardBrandResponse":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the card brand.","example":"VISA"}},"type":"object","required":["name"],"title":"CardBrandResponse"},"CardResponse":{"properties":{"masked_pan":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Masked Pan","description":"Masked card PAN.","example":"411111******1111"},"expired":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expired","description":"Expiration date of the card (MMYY).","example":"1225"},"card_brand":{"anyOf":[{"$ref":"#/components/schemas/CardBrandResponse"},{"type":"null"}],"description":"Details of the card brand."}},"type":"object","title":"CardResponse"},"Dcc":{"properties":{"dccStatus":{"type":"string","title":"Dccstatus","description":"DCC status","example":"ACCEPTED"},"dccData":{"$ref":"#/components/schemas/DccData"}},"type":"object","required":["dccStatus","dccData"],"title":"Dcc"},"DccData":{"properties":{"isoAmount":{"type":"string","title":"Isoamount","description":"ISO amount in minor units","example":"1850"},"isoConversionRate":{"type":"string","title":"Isoconversionrate","description":"ISO conversion rate","example":"71010000"},"conversionRateDate":{"type":"string","format":"date","title":"Conversionratedate","description":"Date of conversion rate","example":"2023-04-18"},"currency":{"type":"string","title":"Currency","description":"Currency code.","example":"USD"}},"type":"object","required":["isoAmount","isoConversionRate","conversionRateDate","currency"],"title":"DccData"},"DeviceFingerprint":{"properties":{"timezone":{"anyOf":[{"type":"string","maxLength":4,"pattern":"^(-?\\d{2,3}|0)$"},{"type":"null"}],"title":"Timezone","example":"330"},"browserColorDepth":{"anyOf":[{"type":"string","maxLength":2,"pattern":"^\\d+$"},{"type":"null"}],"title":"Browsercolordepth","example":"24"},"browserLanguage":{"anyOf":[{"type":"string","maxLength":5,"pattern":"^[a-zA-Z]+(-[a-zA-Z]+)?$"},{"type":"null"}],"title":"Browserlanguage","example":"en-GB"},"browserScreenHeight":{"anyOf":[{"type":"string","maxLength":4,"pattern":"^\\d+$"},{"type":"null"}],"title":"Browserscreenheight","example":"1080"},"browserScreenWidth":{"anyOf":[{"type":"string","maxLength":4,"pattern":"^\\d+$"},{"type":"null"}],"title":"Browserscreenwidth","example":"1920"},"os":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"title":"Os","example":"Windows"},"browserAcceptHeader":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Browseracceptheader","example":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*"},"userAgent":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Useragent","example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Safari/537.36"},"browserJavascriptEnabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Browserjavascriptenabled","example":false},"browserJavaEnabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Browserjavaenabled","example":true},"acceptContent":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Acceptcontent","example":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3"},"browserIP":{"anyOf":[{"type":"string","maxLength":39,"pattern":"(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))|(^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$)"},{"type":"null"}],"title":"Browserip","example":"192.1.1.1"}},"type":"object","title":"DeviceFingerprint"},"DispatchInfo":{"properties":{"started_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Started At"},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ended At"},"duration":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Duration"}},"type":"object","title":"DispatchInfo"},"ExternalInitTransaction":{"properties":{"transaction_id":{"type":"string","title":"Transaction Id","description":"Visa's transaction_id or Mastercard's Network_Data","example":"MCCSXTJ9O"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date","description":"Mastercard's Date_settlement","example":"0122"},"tlid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tlid","description":"Mastercard's TLID","example":"7WFe1LqMR1WT3FqPlA_6rQ"}},"type":"object","required":["transaction_id"],"title":"ExternalInitTransaction"},"GetTokenRequest":{"properties":{"authCd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authcd","example":"013489"},"rrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rrn","example":"503111509114"},"processor_transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Processor Transaction Reference","example":"013111360901003093570034609618686879"}},"type":"object","title":"GetTokenRequest"},"GetTokenResponse":{"properties":{"status":{"type":"string","title":"Status","example":"Success"},"status_code":{"type":"integer","title":"Status Code","example":200},"token":{"$ref":"#/components/schemas/TokenListItemResponse"}},"type":"object","required":["status","status_code","token"],"title":"GetTokenResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"MerchantData-Output":{"properties":{"mId":{"type":"string","title":"Mid","description":"Merchant ID.","example":"62941828"},"tId":{"type":"string","title":"Tid","description":"Terminal ID.","example":"11000998"}},"type":"object","required":["mId","tId"],"title":"MerchantData"},"OnlineResponse":{"properties":{"debits_value":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Debits Value"},"num_debits":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Debits"},"credits_value":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Value"},"num_credits":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Credits"},"total_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Amount"},"response_text":{"anyOf":[{"$ref":"#/components/schemas/OnlineResponseText"},{"type":"null"}]}},"type":"object","title":"OnlineResponse"},"OnlineResponseText":{"properties":{"display":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display"},"receipt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt"}},"type":"object","title":"OnlineResponseText"},"PaginatedTransactionReportResponse":{"properties":{"total_rows":{"type":"integer","title":"Total Rows"},"total_pages":{"type":"integer","title":"Total Pages"},"current_page":{"type":"integer","title":"Current Page"},"transactions":{"items":{"$ref":"#/components/schemas/TransactionReportResponse"},"type":"array","title":"Transactions"}},"type":"object","required":["total_rows","total_pages","current_page","transactions"],"title":"PaginatedTransactionReportResponse"},"PayoutRequest":{"properties":{"transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Reference","description":"Merchant internal transaction reference","example":"agg86094-1338-43a0-1ct4-bt913c156030"},"card_number":{"type":"string","title":"Card Number","description":"Credit card number for pre-authorization.","example":"4005529999000123"},"expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expiry Date","description":"Expiration date of the card in MM/YY format.","example":"12/31"},"amount":{"type":"string","title":"Amount","description":"Amount to be pre-authorized (as a string).","example":"12.00"},"currency":{"type":"string","title":"Currency","description":"Currency of the transaction.","example":"EUR"},"cardholder_name":{"type":"string","title":"Cardholder Name","description":"Cardholder's name.","example":"John Doe"},"dynamic_descriptor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dynamic Descriptor","description":"Text that will be placed on cardholderā€™s bank statement","example":"Sample Text"},"deviceFingerprint":{"anyOf":[{"$ref":"#/components/schemas/DeviceFingerprint"},{"type":"null"}],"description":"Device fingerprint"},"payer_account_number":{"type":"string","maxLength":34,"title":"Payer Account Number","description":"Sender Account Number","example":"BG41PATC40022312219709"},"payer_first_name":{"anyOf":[{"type":"string","maxLength":35},{"type":"null"}],"title":"Payer First Name","description":"Sender First Name","example":"Igor"},"payer_last_name":{"anyOf":[{"type":"string","maxLength":35},{"type":"null"}],"title":"Payer Last Name","description":"Sender Last Name","example":"Riabushkin"},"payer_full_name":{"anyOf":[{"type":"string","maxLength":30},{"type":"null"}],"title":"Payer Full Name","description":"Sender Full Name","example":"Iga Riaboct"},"payer_address":{"type":"string","maxLength":35,"title":"Payer Address","description":"Sender Address","example":"Lemesos Ave 60"},"payer_city":{"type":"string","maxLength":25,"title":"Payer City","description":"Sender City","example":"Nicosia"},"payer_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payer State","description":"Sender state code","example":"AK"},"payer_country":{"type":"string","title":"Payer Country","description":"Sender 3-digit ISO alphabetic country code","example":"CYP"},"payer_postal_code":{"type":"string","maxLength":10,"title":"Payer Postal Code","description":"Sender Postal Code","example":"2014"},"payer_date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payer Date Of Birth","description":"Sender date of birth in MMDDYYYY format"},"payee_first_name":{"anyOf":[{"type":"string","maxLength":35},{"type":"null"}],"title":"Payee First Name","description":"Recipient First Name","example":"Igor"},"payee_last_name":{"anyOf":[{"type":"string","maxLength":35},{"type":"null"}],"title":"Payee Last Name","description":"Recipient Last Name","example":"Riabushkin"},"payee_full_name":{"anyOf":[{"type":"string","maxLength":30},{"type":"null"}],"title":"Payee Full Name","description":"Recipient Full Name","example":"Iga Riaboct"},"payee_address":{"anyOf":[{"type":"string","maxLength":35},{"type":"null"}],"title":"Payee Address","description":"Recipient Address","example":"Lemesos Ave 60"},"payee_city":{"anyOf":[{"type":"string","maxLength":25},{"type":"null"}],"title":"Payee City","description":"Recipient City","example":"Nicosia"},"payee_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payee State","description":"Recipient state code","example":"AK"},"payee_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payee Country","description":"Recipient 3-digit ISO alphabetic country code","example":"CYP"},"payee_postal_code":{"anyOf":[{"type":"string","maxLength":10},{"type":"null"}],"title":"Payee Postal Code","description":"Recipient Postal Code","example":"2014"},"payee_date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payee Date Of Birth","description":"Recipient date of birth in MMDDYYYY format"},"payee_phone_number":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"title":"Payee Phone Number","description":"Recipient phone number in international format","example":"+35712345678"}},"type":"object","required":["card_number","amount","currency","cardholder_name","payer_account_number","payer_address","payer_city","payer_country","payer_postal_code"],"title":"PayoutRequest","example":{"amount":"12.01","card_number":"5346932100108113","cardholder_name":"John Doe","currency":"EUR","dynamic_descriptor":"Booking Fee","expiry_date":"12/31","payee_address":"Lemesos Ave 60","payee_city":"Cyprus","payee_country":"CYP","payee_date_of_birth":"11151990","payee_first_name":"Igor","payee_full_name":"Igor Riapayout","payee_last_name":"Riapayout","payee_postal_code":"2014","payee_state":"NI","payer_account_number":"BG41PATC40022312219709","payer_address":"Lemesos Ave 60","payer_city":"Cyprus","payer_country":"CYP","payer_date_of_birth":"11151990","payer_first_name":"Ig","payer_full_name":"Ig Riapayout","payer_last_name":"Riapayout","payer_postal_code":"2014","payer_state":"NI"}},"PayoutResponse":{"properties":{"transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Reference","description":"Merchant internal transaction reference","example":"agg86094-1338-43a0-1ct4-bt913c156030"},"status":{"type":"string","title":"Status","description":"The status of the Payout request.","example":"Transaction success"},"message":{"type":"string","title":"Message","description":"A message describing the result of the Payout request.","example":"Payout successful"},"transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Id","description":"A unique identifier for the transaction.","example":"120415164401005769960123433915967345"},"payout_amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payout Amount","description":"The amount that was paid out (as a string).","example":"12.00"},"status_code":{"type":"integer","title":"Status Code","description":"HTTP status code representing the result of the request.","example":200},"processed_at":{"type":"string","format":"date-time","title":"Processed At","description":"Timestamp when the request was processed.","example":"2024-11-18T17:47:21"},"bank_status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Status Code","description":"The status code returned by the bank or payment processor.","example":"00"},"bank_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Status","description":"The status message returned by the bank or payment processor.","example":"Approve"}},"type":"object","required":["status","message","status_code","processed_at"],"title":"PayoutResponse","example":{"authorized_amount":"12.01","bank_status":"Approve","bank_status_code":"00","message":"Payout successful","processed_at":"2025-04-25T17:47:21","status":"Transaction success","status_code":200,"transaction_id":"120415164401005769960123433915967345","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"PosAuthPartialReversalRequest":{"properties":{"trxnType":{"type":"string","title":"Trxntype","description":"Transaction type.","example":"REVERSAL"},"trxnDateTime":{"type":"string","title":"Trxndatetime","description":"Local terminal's Date Time of the current reversal transaction in mmddHHMMSS format.","example":"0131113609"},"merchantData":{"$ref":"#/components/schemas/models__posauth_reversal__MerchantData"},"mac":{"type":"string","title":"Mac","description":"Message Authentication Code.","example":"QkY2RkQ0RjM3RjQwODI1NERDRTZBN0E3RTE0REZDOUM2OTIzNDVGQTU2QTQ0OUFFQkREREY4MkJBMTE3Q0Y5Qg=="},"trxnAmount":{"type":"string","title":"Trxnamount","description":"Transaction amount in minor units.","example":"1500"},"trxnCcyCd":{"type":"string","title":"Trxnccycd","description":"Currency code of the transaction.","example":"978"},"trxnId":{"type":"string","title":"Trxnid","description":"Unique identifier from the original AUTH transaction that should be reversed or refunded.","example":"120415164401005769960123433915967345"}},"type":"object","required":["trxnType","trxnDateTime","merchantData","mac","trxnAmount","trxnCcyCd","trxnId"],"title":"PosAuthPartialReversalRequest"},"PosAuthPartialReversalResponse":{"properties":{"merchantData":{"$ref":"#/components/schemas/MerchantData-Output"},"trxnAmount":{"type":"string","title":"Trxnamount","description":"Transaction amount in minor units.","example":"1000"},"trxnCcyCd":{"type":"string","title":"Trxnccycd","description":"Currency code of the transaction.","example":"978"},"respCd":{"type":"string","title":"Respcd","description":"Response code of the transaction.","example":"00"},"respMsg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Respmsg","description":"ICC in response message","example":"Approve"},"trxnId":{"type":"string","title":"Trxnid","description":"A unique identifier for the transaction.","example":"120415164401005769960123433915967345"},"authCd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authcd","description":"Authorization Identification Response","example":"013489"},"stan":{"type":"string","title":"Stan","description":"System Trace Audit Number","example":"300531"},"rrn":{"type":"string","title":"Rrn","description":"Retrieval Reference Number","example":"503111509114"},"trxnDateTime":{"type":"string","title":"Trxndatetime","description":"Date Time of the transaction.","example":"0131113609"},"mac":{"type":"string","title":"Mac","description":"Message Authentication Code.","example":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA=="}},"type":"object","required":["merchantData","trxnAmount","trxnCcyCd","respCd","trxnId","stan","rrn","trxnDateTime","mac"],"title":"PosAuthPartialReversalResponse"},"PosAuthRefundRequest":{"properties":{"trxnType":{"type":"string","title":"Trxntype","description":"Transaction type.","example":"REFUND"},"trxnDateTime":{"type":"string","title":"Trxndatetime","description":"Date Time of the transaction.","example":"0131113609"},"merchantData":{"$ref":"#/components/schemas/models__posauth_refund__MerchantData"},"terminalReqData":{"$ref":"#/components/schemas/models__posauth__TerminalReqData"},"cardData":{"$ref":"#/components/schemas/models__posauth_refund__CardData"},"mac":{"type":"string","title":"Mac","description":"Message Authentication Code.","example":"QkY2RkQ0RjM3RjQwODI1NERDRTZBN0E3RTE0REZDOUM2OTIzNDVGQTU2QTQ0OUFFQkREREY4MkJBMTE3Q0Y5Qg=="},"trxnAmount":{"type":"string","title":"Trxnamount","description":"Transaction amount in minor units.","example":"1500"},"trxnCcyCd":{"type":"string","title":"Trxnccycd","description":"Currency code of the transaction.","example":"978"},"trxnId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trxnid","description":"Unique identifier from the original AUTH transaction that should be reversed or refunded.","example":"120415164401005769960123433915967345"}},"type":"object","required":["trxnType","trxnDateTime","merchantData","terminalReqData","cardData","mac","trxnAmount","trxnCcyCd"],"title":"PosAuthRefundRequest"},"PosAuthRequest":{"properties":{"trxnType":{"type":"string","enum":["PURCHASE","PREAUTH","ADJUSTMENT","COMPLETION"],"title":"Trxntype","description":"Transaction type.","example":"PURCHASE"},"trxnDateTime":{"type":"string","title":"Trxndatetime","description":"Date Time of the transaction.","example":"0131113609"},"merchantData":{"$ref":"#/components/schemas/models__posauth__MerchantData"},"terminalReqData":{"$ref":"#/components/schemas/models__posauth__TerminalReqData"},"cardData":{"$ref":"#/components/schemas/models__posauth__CardData"},"mac":{"type":"string","title":"Mac","description":"Message Authentication Code.","example":"QkY2RkQ0RjM3RjQwODI1NERDRTZBN0E3RTE0REZDOUM2OTIzNDVGQTU2QTQ0OUFFQkREREY4MkJBMTE3Q0Y5Qg=="},"trxnAmount":{"type":"string","title":"Trxnamount","description":"Transaction amount in minor units.","example":"1500"},"trxnCcyCd":{"type":"string","title":"Trxnccycd","description":"Currency code of the transaction.","example":"978"},"dcc":{"anyOf":[{"$ref":"#/components/schemas/Dcc"},{"type":"null"}]},"addData":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Adddata","description":"MASTERCARD DE48 Additional Data","example":"R22100201103011"},"dynamicDescriptor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dynamicdescriptor","description":"Text that will be placed on cardholderā€™s bank statement","example":"Sample Text"},"cashbackTrxnAmount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cashbacktrxnamount","description":"Cashback Transaction amount in minor units.","example":"500"},"cashbackTrxnCcyCd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cashbacktrxnccycd","description":"Cashback Currency code of the transaction.","example":"978"},"surchargeTrxnAmount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Surchargetrxnamount","description":"Surcharge amount for the transaction in minor units.","example":"300"},"taxTrxnAmount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Taxtrxnamount","description":"Tax amount for the transaction in minor units.","example":"200"},"tipTrxnAmount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tiptrxnamount","description":"\tTip amount for the transaction in minor units.","example":"400"},"transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Reference","description":"Merchant internal transaction reference","example":"agg86094-1338-43a0-1ct4-bt913c156030"},"isDeferred":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isdeferred","description":"If the True parameter is passed, the transaction will be processed as a Deferred debit.","example":"True"},"parentAuthCd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentauthcd","description":"Parent Authorization Identification Response from PREAUTH for ADJUSTMENT, COMPLETION","example":"013489"},"parentRrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentrrn","description":"Parent Retrieval Reference Number from PREAUTH for ADJUSTMENT, COMPLETION","example":"503111509114"}},"type":"object","required":["trxnType","trxnDateTime","merchantData","terminalReqData","cardData","mac","trxnAmount","trxnCcyCd"],"title":"PosAuthRequest"},"PosAuthResponse":{"properties":{"merchantData":{"$ref":"#/components/schemas/MerchantData-Output"},"mskdPAN":{"type":"string","title":"Mskdpan","description":"Masked PAN.","example":"222360******0011"},"trxnAmount":{"type":"string","title":"Trxnamount","description":"Transaction amount in minor units.","example":"1000"},"trxnCcyCd":{"type":"string","title":"Trxnccycd","description":"Currency code of the transaction.","example":"978"},"respCd":{"type":"string","title":"Respcd","description":"Response code of the transaction.","example":"00"},"respMsg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Respmsg","description":"ICC in response message","example":"Approve"},"icc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icc","description":"Response message of the transaction.","example":"MDEwMDBGOUYzNjAyMDAwMjkxMDhBMUE1N0JERTAwODYwMDAw"},"trxnId":{"type":"string","title":"Trxnid","description":"A unique identifier for the transaction.","example":"120415164401005769960123433915967345"},"authCd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authcd","description":"Authorization Identification Response","example":"013489"},"stan":{"type":"string","title":"Stan","description":"System Trace Audit Number","example":"300531"},"rrn":{"type":"string","title":"Rrn","description":"Retrieval Reference Number","example":"503111509114"},"trxnDateTime":{"type":"string","title":"Trxndatetime","description":"Date Time of the transaction.","example":"0131113609"},"mac":{"type":"string","title":"Mac","description":"Message Authentication Code.","example":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA=="},"addData":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Adddata","description":"MASTERCARD DE48 Additional Data","example":"R220504011"},"transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Reference","description":"Merchant internal transaction reference","example":"agg86094-1338-43a0-1ct4-bt913c156030"}},"type":"object","required":["merchantData","mskdPAN","trxnAmount","trxnCcyCd","respCd","trxnId","stan","rrn","trxnDateTime","mac"],"title":"PosAuthResponse"},"PosAuthReversalRequest":{"properties":{"trxnType":{"type":"string","title":"Trxntype","description":"Transaction type.","example":"REVERSAL"},"trxnDateTime":{"type":"string","title":"Trxndatetime","description":"Local terminal's Date Time of the current reversal transaction in mmddHHMMSS format.","example":"0131113609"},"merchantData":{"$ref":"#/components/schemas/models__posauth_reversal__MerchantData"},"mac":{"type":"string","title":"Mac","description":"Message Authentication Code.","example":"QkY2RkQ0RjM3RjQwODI1NERDRTZBN0E3RTE0REZDOUM2OTIzNDVGQTU2QTQ0OUFFQkREREY4MkJBMTE3Q0Y5Qg=="},"trxnAmount":{"type":"string","title":"Trxnamount","description":"Transaction amount in minor units.","example":"1500"},"trxnCcyCd":{"type":"string","title":"Trxnccycd","description":"Currency code of the transaction.","example":"978"},"trxnId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trxnid","description":"Unique identifier from the original AUTH transaction that should be reversed or refunded.","example":"120415164401005769960123433915967345"},"terminalReqData":{"$ref":"#/components/schemas/models__posauth_reversal__TerminalReqData"},"cardData":{"$ref":"#/components/schemas/models__posauth_reversal__CardData"},"parentAuthCd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentauthcd","description":"Parent Authorization Identification Response from PREAUTH for ADJUSTMENT, COMPLETION","example":"013489"},"parentRrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentrrn","description":"Parent Retrieval Reference Number from PREAUTH for ADJUSTMENT, COMPLETION","example":"503111509114"}},"type":"object","required":["trxnType","trxnDateTime","merchantData","mac","trxnAmount","trxnCcyCd","terminalReqData","cardData"],"title":"PosAuthReversalRequest"},"PosAuthReversalResponse":{"properties":{"merchantData":{"$ref":"#/components/schemas/MerchantData-Output"},"trxnAmount":{"type":"string","title":"Trxnamount","description":"Transaction amount in minor units.","example":"1000"},"trxnCcyCd":{"type":"string","title":"Trxnccycd","description":"Currency code of the transaction.","example":"978"},"respCd":{"type":"string","title":"Respcd","description":"Response code of the transaction.","example":"00"},"respMsg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Respmsg","description":"ICC in response message","example":"Approve"},"trxnId":{"type":"string","title":"Trxnid","description":"A unique identifier for the transaction.","example":"120415164401005769960123433915967345"},"authCd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authcd","description":"Authorization Identification Response","example":"013489"},"stan":{"type":"string","title":"Stan","description":"System Trace Audit Number","example":"300531"},"rrn":{"type":"string","title":"Rrn","description":"Retrieval Reference Number","example":"503111509114"},"trxnDateTime":{"type":"string","title":"Trxndatetime","description":"Date Time of the transaction.","example":"0131113609"},"mac":{"type":"string","title":"Mac","description":"Message Authentication Code.","example":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA=="},"mskdPAN":{"type":"string","title":"Mskdpan","description":"Masked PAN.","example":"222360******0011"}},"type":"object","required":["merchantData","trxnAmount","trxnCcyCd","respCd","trxnId","stan","rrn","trxnDateTime","mac","mskdPAN"],"title":"PosAuthReversalResponse"},"PosOCTRequest":{"properties":{"trxnType":{"type":"string","title":"Trxntype","description":"Transaction type.","example":"PAYMENT"},"trxnDateTime":{"type":"string","title":"Trxndatetime","description":"Date Time of the transaction.","example":"0131113609"},"merchantData":{"$ref":"#/components/schemas/models__posoct__MerchantData"},"terminalReqData":{"$ref":"#/components/schemas/models__posoct__TerminalReqData"},"cardData":{"$ref":"#/components/schemas/models__posoct__CardData"},"mac":{"type":"string","title":"Mac","description":"Message Authentication Code.","example":"QkY2RkQ0RjM3RjQwODI1NERDRTZBN0E3RTE0REZDOUM2OTIzNDVGQTU2QTQ0OUFFQkREREY4MkJBMTE3Q0Y5Qg=="},"trxnAmount":{"type":"string","title":"Trxnamount","description":"Transaction amount in minor units.","example":"1500"},"trxnCcyCd":{"type":"string","title":"Trxnccycd","description":"Currency code of the transaction.","example":"978"},"addData":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Adddata","description":"MASTERCARD DE48 Additional Data","example":"R22100201103011"},"dynamicDescriptor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dynamicdescriptor","description":"Text that will be placed on cardholderā€™s bank statement","example":"Sample Text"}},"type":"object","required":["trxnType","trxnDateTime","merchantData","terminalReqData","cardData","mac","trxnAmount","trxnCcyCd"],"title":"PosOCTRequest"},"PosOCTResponse":{"properties":{"merchantData":{"$ref":"#/components/schemas/MerchantData-Output"},"mskdPAN":{"type":"string","title":"Mskdpan","description":"Masked PAN.","example":"222360******0011"},"trxnAmount":{"type":"string","title":"Trxnamount","description":"Transaction amount in minor units.","example":"1000"},"trxnCcyCd":{"type":"string","title":"Trxnccycd","description":"Currency code of the transaction.","example":"978"},"respCd":{"type":"string","title":"Respcd","description":"Response code of the transaction.","example":"00"},"respMsg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Respmsg","description":"ICC in response message","example":"Approve"},"icc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icc","description":"Response message of the transaction.","example":"MDEwMDBGOUYzNjAyMDAwMjkxMDhBMUE1N0JERTAwODYwMDAw"},"trxnId":{"type":"string","title":"Trxnid","description":"A unique identifier for the transaction.","example":"120415164401005769960123433915967345"},"authCd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authcd","description":"Authorization Identification Response","example":"013489"},"stan":{"type":"string","title":"Stan","description":"System Trace Audit Number","example":"300531"},"rrn":{"type":"string","title":"Rrn","description":"Retrieval Reference Number","example":"503111509114"},"trxnDateTime":{"type":"string","title":"Trxndatetime","description":"Date Time of the transaction.","example":"0131113609"},"mac":{"type":"string","title":"Mac","description":"Message Authentication Code.","example":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA=="},"addData":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Adddata","description":"MASTERCARD DE48 Additional Data","example":"R220504011"}},"type":"object","required":["merchantData","mskdPAN","trxnAmount","trxnCcyCd","respCd","trxnId","stan","rrn","trxnDateTime","mac"],"title":"PosOCTResponse"},"PreAuthRequest":{"properties":{"transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Reference","description":"Merchant internal transaction reference","example":"agg86094-1338-43a0-1ct4-bt913c156030"},"card_number":{"type":"string","title":"Card Number","description":"Credit card number for pre-authorization.","example":"4005529999000123"},"expiry_date":{"type":"string","title":"Expiry Date","description":"Expiration date of the card in MM/YY format.","example":"12/31"},"amount":{"type":"string","title":"Amount","description":"Amount to be pre-authorized (as a string).","example":"12.00"},"currency":{"type":"string","title":"Currency","description":"Currency of the transaction.","example":"EUR"},"cardholder_name":{"type":"string","title":"Cardholder Name","description":"Cardholder's name.","example":"John Doe"},"cvv":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cvv","description":"Card CVV for validation.","example":"196"},"cavv":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cavv","description":"CAVV for VISA or AAV for MASTERCARD","example":"AAAAAAAAAAAAAAAAAAAAAAAAAAA="},"series_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Series Type","description":"unscheduled, recurring, variable_amount_recurring or fix_amount_recurring","example":"unscheduled"},"initial_transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initial Transaction Id","description":"A unique identifier for the INITIAL transactions FOR recurring or unscheduled (UCOF, Unscheduled Credential on File)","example":"120415164401005769960123433915967345"},"dynamic_descriptor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dynamic Descriptor","description":"Text that will be placed on cardholderā€™s bank statement","example":"Sample Text"},"eci":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Eci","description":"Electronic Commerce and Payment Indicator from 3DSecure","example":"05"},"aft":{"anyOf":[{"$ref":"#/components/schemas/AFT"},{"type":"null"}],"description":"Additional financial transfer details."},"deviceFingerprint":{"anyOf":[{"$ref":"#/components/schemas/DeviceFingerprint"},{"type":"null"}],"description":"Device fingerprint"},"ds_transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ds Transaction Id","description":"3DS transaction ID","example":"f38e6948-5388-41a6-bca4-b49723c19437"},"emv_3d_secure_ver":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Emv 3D Secure Ver","description":"EMV 3-D Secure Version","example":"2.2"},"wallet":{"anyOf":[{"$ref":"#/components/schemas/Wallet"},{"type":"null"}],"description":"wallet name","example":"google_pay"},"tavv":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tavv","description":"TAVV Data","example":"MM**********************KA="},"external_init_transaction":{"anyOf":[{"$ref":"#/components/schemas/ExternalInitTransaction"},{"type":"null"}],"description":"Initial transaction data for subsequent transactions"},"is_instant_capture":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Instant Capture","description":"If the parameter is True, then after an pre-auth request, a Capture for the full request amount will be automatically sent","example":false}},"type":"object","required":["card_number","expiry_date","amount","currency","cardholder_name"],"title":"PreAuthRequest","example":{"aft":{"acceptor_legalname":"LINK4TECH","bai":"AA","recipient_name":"John Doe","sender_account_number":"CY74PATC40021100101122","sender_address":"Street House 123","sender_city":"Nicosia","sender_country":"196","sender_name":"John Doe","sender_postal_code":"12345"},"amount":"12.00","card_number":"4005529999000123","cardholder_name":"John Doe","cavv":"AAAAAAAAAAAAAAAAAAAAAAAAAAA=","currency":"EUR","cvv":"196","eci":"05","expiry_date":"12/31","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"PreAuthResponse":{"properties":{"transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Reference","description":"Merchant internal transaction reference","example":"agg86094-1338-43a0-1ct4-bt913c156030"},"status":{"type":"string","title":"Status","description":"The status of the pre-authentication request.","example":"Transaction success"},"message":{"type":"string","title":"Message","description":"A message describing the result of the pre-authentication.","example":"Pre-authentication successful"},"transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Id","description":"A unique identifier for the transaction.","example":"120415164401005769960123433915967345"},"authorized_amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorized Amount","description":"The amount that was authorized during the pre-authentication (as a string).","example":"12.00"},"status_code":{"type":"integer","title":"Status Code","description":"HTTP status code representing the result of the request.","example":200},"processed_at":{"type":"string","format":"date-time","title":"Processed At","description":"Timestamp when the request was processed.","example":"2024-11-18T17:47:21"},"bank_status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Status Code","description":"The status code returned by the bank or payment processor.","example":"00"},"bank_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Status","description":"The status message returned by the bank or payment processor.","example":"Approve"},"rrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rrn","description":"RRN.Field 37.","example":"607514207399"},"authorization_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization Code","description":"Authorization Code. Field 38","example":"046810"},"system_trace_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"System Trace Number","description":"STAN. Field 11.","example":"207399"},"processing_code_resp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Processing Code Resp","description":"Processing Code Response. Field 3.","example":"003000"},"card_acceptor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Card Acceptor Id","description":"Card Acceptor ID. Field 42.","example":"123490570889 "}},"type":"object","required":["status","message","status_code","processed_at"],"title":"PreAuthResponse","example":{"authorization_code":"046810","authorized_amount":"12.00","bank_status":"Approve","bank_status_code":"00","card_acceptor_id":"123490570889 ","message":"Pre-authentication successful","processed_at":"2024-11-18T17:47:21","processing_code_resp":"003000","rrn":"607514207399","status":"Transaction success","status_code":200,"system_trace_number":"207399","transaction_id":"120415164401005769960123433915967345","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"RecipientAddress":{"properties":{"line1":{"type":"string","title":"Line1","description":"Recipient's address line"},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Visa. Recipient's address line 2"},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street","description":"Visa. Recipient's street name"},"city":{"type":"string","title":"City","description":"Recipient's city"},"postal_code":{"type":"string","title":"Postal Code","description":"Recipient's postal code"}},"type":"object","required":["line1","city","postal_code"],"title":"RecipientAddress"},"RecipientInfo":{"properties":{"account_number":{"type":"string","title":"Account Number","description":"Recipient's account number","example":"CY74PATC40021100101122"},"account_number_type":{"$ref":"#/components/schemas/AccountNumberType","description":"Recipient's account number type","example":"IBAN"},"name":{"$ref":"#/components/schemas/RecipientName","description":"Recipient's name."},"country":{"type":"string","title":"Country","description":"Recipient's 3-symbols country code","example":"CYP"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"Recipient's state or province code for USA or Canada","example":"NY"},"address":{"$ref":"#/components/schemas/RecipientAddress","description":"Recipient's address"}},"type":"object","required":["account_number","account_number_type","name","country","address"],"title":"RecipientInfo"},"RecipientName":{"properties":{"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Name","description":"Recipient's full name for VISA customers","example":"John Doe"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Recipient's first name or Business name for Mastercard customers","example":"John"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Recipient's last name or Business name for Mastercard customers","example":"Doe"}},"type":"object","title":"RecipientName"},"ReconciliationInnerResponse":{"properties":{"success":{"type":"boolean","title":"Success"},"transaction":{"$ref":"#/components/schemas/ReconciliationTransaction"}},"type":"object","required":["success","transaction"],"title":"ReconciliationInnerResponse"},"ReconciliationResponse":{"properties":{"selected_serial":{"type":"string","title":"Selected Serial"},"selected_ip":{"type":"string","title":"Selected Ip"},"response":{"$ref":"#/components/schemas/ReconciliationInnerResponse"}},"type":"object","required":["selected_serial","selected_ip","response"],"title":"ReconciliationResponse","description":"Full response wrapper for reconciliation call."},"ReconciliationTransaction":{"properties":{"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number"},"han_digest":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Han Digest"},"amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount"},"amount_other":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount Other"},"tip_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tip Amount"},"total_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Amount"},"app_confirmation_required":{"type":"boolean","title":"App Confirmation Required","default":false},"app_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"App Label"},"attempted_sources":{"items":{},"type":"array","title":"Attempted Sources"},"attempts_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Attempts Remaining"},"auth_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Auth Code"},"result_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Result Code"},"result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Result"},"online_result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Online Result"},"card_details":{"type":"object","title":"Card Details"},"card_expiry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Card Expiry"},"currency_scale":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Currency Scale"},"currency_symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency Symbol"},"cvm_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cvm Mode"},"cvm_result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cvm Result"},"dispatch":{"anyOf":[{"$ref":"#/components/schemas/DispatchInfo"},{"type":"null"}]},"duration":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Duration"},"ended_at":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ended At"},"started_at":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Started At"},"host":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host"},"host_module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host Module Name"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"initiator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initiator"},"input_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Source"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"},"is_api":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Api"},"is_contactless":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Contactless"},"is_contactless_transaction_limit_exceeded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Contactless Transaction Limit Exceeded"},"is_deferred_auth":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Deferred Auth"},"is_emv":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Emv"},"is_fallback":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Fallback"},"is_force_online":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Force Online"},"is_keyed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Keyed"},"is_online":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Online"},"is_online_pin":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Online Pin"},"is_offline_pin":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Offline Pin"},"is_reversed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Reversed"},"is_sca_single_tap":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Sca Single Tap"},"is_signature_required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Signature Required"},"issuer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuer Id"},"job_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Id"},"ksn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ksn"},"last_deferred_auth_attempted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Deferred Auth Attempted At"},"local_totals_before_txn":{"anyOf":[{"$ref":"#/components/schemas/models__tap_relay__LocalTotalsBeforeTxn__2"},{"type":"null"}]},"message_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Message Number"},"num_attempts":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Attempts"},"num_deferred_auth_attempts":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Deferred Auth Attempts"},"online_request":{"anyOf":[{},{"type":"null"}],"title":"Online Request"},"online_response":{"anyOf":[{"$ref":"#/components/schemas/OnlineResponse"},{"type":"null"}]},"pin_block":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pin Block"},"reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Number"},"reference_txn_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Txn Id"},"services":{"anyOf":[{"$ref":"#/components/schemas/ServicesInfo"},{"type":"null"}]},"session_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Session Number"},"should_fallback":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Should Fallback"},"should_retry":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Should Retry"},"stan":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stan"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"status_details":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Details"},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtype"},"tags":{"type":"object","title":"Tags"},"terminal_online_decision":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Terminal Online Decision"},"timeout_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timeout Ms"},"type":{"type":"string","enum":["reconciliation"],"const":"reconciliation","title":"Type","default":"reconciliation"}},"type":"object","title":"ReconciliationTransaction"},"RefundRequest":{"properties":{"transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Reference","description":"Merchant internal transaction reference","example":"agg86094-1338-43a0-1ct4-bt913c156030"},"transaction_id":{"type":"string","title":"Transaction Id","description":"The transaction ID from the pre-authorized payment response.","example":"120415164401005769960123433915967345"},"amount":{"type":"string","title":"Amount","description":"Amount to be captured (as a string).","example":"12.00"},"deviceFingerprint":{"anyOf":[{"$ref":"#/components/schemas/DeviceFingerprint"},{"type":"null"}],"description":"Device fingerprint"}},"type":"object","required":["transaction_id","amount"],"title":"RefundRequest"},"RefundResponse":{"properties":{"transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Reference","description":"Merchant internal transaction reference","example":"agg86094-1338-43a0-1ct4-bt913c156030"},"status":{"type":"string","title":"Status","description":"The status of the capture request.","example":"Refund success"},"message":{"type":"string","title":"Message","description":"A message describing the result of the capture.","example":"Refund successful"},"transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Id","description":"A unique identifier for the transaction.","example":"120415164401005769960123433915967345"},"refunded_amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Refunded Amount","description":"The amount that was captured (as a string).","example":"12.00"},"status_code":{"type":"integer","title":"Status Code","description":"HTTP status code representing the result of the request.","example":200},"processed_at":{"type":"string","format":"date-time","title":"Processed At","description":"Timestamp when the request was processed.","example":"2024-11-18T17:47:21"},"bank_status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Status Code","description":"The status code returned by the bank or payment processor.","example":"12345"},"bank_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Status","description":"The status message returned by the bank or payment processor.","example":"Transaction approved"},"rrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rrn","description":"RRN.Field 37.","example":"607514207399"},"authorization_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization Code","description":"Authorization Code. Field 38","example":"046810"},"system_trace_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"System Trace Number","description":"STAN. Field 11.","example":"207399"},"processing_code_resp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Processing Code Resp","description":"Processing Code Response. Field 3.","example":"003000"},"card_acceptor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Card Acceptor Id","description":"Card Acceptor ID. Field 42.","example":"123490570889 "}},"type":"object","required":["status","message","status_code","processed_at"],"title":"RefundResponse","example":{"authorization_code":"046810","bank_status":"Approved","bank_status_code":"00","card_acceptor_id":"123490570889 ","message":"Refund successful","processed_at":"2024-11-18T17:47:21","processing_code_resp":"003000","refunded_amount":"12.00","rrn":"607514207399","status":"success","status_code":200,"system_trace_number":"207399","transaction_id":"120415164401005769960123433915967345","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030"}},"SaleInnerResponse":{"properties":{"success":{"type":"boolean","title":"Success"},"transaction":{"$ref":"#/components/schemas/SaleTransaction"}},"type":"object","required":["success","transaction"],"title":"SaleInnerResponse"},"SaleResponse":{"properties":{"selected_serial":{"type":"string","title":"Selected Serial"},"selected_ip":{"type":"string","title":"Selected Ip"},"response":{"$ref":"#/components/schemas/SaleInnerResponse"}},"type":"object","required":["selected_serial","selected_ip","response"],"title":"SaleResponse","description":"Sale transaction response"},"SaleTransaction":{"properties":{"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number"},"han_digest":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Han Digest"},"amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount"},"amount_other":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount Other"},"tip_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tip Amount"},"total_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Amount"},"app_confirmation_required":{"type":"boolean","title":"App Confirmation Required","default":false},"app_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"App Label"},"attempted_sources":{"items":{},"type":"array","title":"Attempted Sources"},"attempts_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Attempts Remaining"},"auth_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Auth Code"},"result_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Result Code"},"card_details":{"type":"object","title":"Card Details"},"card_expiry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Card Expiry"},"currency_scale":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Currency Scale"},"currency_symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency Symbol"},"cvm_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cvm Mode"},"cvm_result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cvm Result"},"dispatch":{"anyOf":[{"$ref":"#/components/schemas/DispatchInfo"},{"type":"null"}]},"duration":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Duration"},"started_at":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Started At"},"ended_at":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ended At"},"host":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host"},"host_module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host Module Name"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"initiator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initiator"},"input_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Source"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"},"is_api":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Api"},"is_contactless":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Contactless"},"is_contactless_transaction_limit_exceeded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Contactless Transaction Limit Exceeded"},"is_deferred_auth":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Deferred Auth"},"is_emv":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Emv"},"is_fallback":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Fallback"},"is_force_online":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Force Online"},"is_keyed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Keyed"},"is_online":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Online"},"is_online_pin":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Online Pin"},"is_offline_pin":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Offline Pin"},"is_reversed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Reversed"},"is_sca_single_tap":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Sca Single Tap"},"is_signature_required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Signature Required"},"issuer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuer Id"},"job_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Id"},"ksn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ksn"},"last_deferred_auth_attempted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Deferred Auth Attempted At"},"local_totals_before_txn":{"anyOf":[{"$ref":"#/components/schemas/models__tap_relay__LocalTotalsBeforeTxn__1"},{"type":"null"}]},"message_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Message Number"},"num_attempts":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Attempts"},"num_deferred_auth_attempts":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Deferred Auth Attempts"},"online_request":{"anyOf":[{},{"type":"null"}],"title":"Online Request"},"online_response":{"anyOf":[{},{"type":"null"}],"title":"Online Response"},"online_result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Online Result"},"pin_block":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pin Block"},"reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Number"},"reference_txn_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Txn Id"},"result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Result"},"services":{"anyOf":[{"$ref":"#/components/schemas/ServicesInfo"},{"type":"null"}]},"session_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Session Number"},"should_fallback":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Should Fallback"},"should_retry":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Should Retry"},"stan":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stan"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"status_details":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Details"},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtype"},"tags":{"type":"object","title":"Tags"},"terminal_online_decision":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Terminal Online Decision"},"timeout_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timeout Ms"},"type":{"type":"string","enum":["sale"],"const":"sale","title":"Type","default":"sale"}},"type":"object","title":"SaleTransaction"},"SaveCardRequest":{"properties":{"card_number":{"type":"string","title":"Card Number","description":"Full PAN (Primary Account Number). Numeric string without spaces.","example":"4111101011111003"},"exp_year":{"type":"string","title":"Exp Year","description":"Card expiration year in YYYY format.","example":"2030"},"exp_month":{"type":"string","title":"Exp Month","description":"Card expiration month MM (01ā€“12).","example":"12"},"cardholder_name":{"type":"string","title":"Cardholder Name","description":"Cardholder name as printed on the card.","example":"JOHN FROG"},"ksn":{"type":"string","title":"Ksn","description":"Optional EMV key sequence number (may be empty).","default":"","example":""},"mid":{"type":"string","title":"Mid","description":"Merchant Identity","example":""},"tid":{"type":"string","title":"Tid","description":"Terminal Identity","default":"","example":""},"transaction_reference":{"type":"string","title":"Transaction Reference","description":"Merchant internal identification","example":""}},"type":"object","required":["card_number","exp_year","exp_month","cardholder_name","mid","transaction_reference"],"title":"SaveCardRequest"},"SaveCardResponse":{"properties":{"status":{"type":"string","title":"Status","example":"Card Saved Successfully"},"status_code":{"type":"integer","title":"Status Code","example":200},"tito_token":{"type":"string","title":"Tito Token","description":"Tokenized card identifier type TITO","example":"996236693436463385"},"uuid_token":{"type":"string","title":"Uuid Token","description":"Tokenized card identifier type UUID","example":"b3386094-1338-43a0-1ct4-bt913c156999"},"transaction_reference":{"type":"string","title":"Transaction Reference","description":"Tokenized card identifier","example":"b3386094-1338-43a0-1ct4-bt913c156999"}},"type":"object","required":["status","status_code","tito_token","uuid_token","transaction_reference"],"title":"SaveCardResponse"},"ScreenInnerResponse":{"properties":{"scene":{"anyOf":[{"$ref":"#/components/schemas/ScreenScene"},{"type":"null"}]},"success":{"type":"boolean","title":"Success"}},"type":"object","required":["success"],"title":"ScreenInnerResponse"},"ScreenResponse":{"properties":{"selected_serial":{"type":"string","title":"Selected Serial"},"selected_ip":{"type":"string","title":"Selected Ip"},"response":{"$ref":"#/components/schemas/ScreenInnerResponse"}},"type":"object","required":["selected_serial","selected_ip","response"],"title":"ScreenResponse","description":"Screen / UI render response"},"ScreenScene":{"properties":{"path":{"type":"string","title":"Path"},"text":{"type":"string","title":"Text"}},"type":"object","required":["path","text"],"title":"ScreenScene"},"SenderInfo":{"properties":{"name":{"type":"string","title":"Name","description":"Sender's name.","example":"John Doe"},"address":{"type":"string","title":"Address","description":"Sender's address.","example":"Street House 123"},"city":{"type":"string","title":"City","description":"Sender's city.","example":"Nicosia"},"country":{"type":"string","title":"Country","description":"Sender's country code in ISO format","example":"CYP"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"Sender's state for Canada or USA","example":"NY"}},"type":"object","required":["name","address","city","country"],"title":"SenderInfo"},"ServicesInfo":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"interchange_rules":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interchange Rules"},"authorization_processing_rules":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization Processing Rules"},"range_of_services":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Range Of Services"}},"type":"object","title":"ServicesInfo"},"SystemStatusResponse":{"properties":{"nodeA":{"type":"boolean","title":"Nodea"},"nodeB":{"type":"boolean","title":"Nodeb"},"nodeC":{"type":"boolean","title":"Nodec"},"apiPOS":{"type":"boolean","title":"Apipos"},"apiECOM":{"type":"boolean","title":"Apiecom"},"apiFraud":{"type":"boolean","title":"Apifraud"},"apiPortal":{"type":"boolean","title":"Apiportal"}},"type":"object","required":["nodeA","nodeB","nodeC","apiPOS","apiECOM","apiFraud","apiPortal"],"title":"SystemStatusResponse"},"TapRelayAuthorizationObject":{"properties":{"addData":{"anyOf":[{},{"type":"null"}],"title":"Adddata"},"authCd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authcd"},"icc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icc"},"mac":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mac"},"merchantData":{"anyOf":[{"$ref":"#/components/schemas/TapRelayOnlineRequestMerchantData"},{"type":"null"}]},"mskdPAN":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mskdpan"},"respCd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Respcd"},"respMsg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Respmsg"},"rrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rrn"},"stan":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stan"},"trxnAmount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trxnamount"},"trxnCcyCd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trxnccycd"},"trxnDateTime":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trxndatetime"},"trxnId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trxnid"}},"additionalProperties":true,"type":"object","title":"TapRelayAuthorizationObject"},"TapRelayCancelRequest":{"properties":{"serial":{"type":"string","title":"Serial","description":"If set, cancel on this device serial"}},"type":"object","required":["serial"],"title":"TapRelayCancelRequest"},"TapRelayCurrentScreenStatusRequest":{"properties":{"serial":{"type":"string","title":"Serial","description":"If set, get Current Screen Status on this device serial"}},"type":"object","required":["serial"],"title":"TapRelayCurrentScreenStatusRequest"},"TapRelayDispatch":{"properties":{"duration":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Duration"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"},{"type":"null"}],"title":"Started At"},"ended_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"},{"type":"null"}],"title":"Ended At"}},"additionalProperties":true,"type":"object","title":"TapRelayDispatch"},"TapRelayError":{"properties":{"respCd":{"type":"string","title":"Respcd","default":"06","example":"06"},"respMsg":{"type":"string","title":"Respmsg","default":"Invalid or missing API key","example":"Invalid or missing API key"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","default":"Please provide valid API key","example":"Please provide valid API key"}},"type":"object","title":"TapRelayError"},"TapRelayHTTPError":{"properties":{"detail":{"$ref":"#/components/schemas/TapRelayError"}},"type":"object","required":["detail"],"title":"TapRelayHTTPError"},"TapRelayLastTransactionRequest":{"properties":{"serial":{"type":"string","title":"Serial","description":"Last Transaction Status"}},"type":"object","required":["serial"],"title":"TapRelayLastTransactionRequest"},"TapRelayLastTransactionStatusResponse":{"properties":{"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount"},"amount_other":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount Other"},"app_confirmation_required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"App Confirmation Required"},"app_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"App Label"},"attempted_sources":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Attempted Sources"},"attempts_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Attempts Remaining"},"auth_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Auth Code"},"card_details":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Card Details"},"card_expiry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Card Expiry"},"client_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"},"controller":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Controller"},"currency_scale":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Currency Scale"},"currency_symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency Symbol"},"cvm_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cvm Mode"},"cvm_result":{"anyOf":[{},{"type":"null"}],"title":"Cvm Result"},"dispatch":{"anyOf":[{"$ref":"#/components/schemas/TapRelayDispatch"},{"type":"null"}]},"duration":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Duration"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"},{"type":"null"}],"title":"Started At"},"ended_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"},{"type":"null"}],"title":"Ended At"},"environment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Environment"},"han_digest":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Han Digest"},"host":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host"},"host_module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host Module Name"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"initiator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initiator"},"input_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Source"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"},"is_api":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Api"},"is_contactless":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Contactless"},"is_contactless_transaction_limit_exceeded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Contactless Transaction Limit Exceeded"},"is_deferred_auth":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Deferred Auth"},"is_emv":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Emv"},"is_fallback":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Fallback"},"is_force_online":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Force Online"},"is_keyed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Keyed"},"is_offline_pin":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Offline Pin"},"is_online":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Online"},"is_online_pin":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Online Pin"},"is_reversed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Reversed"},"is_sca_single_tap":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Sca Single Tap"},"is_signature_required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Signature Required"},"issuer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuer Id"},"job_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Id"},"ksn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ksn"},"last_deferred_auth_attempted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"},{"type":"null"}],"title":"Last Deferred Auth Attempted At"},"local_totals_before_txn":{"anyOf":[{"$ref":"#/components/schemas/TapRelayLocalTotalsBeforeTxn"},{"type":"null"}]},"message_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Message Number"},"num_attempts":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Attempts"},"num_deferred_auth_attempts":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Deferred Auth Attempts"},"online_request":{"anyOf":[{"$ref":"#/components/schemas/TapRelayOnlineRequest"},{"type":"null"}]},"online_response":{"anyOf":[{"$ref":"#/components/schemas/TapRelayOnlineResponse"},{"type":"null"}]},"online_result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Online Result"},"pin_block":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pin Block"},"reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Number"},"reference_txn_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Txn Id"},"result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Result"},"result_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Result Code"},"services":{"anyOf":[{"$ref":"#/components/schemas/TapRelayServices"},{"type":"null"}]},"session_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Session Number"},"should_fallback":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Should Fallback"},"should_retry":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Should Retry"},"stan":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stan"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"status_details":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Details"},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtype"},"tags":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Tags"},"terminal_online_decision":{"anyOf":[{},{"type":"null"}],"title":"Terminal Online Decision"},"timeout_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timeout Ms"},"tip_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tip Amount"},"total_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Amount"},"transaction":{"anyOf":[{"$ref":"#/components/schemas/TapRelayTransactionMini"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}},"additionalProperties":true,"type":"object","title":"TapRelayLastTransactionStatusResponse","description":"Model for Kinetic/TapRelay \"last transaction status\" payload.\nThis is the INNER payload you receive in `response` for /last."},"TapRelayLocalTotalsBeforeTxn":{"properties":{"host":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host"},"host_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host Class"},"session_total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Session Total"},"amex_cashbacks_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amex Cashbacks Amount"},"amex_cashbacks_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amex Cashbacks Count"},"amex_credits_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amex Credits Amount"},"amex_credits_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amex Credits Count"},"amex_debits_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amex Debits Amount"},"amex_debits_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amex Debits Count"},"amex_tips_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amex Tips Amount"},"amex_tips_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amex Tips Count"},"cashbacks_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cashbacks Amount"},"cashbacks_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cashbacks Count"},"credits_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Amount"},"credits_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Count"},"debits_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Debits Amount"},"debits_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Debits Count"},"tips_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tips Amount"},"tips_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tips Count"},"diners_cashbacks_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Diners Cashbacks Amount"},"diners_cashbacks_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Diners Cashbacks Count"},"diners_credits_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Diners Credits Amount"},"diners_credits_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Diners Credits Count"},"diners_debits_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Diners Debits Amount"},"diners_debits_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Diners Debits Count"},"diners_tips_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Diners Tips Amount"},"diners_tips_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Diners Tips Count"},"mastercard_cashbacks_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Mastercard Cashbacks Amount"},"mastercard_cashbacks_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Mastercard Cashbacks Count"},"mastercard_credits_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Mastercard Credits Amount"},"mastercard_credits_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Mastercard Credits Count"},"mastercard_debits_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Mastercard Debits Amount"},"mastercard_debits_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Mastercard Debits Count"},"mastercard_tips_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Mastercard Tips Amount"},"mastercard_tips_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Mastercard Tips Count"},"visa_cashbacks_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Visa Cashbacks Amount"},"visa_cashbacks_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Visa Cashbacks Count"},"visa_credits_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Visa Credits Amount"},"visa_credits_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Visa Credits Count"},"visa_debits_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Visa Debits Amount"},"visa_debits_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Visa Debits Count"},"visa_tips_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Visa Tips Amount"},"visa_tips_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Visa Tips Count"},"unknown_cashbacks_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Unknown Cashbacks Amount"},"unknown_cashbacks_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Unknown Cashbacks Count"},"unknown_credits_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Unknown Credits Amount"},"unknown_credits_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Unknown Credits Count"},"unknown_debits_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Unknown Debits Amount"},"unknown_debits_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Unknown Debits Count"},"unknown_tips_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Unknown Tips Amount"},"unknown_tips_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Unknown Tips Count"}},"additionalProperties":true,"type":"object","title":"TapRelayLocalTotalsBeforeTxn"},"TapRelayOnlineRequest":{"properties":{"cardData":{"anyOf":[{"$ref":"#/components/schemas/TapRelayOnlineRequestCardData"},{"type":"null"}]},"cashbackTrxnCcyCd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cashbacktrxnccycd"},"mac":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mac"},"merchantData":{"anyOf":[{"$ref":"#/components/schemas/TapRelayOnlineRequestMerchantData"},{"type":"null"}]},"surchargeTrxnAmount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Surchargetrxnamount"},"terminalReqData":{"anyOf":[{"$ref":"#/components/schemas/TapRelayOnlineRequestTerminalReqData"},{"type":"null"}]},"trxnAmount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trxnamount"},"trxnCcyCd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trxnccycd"},"trxnDateTime":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trxndatetime"},"trxnType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trxntype"}},"additionalProperties":true,"type":"object","title":"TapRelayOnlineRequest"},"TapRelayOnlineRequestCardData":{"properties":{"cardBrnd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cardbrnd"},"cardCcyCd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cardccycd"},"cardCtryCd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cardctrycd"},"cardNumber":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cardnumber"},"cardSeqNum":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cardseqnum"},"expDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expdate"},"ksn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ksn"},"mskdPAN":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mskdpan"},"track2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Track2"}},"additionalProperties":true,"type":"object","title":"TapRelayOnlineRequestCardData"},"TapRelayOnlineRequestMerchantData":{"properties":{"mId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mid"},"tId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tid"}},"additionalProperties":true,"type":"object","title":"TapRelayOnlineRequestMerchantData"},"TapRelayOnlineRequestTerminalReqData":{"properties":{"entryMode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entrymode"},"icc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icc"},"keyId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Keyid"}},"additionalProperties":true,"type":"object","title":"TapRelayOnlineRequestTerminalReqData"},"TapRelayOnlineResponse":{"properties":{"authorization_duration":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Authorization Duration"},"authorization_http_status":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Authorization Http Status"},"authorization_object":{"anyOf":[{"$ref":"#/components/schemas/TapRelayAuthorizationObject"},{"type":"null"}]},"authorization_received_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"},{"type":"null"}],"title":"Authorization Received At"},"authorization_requested_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"},{"type":"null"}],"title":"Authorization Requested At"},"response_text":{"anyOf":[{"$ref":"#/components/schemas/TapRelayOnlineResponseText"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"TapRelayOnlineResponse"},"TapRelayOnlineResponseText":{"properties":{"display":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display"}},"additionalProperties":true,"type":"object","title":"TapRelayOnlineResponseText"},"TapRelayReconciliationRequest":{"properties":{"serial":{"type":"string","title":"Serial","description":"Reconciliation Request"}},"type":"object","required":["serial"],"title":"TapRelayReconciliationRequest"},"TapRelayRefundRequest":{"properties":{"amount":{"type":"integer","minimum":1.0,"title":"Amount","description":"Amount in minor units (e.g. 1000 = 10.00)"},"txn_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Txn Id","description":"Optional transaction id to pass to LINK4TECH"},"serial":{"type":"string","title":"Serial","description":"If set, execute sale on this device serial"}},"type":"object","required":["amount","serial"],"title":"TapRelayRefundRequest"},"TapRelayRefundResponse":{"properties":{"selected_serial":{"type":"string","title":"Selected Serial"},"selected_ip":{"type":"string","title":"Selected Ip"},"response":{"type":"object","title":"Response"}},"type":"object","required":["selected_serial","selected_ip","response"],"title":"TapRelayRefundResponse"},"TapRelayReversalRequest":{"properties":{"reference_txn_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Txn Id","description":"ā€“\tReference txn_id to pass to LINK4TECH"},"serial":{"type":"string","title":"Serial","description":"If set, execute sale on this device serial"}},"type":"object","required":["serial"],"title":"TapRelayReversalRequest"},"TapRelayReversalResponse":{"properties":{"selected_serial":{"type":"string","title":"Selected Serial"},"selected_ip":{"type":"string","title":"Selected Ip"},"response":{"type":"object","title":"Response"}},"type":"object","required":["selected_serial","selected_ip","response"],"title":"TapRelayReversalResponse"},"TapRelaySaleRequest":{"properties":{"amount":{"type":"integer","minimum":1.0,"title":"Amount","description":"Amount in minor units (e.g. 1000 = 10.00)"},"txn_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Txn Id","description":"Optional transaction id to pass to LINK4TECH"},"serial":{"type":"string","title":"Serial","description":"If set, execute sale on this device serial"}},"type":"object","required":["amount","serial"],"title":"TapRelaySaleRequest"},"TapRelayServices":{"properties":{"authorization_processing_rules":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization Processing Rules"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"interchange_rules":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interchange Rules"},"range_of_services":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Range Of Services"}},"additionalProperties":true,"type":"object","title":"TapRelayServices"},"TapRelayTransactionMini":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Result"},"total_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Amount"}},"additionalProperties":true,"type":"object","title":"TapRelayTransactionMini"},"TokenListItemResponse":{"properties":{"id":{"type":"integer","title":"Id","example":1},"tito_token":{"type":"string","title":"Tito Token","example":"996236693436463385"},"uuid_token":{"type":"string","title":"Uuid Token","example":"b3386094-1338-43a0-1cf4-bt913c156999"},"card_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Id","example":125},"transaction_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Transaction Id"},"is_used":{"type":"boolean","title":"Is Used","example":false},"masked_pan":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Masked Pan","example":"518552******0016"},"expired":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expired","example":"3512"}},"type":"object","required":["id","tito_token","uuid_token","is_used"],"title":"TokenListItemResponse"},"TokenPayInRequest":{"properties":{"amount":{"type":"string","title":"Amount","description":"Transaction amount in major units as decimal string","example":"10.01"},"currency":{"type":"string","title":"Currency","description":"ISO 4217 currency code","example":"EUR"},"token_id":{"type":"string","title":"Token Id","description":"Tokenized card identifier","example":"agg86094-1338-43a0-1ct4-bt913c156030"}},"type":"object","required":["amount","currency","token_id"],"title":"TokenPayInRequest","example":{"currency":"EUR","token_id":"996236693436463385","txnAmount":"10.01"}},"TokenPayInResponse":{"properties":{"merchantData":{"$ref":"#/components/schemas/MerchantData-Output"},"mskdPAN":{"type":"string","title":"Mskdpan","description":"Masked PAN.","example":"222360******0011"},"trxnAmount":{"type":"string","title":"Trxnamount","description":"Transaction amount in minor units.","example":"1000"},"trxnCcyCd":{"type":"string","title":"Trxnccycd","description":"Currency code of the transaction.","example":"978"},"respCd":{"type":"string","title":"Respcd","description":"Response code of the transaction.","example":"00"},"respMsg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Respmsg","description":"ICC in response message","example":"Approve"},"icc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icc","description":"Response message of the transaction.","example":"MDEwMDBGOUYzNjAyMDAwMjkxMDhBMUE1N0JERTAwODYwMDAw"},"trxnId":{"type":"string","title":"Trxnid","description":"A unique identifier for the transaction.","example":"120415164401005769960123433915967345"},"authCd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authcd","description":"Authorization Identification Response","example":"013489"},"stan":{"type":"string","title":"Stan","description":"System Trace Audit Number","example":"300531"},"rrn":{"type":"string","title":"Rrn","description":"Retrieval Reference Number","example":"503111509114"},"trxnDateTime":{"type":"string","title":"Trxndatetime","description":"Date Time of the transaction.","example":"0131113609"},"mac":{"type":"string","title":"Mac","description":"Message Authentication Code.","example":"OUE5RUMxNTY3RDY2RjgzMDM3MjI1MEQ5QkY2MDc2QUM4RUIyQ0VBNzgzQTA0QTMwQzU1QkNFQThBM0Y4QjI0OA=="},"addData":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Adddata","description":"MASTERCARD DE48 Additional Data","example":"R220504011"},"transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Reference","description":"Merchant internal transaction reference","example":"agg86094-1338-43a0-1ct4-bt913c156030"}},"type":"object","required":["merchantData","mskdPAN","trxnAmount","trxnCcyCd","respCd","trxnId","stan","rrn","trxnDateTime","mac"],"title":"TokenPayInResponse"},"TokenPayoutRequest":{"properties":{"amount":{"type":"string","title":"Amount","description":"Transaction amount in major units as decimal string","example":"10.01"},"currency":{"type":"string","title":"Currency","description":"ISO 4217 currency code","example":"EUR"},"token_id":{"type":"string","title":"Token Id","description":"Tokenized card identifier","example":"996236693436463385"}},"type":"object","required":["amount","currency","token_id"],"title":"TokenPayoutRequest","example":{"currency":"EUR","token_id":"996236693436463385","txnAmount":"10.01"}},"TokenPayoutResponse":{"properties":{"status_code":{"type":"integer","title":"Status Code","description":"HTTP-like status code","example":200},"status":{"type":"string","title":"Status","description":"Human-readable transaction status","example":"Transaction Successful"},"amount":{"type":"string","title":"Amount","description":"Final settled amount (after conversion / fees)","example":"7.89"},"transaction_id":{"type":"string","title":"Transaction Id","description":"Unique transaction identifier","example":"112109074601004227550123432609182310"}},"type":"object","required":["status_code","status","amount","transaction_id"],"title":"TokenPayoutResponse","example":{"amount":"7.89","status":"Transaction Successful","status_code":200,"transaction_id":"112109074601004227550123432609182310"}},"TransactionPurpose":{"type":"string","enum":["Family_Support","Regular_Labor_Transfers","Travel_Tourism","Education","Hospitalization_Medical_Treatment","Emergency_Need","Savings","Gifts","Other","Salary","Crowd_lending","Crypto_currency","Refund_to_original_card","Refund_to_new_card","High_Risk_Securities","Recycling_Deposit_Return","Value_Added_Tax_Payment"],"title":"TransactionPurpose"},"TransactionReportRequest":{"properties":{"merchant_id":{"type":"integer","exclusiveMinimum":0.0,"title":"Merchant Id","description":"Merchant ID must be a positive integer."},"terminal_id":{"type":"integer","exclusiveMinimum":0.0,"title":"Terminal Id","description":"Terminal ID must be a positive integer."},"date_from":{"type":"string","format":"date","title":"Date From","description":"Start date for the report. Cannot be in the future."},"date_to":{"type":"string","format":"date","title":"Date To","description":"End date for the report. Must be greater than or equal to `date_from`."}},"type":"object","required":["merchant_id","terminal_id","date_from","date_to"],"title":"TransactionReportRequest"},"TransactionReportResponse":{"properties":{"id":{"type":"integer","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"processor_transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Processor Transaction Reference"},"amount":{"type":"number","title":"Amount"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"masked_pan":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Masked Pan"},"rrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rrn"},"sale_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sale Reference"},"transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Reference"},"system_trace_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"System Trace Number"},"authorization_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization Code"},"payment_provider_transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Provider Transaction Id"},"is_settled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Settled"},"e_comm_possible_capture_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"E Comm Possible Capture Amount"},"e_comm_total_amount_captured":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"E Comm Total Amount Captured"},"e_comm_is_captured":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"E Comm Is Captured"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Code"},"errors":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Errors"},"velocity_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Velocity Description"},"tx_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tx Type"},"reversed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Reversed"},"reverse_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reverse Type"},"original_processor_transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Processor Transaction Reference"},"batch_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Batch Id"},"batch_closed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Batch Closed At"},"terminal_identity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Terminal Identity"},"pan_entry_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pan Entry Mode"},"auth_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Auth Method"},"card_entry_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Card Entry Mode"},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider"},"terminal_local_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Terminal Local Time"},"merchant_legal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Merchant Legal Name"},"mcc_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mcc Code"},"bin_visa":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bin Visa"},"is_dsecure":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Dsecure"},"cof_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cof Type"},"central_processing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Central Processing Date"},"conversion_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Conversion Date"},"fee_descriptor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fee Descriptor"},"fee_program_indicator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fee Program Indicator"},"funds_transfer_sre_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Funds Transfer Sre Id"},"interchange_fee_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interchange Fee Amount"},"interchange_fee_sign":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interchange Fee Sign"},"leaf_level_sre_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Leaf Level Sre Id"},"rate_table_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rate Table Id"},"reclassification_indicator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reclassification Indicator"},"settlement_amount_interchange":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Settlement Amount Interchange"},"settlement_amount_sign":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Settlement Amount Sign"},"settlement_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Settlement Currency"},"settlement_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Settlement Date"},"settlement_flag":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Settlement Flag"},"settlement_service_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Settlement Service Id"},"source_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Source Amount"},"source_currency_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Currency Code"},"source_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Identifier"},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Id"},"issuer_country_iso2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuer Country Iso2"},"card_region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Card Region"},"card_country_iso2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Card Country Iso2"},"regional_routing":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Regional Routing"},"account_funding_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Funding Source"}},"type":"object","required":["id","created_at","amount"],"title":"TransactionReportResponse"},"TransactionResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"Unique identifier for the transaction.","example":5280},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp when the transaction was created.","example":"2024-11-20T18:37:47.889787Z"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Timestamp when the transaction was last updated.","example":"2024-11-20T18:37:48.789397Z"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At","description":"Timestamp when the transaction was completed.","example":"2024-11-20T18:37:48.306917Z"},"amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount","description":"The transaction amount.","example":"12.00"},"rrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rrn","description":"Reference Retrieval Number (RRN) for the transaction.","example":"432520994954"},"sale_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sale Reference","description":"Unique sale reference for the transaction.","example":"052934"},"transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Reference","description":"Transaction reference ID.","example":"614237"},"status":{"type":"string","title":"Status","description":"Current status of the transaction.","example":"Approve"},"status_code":{"type":"string","title":"Status Code","description":"Status code for the transaction.","example":"00"},"errors":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Errors","description":"Error details, if any."},"tx_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tx Type","description":"Type of the transaction (e.g., sale, refund).","example":"sale"},"order_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Number","description":"Order number associated with the transaction."},"authorization_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization Code","description":"Authorization code from the host.","example":"026827"},"host_txid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host Txid","description":"Host transaction ID.","example":"432520994954"},"host_response_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host Response Status","description":"Host response status.","example":"Approve"},"host_response_status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host Response Status Code","description":"Host response status code.","example":"00"},"host_amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host Amount","description":"Amount approved by the host.","example":"12.00"},"host_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host Currency","description":"Currency approved by the host.","example":"EUR"},"reversed":{"type":"boolean","title":"Reversed","description":"Indicates if the transaction was reversed.","example":false},"batch_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Batch Id","description":"Batch ID associated with the transaction.","example":293},"card_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Id","description":"Card ID used in the transaction.","example":4665},"currency_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Currency Id","description":"Currency ID used in the transaction.","example":2},"terminal_id":{"type":"integer","title":"Terminal Id","description":"Terminal ID used for the transaction.","example":7},"original_transaction_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Original Transaction Id","description":"ID of the original transaction for linked transactions."},"pan_entry_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pan Entry Mode","description":"PAN (Primary Account Number) entry mode.","example":"MANU"},"calculated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Calculated At","description":"Timestamp when the transaction was calculated.","example":"2024-11-20T18:37:48.789336Z"},"calculated":{"type":"boolean","title":"Calculated","description":"Indicates if the transaction calculation was completed.","example":true},"auth_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Auth Method","description":"Authorization method used for the transaction.","example":"NOCVM"},"entry_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entry Mode","description":"Entry mode of the card."},"system_trace_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"System Trace Number","description":"System trace number for the transaction.","example":"474441"},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Id","description":"Session ID for the transaction.","example":"f50ebee4-9205-4e46-9a5d-d839e29ca26d"},"provider":{"type":"string","title":"Provider","description":"Provider of the transaction (e.g., Visa, Mastercard).","example":"visa"},"velocity_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Velocity Description","description":"Description of the velocity rule triggered, if any."},"velocity_rule_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Velocity Rule Id","description":"ID of the velocity rule triggered."},"terminal_created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Terminal Created At","description":"Terminal timestamp when the transaction was created."},"terminal_local_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Terminal Local Time","description":"Terminal's local time for the transaction."},"mti":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mti","description":"Message Type Indicator (MTI) for the transaction.","example":"0100"},"processing_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Processing Code","description":"Processing code for the transaction.","example":"000000"},"card_acceptor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Card Acceptor Id","description":"Card acceptor ID for the transaction.","example":"LINK4TECH "},"vip_private_usage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vip Private Usage","description":"VIP private usage information.","example":"8000000002"},"custom_payment_service":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Payment Service","description":"Custom payment service information.","example":"8000000000000000E8"},"additional_pos_inf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additional Pos Inf","description":"Additional Point of Sale (POS) information.","example":"0900000005"},"pos_entry_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pos Entry Mode","description":"POS entry mode.","example":"0100"},"icc_data_resp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icc Data Resp","description":"Response from the Integrated Circuit Card (ICC)."},"processing_code_resp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Processing Code Resp","description":"Processing code from the response.","example":"003000"},"custom_payment_service_resp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Payment Service Resp","description":"Response from the custom payment service.","example":"E000020000000000D50304325670685680D5D74040C140"},"icc_data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icc Data","description":"Integrated Circuit Card (ICC) data."},"additional_resp_data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additional Resp Data","description":"Additional response data.","example":"V M 2"},"pos_condition_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pos Condition Mode","description":"POS condition mode.","example":"59"},"vip_private_usage_resp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vip Private Usage Resp","description":"Response for VIP private usage.","example":"8000000002"},"processor_transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Processor Transaction Reference","description":"Processor's transaction reference.","example":"112020374701004744410123432520994954"},"card":{"anyOf":[{"$ref":"#/components/schemas/CardResponse"},{"type":"null"}],"description":"Card details associated with the transaction."}},"type":"object","required":["id","created_at","updated_at","status","status_code","reversed","terminal_id","calculated","provider"],"title":"TransactionResponse"},"TransactionStatusRequest":{"properties":{"transaction_id":{"type":"string","title":"Transaction Id","description":"Processor's transaction reference.","example":"120415164401005769960123433915967345"}},"type":"object","required":["transaction_id"],"title":"TransactionStatusRequest"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VoidRequest":{"properties":{"transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Reference","description":"Merchant internal transaction reference","example":"agg86094-1338-43a0-1ct4-bt913c156030"},"transaction_id":{"type":"string","title":"Transaction Id","description":"The transaction ID from the pre-authorized payment response.","example":"120415164401005769960123433915967345"}},"type":"object","required":["transaction_id"],"title":"VoidRequest"},"VoidResponse":{"properties":{"transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Reference","description":"Merchant internal transaction reference","example":"agg86094-1338-43a0-1ct4-bt913c156030"},"status":{"type":"string","title":"Status","description":"The status of the capture request.","example":"Void success"},"message":{"type":"string","title":"Message","description":"A message describing the result of the capture.","example":"Void successful"},"transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Id","description":"A unique identifier for the transaction.","example":"120415164401005769960123433915967345"},"voided_amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voided Amount","description":"The amount that was captured (as a string).","example":"12.00"},"status_code":{"type":"integer","title":"Status Code","description":"HTTP status code representing the result of the request.","example":200},"processed_at":{"type":"string","format":"date-time","title":"Processed At","description":"Timestamp when the request was processed.","example":"2024-11-18T17:47:21"},"bank_status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Status Code","description":"The status code returned by the bank or payment processor.","example":"12345"},"bank_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Status","description":"The status message returned by the bank or payment processor.","example":"Transaction approved"},"rrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rrn","description":"RRN.Field 37.","example":"607514207399"},"authorization_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization Code","description":"Authorization Code. Field 38","example":"046810"},"system_trace_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"System Trace Number","description":"STAN. Field 11.","example":"207399"},"processing_code_resp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Processing Code Resp","description":"Processing Code Response. Field 3.","example":"003000"},"card_acceptor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Card Acceptor Id","description":"Card Acceptor ID. Field 42.","example":"123490570889 "}},"type":"object","required":["status","message","status_code","processed_at"],"title":"VoidResponse","example":{"authorization_code":"046810","bank_status":"Approved","bank_status_code":"00","card_acceptor_id":"123490570889 ","message":"Void successful","processed_at":"2024-11-18T17:47:21","processing_code_resp":"003000","rrn":"607514207399","status":"success","status_code":200,"system_trace_number":"207399","transaction_id":"120415164401005769960123433915967345","transaction_reference":"agg86094-1338-43a0-1ct4-bt913c156030","voided_amount":"12.00"}},"Wallet":{"type":"string","enum":["google_pay","apple_pay"],"title":"Wallet"},"WebhookCreateRequest":{"properties":{"merchant_identity":{"type":"string","title":"Merchant Identity","description":"Merchant unique identifier.","example":"62552880"},"terminal_identity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Terminal Identity","description":"Terminal unique identifier. Optional, if webhook is configured on terminal level.","example":"11000998"},"url":{"type":"string","minLength":1,"format":"uri","title":"Url","description":"Merchant webhook endpoint URL.","example":"https://merchant.example.com/webhooks/kykeon"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","description":"Event type that will trigger this webhook.","example":"sale"},"is_active":{"type":"boolean","title":"Is Active","description":"If false, webhook will not be called.","default":true,"example":true},"max_retries":{"type":"integer","maximum":10.0,"minimum":0.0,"title":"Max Retries","description":"Maximum number of retry attempts on failure.","default":3,"example":3},"timeout_ms":{"type":"integer","maximum":30000.0,"minimum":500.0,"title":"Timeout Ms","description":"Timeout for webhook HTTP call in milliseconds.","default":3000,"example":3000},"extra_headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Extra Headers","description":"Additional HTTP headers to send with webhook request.","example":{"X-Merchant-Id":"62552880"}},"secret_key":{"anyOf":[{"type":"string","maxLength":128,"minLength":16},{"type":"null"}],"title":"Secret Key","description":"Secret used to sign webhook payloads. If omitted, server may generate it automatically.","example":"c4c99b8c8a8d4b1bb5f5189bd6e23da0"}},"additionalProperties":false,"type":"object","required":["merchant_identity","url","event_type"],"title":"WebhookCreateRequest","example":{"event_type":"sale","extra_headers":{"X-Merchant-Id":"62552880"},"is_active":true,"max_retries":3,"merchant_identity":"62552880","secret_key":"c4c99b8c8a8d4b1bb5f5189bd6e23da0","terminal_identity":"11000998","timeout_ms":3000,"url":"https://merchant.example.com/webhooks/kykeon"}},"WebhookDetails":{"properties":{"webhook_id":{"type":"string","format":"uuid","title":"Webhook Id","description":"Public webhook UUID identifier.","example":"5c8f5e56-46b3-4b37-9b37-7bb4a786c21c"},"merchant_identity":{"type":"string","title":"Merchant Identity","description":"Merchant unique identifier.","example":"62552880"},"terminal_identity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Terminal Identity","description":"Terminal unique identifier.","example":"11000998"},"url":{"type":"string","minLength":1,"format":"uri","title":"Url","description":"Merchant webhook endpoint URL.","example":"https://merchant.example.com/webhooks/kykeon"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","description":"Event type that will trigger this webhook.","example":"sale"},"is_active":{"type":"boolean","title":"Is Active","description":"If false, webhook will not be called.","example":true},"max_retries":{"type":"integer","title":"Max Retries","description":"Maximum number of retry attempts on failure.","example":3},"timeout_ms":{"type":"integer","title":"Timeout Ms","description":"Timeout for webhook HTTP call in milliseconds.","example":3000},"extra_headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Extra Headers","description":"Additional HTTP headers to send with webhook request.","example":{"X-Merchant-Id":"62552880"}},"has_secret_key":{"type":"boolean","title":"Has Secret Key","description":"Indicates whether a secret key exists for this webhook.","example":true},"secret_key_masked":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secret Key Masked","description":"Masked secret key representation.","example":"************************23da0"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Webhook creation timestamp.","example":"2026-03-16T10:15:30Z"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Webhook last update timestamp.","example":"2026-03-16T10:15:30Z"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At","description":"Webhook soft delete timestamp."}},"additionalProperties":false,"type":"object","required":["webhook_id","merchant_identity","url","event_type","is_active","max_retries","timeout_ms","has_secret_key","created_at","updated_at"],"title":"WebhookDetails"},"WebhookEventType":{"type":"string","enum":["sale","reversal","refund","payout","capture","cleared","settled"],"title":"WebhookEventType"},"WebhookOperationResponse":{"properties":{"status":{"type":"string","title":"Status","description":"Human readable operation status.","example":"Webhook created successfully"},"status_code":{"type":"integer","title":"Status Code","description":"HTTP-like status code for operation.","example":200},"webhook_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Webhook Id","description":"Public webhook UUID identifier.","example":"5c8f5e56-46b3-4b37-9b37-7bb4a786c21c"},"webhook":{"anyOf":[{"$ref":"#/components/schemas/WebhookDetails"},{"type":"null"}],"description":"Webhook object for GET/CREATE/UPDATE responses."}},"additionalProperties":false,"type":"object","required":["status","status_code"],"title":"WebhookOperationResponse","example":{"status":"Webhook created successfully","status_code":200,"webhook":{"created_at":"2026-03-16T10:15:30Z","event_type":"sale","extra_headers":{"X-Merchant-Id":"62552880"},"has_secret_key":true,"is_active":true,"max_retries":3,"merchant_identity":"62552880","secret_key_masked":"************************23da0","terminal_identity":"11000998","timeout_ms":3000,"updated_at":"2026-03-16T10:15:30Z","url":"https://merchant.example.com/webhooks/kykeon","webhook_id":"5c8f5e56-46b3-4b37-9b37-7bb4a786c21c"},"webhook_id":"5c8f5e56-46b3-4b37-9b37-7bb4a786c21c"}},"WebhookUpdateRequest":{"properties":{"terminal_identity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Terminal Identity","description":"Terminal unique identifier. Set null or omit to keep merchant-level webhook.","example":"11000998"},"url":{"anyOf":[{"type":"string","minLength":1,"format":"uri"},{"type":"null"}],"title":"Url","description":"Merchant webhook endpoint URL.","example":"https://merchant.example.com/webhooks/kykeon-updated"},"event_type":{"anyOf":[{"$ref":"#/components/schemas/WebhookEventType"},{"type":"null"}],"description":"Event type that will trigger this webhook.","example":"refund"},"secret_key":{"anyOf":[{"type":"string","maxLength":128,"minLength":16},{"type":"null"}],"title":"Secret Key","description":"Secret used to sign webhook payloads.","example":"a9f12b7c28d74d17aa59cbb8f129f000"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"If false, webhook will not be called.","example":false},"max_retries":{"anyOf":[{"type":"integer","maximum":10.0,"minimum":0.0},{"type":"null"}],"title":"Max Retries","description":"Maximum number of retry attempts on failure.","example":5},"timeout_ms":{"anyOf":[{"type":"integer","maximum":30000.0,"minimum":500.0},{"type":"null"}],"title":"Timeout Ms","description":"Timeout for webhook HTTP call in milliseconds.","example":5000},"extra_headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Extra Headers","description":"Additional HTTP headers to send with webhook request.","example":{"X-Environment":"uat"}}},"additionalProperties":false,"type":"object","title":"WebhookUpdateRequest"},"models__posauth__CardData":{"properties":{"cardNumber":{"type":"string","title":"Cardnumber","description":"Encrypted Card Number.","example":"01953DF283F036CDCF090186799717ED"},"expDate":{"type":"string","title":"Expdate","description":"Card expiration date (YYMM).","example":"3112"},"track2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Track2","description":"Track 2 data.","example":"01953DF283F036CD26B28526387E1D01F195FF3D59E8B570"},"ksn":{"type":"string","title":"Ksn","description":"KSN.","example":"1044201196FC40001129"},"onlinePinBlock":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Onlinepinblock","description":"Online PIN Block.","example":"CD691D810F86939F"},"mskdPAN":{"type":"string","title":"Mskdpan","description":"Masked PAN.","example":"417666******0034"},"cardSeqNum":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cardseqnum","description":"Card Sequence Number (4 digits).","example":"0003"},"cardCtryCd":{"type":"string","title":"Cardctrycd","description":"Card Country Code (iso 3 digits).","example":"196"},"cardCcyCd":{"type":"string","title":"Cardccycd","description":"Card Currency Code (iso 3 digits).","example":"978"},"cardBrnd":{"type":"string","title":"Cardbrnd","description":"Card Brand.","example":"VISA CREDIT"}},"type":"object","required":["cardNumber","expDate","ksn","mskdPAN","cardCtryCd","cardCcyCd","cardBrnd"],"title":"CardData"},"models__posauth__MerchantData":{"properties":{"mId":{"type":"string","title":"Mid","description":"Merchant ID","example":"62552880"},"tId":{"type":"string","title":"Tid","description":"Terminal ID","example":"11000998"}},"type":"object","required":["mId","tId"],"title":"MerchantData"},"models__posauth__TerminalReqData":{"properties":{"entryMode":{"type":"string","title":"Entrymode","description":"PAN Entry mode","example":"071"},"icc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icc","description":"ICC data.","example":"NUYyQTAyMDk3ODVGMzQwMTAzODIwMjIwMDA4NDA3QTAwMDAwMDAwMzEwMTA5NTA1MDAwMDAwMDAwMDlBMDMyNTAyMDQ5QzAxMDA5RjAyMDYwMDAwMDAwMDE1MDA5RjA5MDIwMDk2OUYxMDIwMUYyMjAxMDBBMDAwMDAwMDAwNTY0OTUzNDE0QzMzNTQ0NTUzNTQ0MzQxNTM0NTAwMDAwMDAwMDAwMDAwMDAwMDlGMUEwMjAxOTY5RjI2MDgyOEQwMzYwNjhBODZFMDlCOUYyNzAxODA5RjMzMDM2MEQ4Qzg5RjM0MDMzRjAwMDI5RjM1MDEyNDlGMzYwMjAwMDI5RjM3MDRBRkQ1MzI1MjlGNDAwNTYwMDBGMDEwMDE5RjZFMDQyMDcwMDAwMA=="},"keyId":{"type":"string","title":"Keyid","description":"Key ID.","example":"0001"}},"type":"object","required":["entryMode","keyId"],"title":"TerminalReqData"},"models__posauth_refund__CardData":{"properties":{"cardNumber":{"type":"string","title":"Cardnumber","description":"Encrypted Card Number.","example":"01953DF283F036CDCF090186799717ED"},"expDate":{"type":"string","title":"Expdate","description":"Card expiration date (MMYY).","example":"3112"},"track2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Track2","description":"Track 2 data.","example":"01953DF283F036CD26B28526387E1D01F195FF3D59E8B570"},"ksn":{"type":"string","title":"Ksn","description":"KSN.","example":"1044201196FC40001129"},"mskdPAN":{"type":"string","title":"Mskdpan","description":"Masked PAN.","example":"417666******0034"},"cardSeqNum":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cardseqnum","description":"Card Sequence Number.","example":"0003"},"cardCtryCd":{"type":"string","title":"Cardctrycd","description":"Card Country Code.","example":"196"},"cardCcyCd":{"type":"string","title":"Cardccycd","description":"Card Currency Code.","example":"978"},"cardBrnd":{"type":"string","title":"Cardbrnd","description":"Card Brand.","example":"VISA CREDIT"}},"type":"object","required":["cardNumber","expDate","ksn","mskdPAN","cardSeqNum","cardCtryCd","cardCcyCd","cardBrnd"],"title":"CardData"},"models__posauth_refund__MerchantData":{"properties":{"mId":{"type":"string","title":"Mid","description":"Merchant ID.","example":"62552880"},"tId":{"type":"string","title":"Tid","description":"Terminal ID.","example":"11000998"}},"type":"object","required":["mId","tId"],"title":"MerchantData"},"models__posauth_reversal__CardData":{"properties":{"cardNumber":{"type":"string","title":"Cardnumber","description":"Encrypted Card Number.","example":"01953DF283F036CDCF090186799717ED"},"expDate":{"type":"string","title":"Expdate","description":"Card expiration date (MMYY).","example":"3112"},"track2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Track2","description":"Track 2 data.","example":"01953DF283F036CD26B28526387E1D01F195FF3D59E8B570"},"ksn":{"type":"string","title":"Ksn","description":"KSN.","example":"1044201196FC40001129"},"mskdPAN":{"type":"string","title":"Mskdpan","description":"Masked PAN.","example":"417666******0034"},"cardSeqNum":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cardseqnum","description":"Card Sequence Number.","example":"0003"},"cardCtryCd":{"type":"string","title":"Cardctrycd","description":"Card Country Code.","example":"196"},"cardCcyCd":{"type":"string","title":"Cardccycd","description":"Card Currency Code.","example":"978"},"cardBrnd":{"type":"string","title":"Cardbrnd","description":"Card Brand.","example":"VISA CREDIT"}},"type":"object","required":["cardNumber","expDate","ksn","mskdPAN","cardCtryCd","cardCcyCd","cardBrnd"],"title":"CardData"},"models__posauth_reversal__MerchantData":{"properties":{"mId":{"type":"string","title":"Mid","description":"Merchant ID.","example":"62552880"},"tId":{"type":"string","title":"Tid","description":"Terminal ID.","example":"11000998"}},"type":"object","required":["mId","tId"],"title":"MerchantData"},"models__posauth_reversal__TerminalReqData":{"properties":{"entryMode":{"type":"string","title":"Entrymode","description":"PAN Entry mode.","example":"071"},"keyId":{"type":"string","title":"Keyid","description":"Key ID.","example":"0001"}},"type":"object","required":["entryMode","keyId"],"title":"TerminalReqData"},"models__posoct__CardData":{"properties":{"cardNumber":{"type":"string","title":"Cardnumber","description":"Encrypted Card Number.","example":"01953DF283F036CDCF090186799717ED"},"expDate":{"type":"string","title":"Expdate","description":"Card expiration date (YYMM).","example":"3112"},"track2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Track2","description":"Track 2 data.","example":"01953DF283F036CD26B28526387E1D01F195FF3D59E8B570"},"ksn":{"type":"string","title":"Ksn","description":"KSN.","example":"1044201196FC40001129"},"mskdPAN":{"type":"string","title":"Mskdpan","description":"Masked PAN.","example":"417666******0034"},"cardSeqNum":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cardseqnum","description":"Card Sequence Number (4 digits).","example":"0003"},"cardCtryCd":{"type":"string","title":"Cardctrycd","description":"Card Country Code (iso 3 digits).","example":"196"},"cardCcyCd":{"type":"string","title":"Cardccycd","description":"Card Currency Code (iso 3 digits).","example":"978"},"cardBrnd":{"type":"string","title":"Cardbrnd","description":"Card Brand.","example":"VISA CREDIT"}},"type":"object","required":["cardNumber","expDate","ksn","mskdPAN","cardCtryCd","cardCcyCd","cardBrnd"],"title":"CardData"},"models__posoct__MerchantData":{"properties":{"mId":{"type":"string","title":"Mid","description":"Merchant ID","example":"62552880"},"tId":{"type":"string","title":"Tid","description":"Terminal ID","example":"11000998"}},"type":"object","required":["mId","tId"],"title":"MerchantData"},"models__posoct__TerminalReqData":{"properties":{"entryMode":{"type":"string","title":"Entrymode","description":"PAN Entry mode","example":"071"},"icc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icc","description":"ICC data.","example":"NUYyQTAyMDk3ODVGMzQwMTAzODIwMjIwMDA4NDA3QTAwMDAwMDAwMzEwMTA5NTA1MDAwMDAwMDAwMDlBMDMyNTAyMDQ5QzAxMDA5RjAyMDYwMDAwMDAwMDE1MDA5RjA5MDIwMDk2OUYxMDIwMUYyMjAxMDBBMDAwMDAwMDAwNTY0OTUzNDE0QzMzNTQ0NTUzNTQ0MzQxNTM0NTAwMDAwMDAwMDAwMDAwMDAwMDlGMUEwMjAxOTY5RjI2MDgyOEQwMzYwNjhBODZFMDlCOUYyNzAxODA5RjMzMDM2MEQ4Qzg5RjM0MDMzRjAwMDI5RjM1MDEyNDlGMzYwMjAwMDI5RjM3MDRBRkQ1MzI1MjlGNDAwNTYwMDBGMDEwMDE5RjZFMDQyMDcwMDAwMA=="},"keyId":{"type":"string","title":"Keyid","description":"Key ID.","example":"0001"}},"type":"object","required":["entryMode","keyId"],"title":"TerminalReqData"},"models__tap_relay__LocalTotalsBeforeTxn__1":{"properties":{"host":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host"},"host_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host Class"}},"additionalProperties":true,"type":"object","title":"LocalTotalsBeforeTxn"},"models__tap_relay__LocalTotalsBeforeTxn__2":{"properties":{"host":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host"},"host_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host Class"}},"additionalProperties":true,"type":"object","title":"LocalTotalsBeforeTxn","description":"This object is huge and may evolve.\nTo keep it robust, we accept extra fields."}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-KEY"}}},"tags":[{"name":"E-commerce payment","description":"Operations for e-commerce flows."},{"name":"POS payment","description":"Operations for POS / in-store flows."},{"name":"Tokenization","description":"Tokenization."},{"name":"Webhooks","description":"Subscribe Webhooks."},{"name":"TapRelay","description":"POS TapRelay."},{"name":"Helper","description":"Auxiliary endpoints (health, utils, etc.)."},{"name":"Reports","description":"Reporting & reconciliation endpoints."},{"name":"Error Codes","description":"Catalog of issuer/network response codes for testing."}]}