Saferpay

https://docs.saferpay.com
Admin
Saferpay is a modern and secure payment service provider that enables businesses to process domestic...
Tokens:254,127
Snippets:1,951
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Query documentation via HTTP GET

Source: https://docs.saferpay.com/home/integration-guide/general-information/versioning.md

Perform an HTTP GET request on the current page URL with the 'ask' query parameter and an optional 'goal' parameter to retrieve information.

```http
GET https://docs.saferpay.com/home/integration-guide/general-information/versioning.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Saferpay Fields placeholders option object example

Source: https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/saferpay-fields.md

Shows an example configuration of the placeholders object for custom input placeholder text in the Saferpay Fields init() method.

```json
placeholders: {
    //Custom Text for Input placeholders
    holdername: 'Card holder',
    cardnumber: '0000 0000 0000 0000',
    expiration: 'MM/YY',
    cvc: 'CVC'
},
```

--------------------------------

### Fixed installment plan response

Source: https://docs.saferpay.com/home/integration-guide/payment-methods/mastercard.md

Example of a fixed installment plan response from Saferpay. The issuer may propose one or more fixed plans, returned as an array of JSON objects inside the MastercardIssuerInstallments.InstallmentPlans container. The example shows two plans with different installment counts and amounts.

```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 with ask and goal parameters

Source: https://docs.saferpay.com/home/integration-guide/payment-methods/mastercard.md

Use this HTTP GET request to query the documentation dynamically when the answer is not explicitly present on the current page. The `ask` parameter is required and should be a specific, self-contained question; the optional `goal` parameter describes the broader end goal. The response contains a direct answer with relevant excerpts and sources.

```http
GET https://docs.saferpay.com/home/integration-guide/payment-methods/mastercard.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query documentation index with ask and goal parameters

Source: https://docs.saferpay.com/home/integration-guide/fraud-intelligence

Use this HTTP GET request to query the documentation index with the 'ask' parameter (required) and the optional 'goal' parameter. The 'ask' value should be a specific, self-contained natural-language question; 'goal' describes the broader end goal. The response contains a direct answer with relevant excerpts and sources.

```http
GET https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/fraud-intelligence.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### Custom installment plan response

Source: https://docs.saferpay.com/home/integration-guide/payment-methods/mastercard.md

Example of a custom installment plan response. The card holder can choose the number of installments within the boundaries given by the issuer. The MastercardIssuerInstallments.CustomPlan container is returned with minimum and maximum installment counts, interest rate, fees, and total amount due.

```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"
  }
}
```

--------------------------------

### GET request to query transactions with filters

Source: https://docs.saferpay.com/home/interfaces/management-api.md

Example URL for the TransactionReporting GetTransactions request. It retrieves SUCCESSFUL transactions for a given CustomerId and TerminalId within a date range, with paging parameters. Note that all filters are optional and have default values.

```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
```

--------------------------------

### Submit chosen installment plan in Capture request

Source: https://docs.saferpay.com/home/integration-guide/payment-methods/mastercard.md

Send this JSON in the Capture request to submit the chosen installment plan to Saferpay. The plan data must be provided through the MastercardIssuerInstallments container. After capture, the merchant immediately receives the money while the card holder's bank handles the installment.

```json
{  
  "MastercardIssuerInstallments": {
    "ChosenPlan": {
      "NumberOfInstallments": 12,
      "InterestRate": "1100",
      "InstallmentFee": {
        "Value": "1200",
        "CurrencyCode": "CHF"
      },
      "AnnualPercentageRate": "600",
      "TotalAmountDue": {
        "Value": "1190000",
        "CurrencyCode": "CHF"
      }
    }
  }
}
```
Tokens:
Raw