### Query Documentation via GET Request Source: https://docs.saferpay.com/home/interfaces/secure-paygate Use this GET request to query the documentation index with a specific question. The response includes direct answers and relevant excerpts. ```http GET https://docs.saferpay.com/home/interfaces/backoffice/secure-paygate.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/transaction-interface/recurring-payments Use this method to perform an HTTP GET request on the current page URL with the `ask` query parameter to retrieve specific information or clarifications from the documentation. ```http GET https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/transaction-interface/recurring-payments.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://docs.saferpay.com/home/integration-guide/payment-methods/click-to-pay Perform an HTTP GET request to the current page URL with the 'ask' query parameter to dynamically query the documentation. The question should be specific and self-contained. ```http GET https://docs.saferpay.com/home/integration-guide/payment-methods/click-to-pay.md?ask= ``` -------------------------------- ### Querying Documentation Dynamically Source: https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/saferpay-fields To get more information not directly on the page, make a GET request to the page URL with an 'ask' query parameter containing your question. ```http GET https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/saferpay-fields.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://docs.saferpay.com/home/integration-guide/payment-methods/applepay Perform an HTTP GET request to query documentation dynamically. Use the `ask` query parameter with a specific, self-contained question in natural language. ```HTTP GET https://docs.saferpay.com/home/integration-guide/payment-methods/applepay.md?ask= ``` -------------------------------- ### Batch Transaction Data Examples Source: https://docs.saferpay.com/home/interfaces/backoffice/batch-processing These examples demonstrate various formats for batch transaction data, including authorization, refunds, card references, and direct debits. Note the specific formatting requirements for amounts and card data. ```text ICCT100,94913159,TEST1,9451123100000004,12,15,M,1000,EUR,,0,1,20120202165533 ``` ```text ICCT100,94913159,TEST2,9451123100000004,12,15,M,550,EUR,,0,1,20120202165534,442 ``` ```text ICCT100,94913159,TEST3,9451123100000004,12,15,M,105.00,EUR,,0,1,201202021655 ``` ```text ICCT100,94913159,TEST4,4000000000000002,12,2015,M,1050,EUR,,1,1,201202021656 ``` ```text ICCT100,94913159,TEST5,5232000000000017,12,2015,M,1120,EUR,,0,1,201202021500,,1,AAABCEkCYQABA314UQJhAAAAAAA=,DmZAXgVCNWAOAQN3AwAFWgN9CQM= ``` ```text ICCT100,94913159,TEST6,375811111111115,12,10,M,1000,EUR,,0,1,201202021656 ``` ```text ICCT100,94913159,TEST7,CARDREFID:1234567890,02,15,M,670,EUR,,0,1,201202021658 ``` ```text ICCT100,94913159,TEST8,,,M,1009,EUR,,0,1,201202021659,,,,,,MyMandateID,DE77970000010123456789 ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/transaction-interface To get additional information not directly present on the page, perform an HTTP GET request with the 'ask' query parameter. The response will include a direct answer and relevant excerpts. ```http GET https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/transaction-interface.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.saferpay.com/home/integration-guide/saferpay-demo Use this GET request to query the documentation with a specific question. The response will include an answer and relevant excerpts. ```http GET https://docs.saferpay.com/home/integration-guide/saferpay-demo.md?ask= ``` -------------------------------- ### Query Transactions via GET Request Source: https://docs.saferpay.com/home/interfaces/management-api Retrieve transaction information using a GET request to the transactions endpoint. This example demonstrates filtering by date, page size, transaction state, and terminal ID. Ensure compliance with API usage rules, such as avoiding parallel requests and limiting query scope. ```url GET: https://test.saferpay.com/api/rest/customers/123456/transactions?EndDate=2025-09-09T12:49&StartDate=2025-09-01T12:49&PageSize=1200&PageNumber=1&TransactionState=SUCCESSFUL&TerminalId=17654321 ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.saferpay.com/home/interfaces/backoffice/transactions/pending-authorizations Perform an HTTP GET request to query the documentation. Use the `ask` query parameter with a specific, self-contained question in natural language. The response includes the answer and relevant excerpts. ```http GET https://docs.saferpay.com/home/interfaces/backoffice/transactions/pending-authorizations.md?ask= ``` -------------------------------- ### PayPal Transaction Error: Missing Permissions Source: https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/error-handling This error occurs when Saferpay lacks the necessary permissions to perform transactions on your PayPal account, typically due to incorrect PayPal setup. Ensure PayPal is configured as per the Saferpay integration guide. ```json { "ResponseHeader": { "SpecVersion": "[CURRENT SPECVERSION]", "RequestId": "[YOUR REQUESTID]" }, "Behavior": "DO_NOT_RETRY", "ErrorName": "TRANSACTION_DECLINED", "ErrorMessage": "Transaction declined by acquirer", "TransactionId": "[TransactionId]", "ErrorDetail":[ "Check that PayPal was setup as described in the Saferpay integration guide for the PayPal payment method." ], "ProcessorName": "PayPal", "ProcessorResult": "invalid_request", "ProcessorMessage": "No permission to set target_client_id", "OrderId": "[YOUR ORDERID]" } ``` -------------------------------- ### Mastercard Custom Installment Plan Response Source: https://docs.saferpay.com/home/integration-guide/payment-methods/mastercard This JSON structure represents a custom installment plan where the cardholder can choose the number of installments, returned in the authorization response. ```json { "MastercardIssuerInstallments": { "CustomPlan": { "MinimumNumberOfInstallments": 3, "MaximumNumberOfInstallments": 37, "InterestRate": "1100", "InstallmentFee": { "Value": "1200", "CurrencyCode": "CHF" }, "AnnualPercentageRate": "600", "TotalAmountDue": { "Value": "1190000", "CurrencyCode": "CHF" } }, "ReceiptFreeText": "Some dummy receipt free text" } } ``` -------------------------------- ### Querying Documentation Dynamically Source: https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/error-handling/processor-specific-error-codes Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific, self-contained, and written in natural language. The response will contain a direct answer and relevant excerpts. ```http GET https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/error-handling/processor-specific-error-codes.md?ask= ``` -------------------------------- ### Querying Documentation via HTTP GET Source: https://docs.saferpay.com/home/integration-guide/introduction To get additional information not directly on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and in natural language. ```http GET https://docs.saferpay.com/home/integration-guide/introduction.md?ask= ``` -------------------------------- ### Capture Response Example Source: https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/transaction-interface/refunds This is an example of a successful capture response, which contains the CaptureId required for referenced refunds. ```json { "ResponseHeader": { "SpecVersion": "[CURRENT SPEC_VERSION]", "RequestId": "d66252aacafc19161333916ba87601e5" }, "CaptureId": "W6ttz4AQMIM2tAhI2llEA0E5xCzb_c", "Status": "CAPTURED", "Date": "2021-07-09T11:48:02.462+02:00" } ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.saferpay.com/home/integration-guide/general-information/dynamic-currency-conversion Perform an HTTP GET request to the current page URL with the `ask` query parameter to ask a question about the documentation. The question should be specific and in natural language. ```HTTP GET https://docs.saferpay.com/home/integration-guide/general-information/dynamic-currency-conversion.md?ask= ``` -------------------------------- ### Query Documentation with GET Request Source: https://docs.saferpay.com/home/interfaces/payment-api To get additional information not directly present on a page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and self-contained. The response will include a direct answer and relevant excerpts. ```http GET https://docs.saferpay.com/home/interfaces/payment-api.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/fraud-intelligence/fraud-intelligence Perform an HTTP GET request on the current page URL with the `ask` query parameter to get dynamic answers and relevant excerpts from the documentation. Use this when the answer is not explicitly present on the page, you need clarification, or want to retrieve related documentation sections. ```HTTP GET https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/fraud-intelligence/fraud-intelligence.md?ask= ``` -------------------------------- ### Capture Request with Chosen Installment Plan Source: https://docs.saferpay.com/home/integration-guide/payment-methods/mastercard This JSON structure is used in the Capture request to specify the installment plan chosen by the cardholder. ```json { "MastercardIssuerInstallments": { "ChosenPlan": { "NumberOfInstallments": 12, "InterestRate": "1100", "InstallmentFee": { "Value": "1200", "CurrencyCode": "CHF" }, "AnnualPercentageRate": "600", "TotalAmountDue": { "Value": "1190000", "CurrencyCode": "CHF" } } } } ``` -------------------------------- ### Mastercard Fixed Installment Plan Response Source: https://docs.saferpay.com/home/integration-guide/payment-methods/mastercard This JSON structure represents a fixed installment plan offered by the issuer, returned in the authorization response. ```json { "MastercardIssuerInstallments": { "InstallmentPlans": [ { "NumberOfInstallments": 12, "InterestRate": "1000", "InstallmentFee": { "Value": "1000", "CurrencyCode": "CHF" }, "AnnualPercentageRate": "500", "FirstInstallmentAmount": { "Value": "100000", "CurrencyCode": "CHF" }, "SubsequentInstallmentAmount": { "Value": "180000", "CurrencyCode": "CHF" }, "TotalAmountDue": { "Value": "1180000", "CurrencyCode": "CHF" } }, { "NumberOfInstallments": 6, "InterestRate": "1000", "InstallmentFee": { "Value": "1000", "CurrencyCode": "CHF" }, "AnnualPercentageRate": "500", "FirstInstallmentAmount": { "Value": "100000", "CurrencyCode": "CHF" }, "SubsequentInstallmentAmount": { "Value": "360000", "CurrencyCode": "CHF" }, "TotalAmountDue": { "Value": "1180000", "CurrencyCode": "CHF" } } ], "ReceiptFreeText": "Some dummy receipt free text" } } ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.saferpay.com/home/integration-guide/payment-methods/twint Perform an HTTP GET request to query the documentation dynamically. Use the `ask` query parameter with a specific, self-contained question in natural language. The response will contain a direct answer and relevant excerpts. ```http GET https://docs.saferpay.com/home/integration-guide/payment-methods/twint.md?ask= ``` -------------------------------- ### Transaction Inquire Successful Response Example Source: https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/inquire-interface This is an example of a successful response when inquiring about a transaction. It includes details about the transaction, payment means, payer, and liability. ```json { "ResponseHeader": { "SpecVersion": "[CURRENT SPEC_VERSION]", "RequestId": "f7ca9af6c203c055ec50b6dcc2a40831" }, "Transaction": { "Type": "PAYMENT", "Status": "CAPTURED", "Id": "fn7O7nAIQWKMSAbIdnC3A26SMUpA", "CaptureId": "fn7O7nAIQWKMSAbIdnC3A26SMUpA", "Date": "2019-05-17T12:44:14.097+02:00", "Amount": { "Value": "245", "CurrencyCode": "EUR" }, "OrderId": "0", "AcquirerName": "VISA Saferpay Test", "AcquirerReference": "84050331349", "SixTransactionReference": "0:0:3:fn7O7nAIQWKMSAbIdnC3A26SMUpA", "ApprovalCode": "586216" }, "PaymentMeans": { "Brand": { "PaymentMethod": "VISA", "Name": "VISA" }, "DisplayText": "xxxx xxxx xxxx 0004", "Card": { "MaskedNumber": "xxxxxxxxxxxx0004", "ExpYear": 2019, "ExpMonth": 5, "HolderName": "Yamada Taro", "CountryCode": "JP" } }, "Payer": { "IpAddress": "178.15.222.100", "IpLocation": "DE" }, "Liability": { "LiabilityShift": true, "LiableEntity": "ThreeDs", "ThreeDs": { "Authenticated": true, "LiabilityShift": true, "Xid": "HVQOUwEUJnYaBAM7BCQDNAofGgg=" } }, "Dcc": { "PayerAmount": { "Value": "352", "CurrencyCode": "JPY" } } } ``` -------------------------------- ### Perform HTTP GET Request with 'ask' Parameter Source: https://docs.saferpay.com/home/master/payment-methods-and-acquirers Use this method to query documentation dynamically. The question should be specific and in natural language. The response includes direct answers and relevant excerpts. ```http GET https://docs.saferpay.com/home/master/payment-methods-and-acquirers.md?ask= ```