Management

This method is used to retrieve a list of transactions based on the provided criteria.

get

Authorizations

Authorization

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Path parameters

customerIdinteger · int32Required

The CustomerId defined as part of the route.

Query parameters

TransactionStatestring | nullableOptional

State of the transactions to be retrieved. If left empty successful transactions are retrieved.

TerminalIdinteger · int32 | nullableOptional

ID of the terminal the transactions should be retrieved for. If left empty, all terminals of the customer will be considered.

StartDatestring | nullableRequired

Only transactions happened later than this date will be returned. Value can be provided in ISO 8601 format only using the date (yyyy-MM-dd) or as a date time (yyyy-MM-ddTHH:mm).

EndDatestring | nullableRequired

Only transactions that occurred before this date will be returned. EndDate must be less than today at 00:00 (midnight). For example, to retrieve transactions up to and including yesterday, set EndDate to yesterday at 23:59. Value can be provided in ISO 8601 format only using the date (yyyy-MM-dd) or as a date time (yyyy-MM-ddTHH:mm).

PageSizeinteger · int32 | nullableOptional

Maximum number of transactions to be returned. If left empty, the default value of 1000 will be used. A maximum of 2000 transactions can be requested at once. Please always make sure to check PageSize in the response as Saferpay reserves the right to shrink large page sizes to a reasonable value.

PageNumberinteger · int32 | nullableOptional

Number of the page to be returned, starting from 1. Values smaller than 1 will be automatically set to 1. Previous pages will be skipped. If left empty, the first page will be returned.

Header parameters

Saferpay-ApiVersionanyRequired

Saferpay-RequestIdanyRequired

Body

application/json

anyOptional

Responses

200Success

application/json

Responseone of | nullable

get

/rest/customers/{customerId}/transactions

HTTPcURLJavaScriptPython

GET /Api/rest/customers/{customerId}/transactions?StartDate=text&EndDate=text HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*

200Success

{
  "PageNumber": 0,
  "PageSize": 100,
  "TotalTransactions": 1,
  "Transactions": [
    {
      "MerchantAmount": "5.00",
      "MerchantCurrency": "EUR",
      "CustomerId": 123456,
      "TerminalId": 1000001,
      "TerminalType": "ECOM",
      "Application": "Saferpay Payment Page",
      "TransactionId": "j8nCKMAr5bptUApfdp1MbEQpMpSb",
      "OrderId": "6a9bb0cd6ec841698ae375e981002af5",
      "Provider": "PayPal",
      "PaymentMethod": "PayPal",
      "IpAddress": "10.153.83.132",
      "Description": "Test Transaction",
      "AuthorizationDetails": {
        "AuthorizationDate": "2025-08-14T12:41:30.618",
        "LastActionDate": "2025-08-14T12:41:30.618",
        "Type": "PAYMENT",
        "State": "AUTHORIZED",
        "CapturedMerchantAmount": "3.00",
        "HasCVC": false,
        "HasLiabilityShift": false,
        "ProcessingAuthCode": "4887bffc-6b5f-4acc-a9d9-1c4e812eaa68",
        "AuthorizedBy": "API_123456_10592483",
        "HasCurrencyConversion": false,
        "PayerCurrency": "EUR",
        "PayerAmount": "5.00",
        "IsCaptured": false,
        "HasPartialCaptures": false,
        "IsRefunded": false,
        "IsCancelled": false,
        "IsOmniChannel": false
      }
    }
  ]
}

This method is used to retrieve all terminals

get

Authorizations

Authorization

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Path parameters

customerIdinteger · int32Required

Header parameters

Saferpay-ApiVersionanyRequired

Saferpay-RequestIdanyRequired

Body

application/json

anyOptional

Responses

200Success

application/json

Responseone of | nullable

get

/rest/customers/{customerId}/terminals

HTTPcURLJavaScriptPython

GET /Api/rest/customers/{customerId}/terminals HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*

200Success

{
  "Terminals": [
    {
      "TerminalId": "1000001",
      "Type": "ECOM",
      "Description": "Terminal 1 for Payment Page / Ecommerce"
    },
    {
      "TerminalId": "1000002",
      "Type": "MPO",
      "Description": "Terminal 2 for Mail Phone Order"
    },
    {
      "TerminalId": "1000002",
      "Type": "SPG",
      "Description": "Terminal 3 for Secure Pay Gate"
    }
  ]
}

DEPRECATED: since Version 1.31. Please use instead: /rest/customers/{customerId}/terminals/{terminalId}/ This method is used to retrieve a list of all available payment methods and wallets for a terminal.

get

Authorizations

Authorization

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Path parameters

terminalIdinteger · int32Required

Header parameters

Saferpay-ApiVersionanyRequired

Saferpay-RequestIdanyRequired

Body

application/json

anyOptional

Responses

200Success

application/json

Responseone of | nullable

get

/rest/customers/{customerId}/terminals/{terminalId}/payment-methods

HTTPcURLJavaScriptPython

GET /Api/rest/customers/{customerId}/terminals/{terminalId}/payment-methods HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*

200Success

{
  "PaymentMethods": [
    {
      "PaymentMethod": "VISA",
      "Currencies": [
        "USD"
      ],
      "LogoUrl": "https://www.saferpay.com/static/logo/visa.svg?v=637381079349290910"
    },
    {
      "PaymentMethod": "MASTERCARD",
      "Currencies": [
        "EUR",
        "CHF"
      ],
      "LogoUrl": "https://www.saferpay.com/static/logo/mastercard.svg?v=637381079349290910"
    },
    {
      "PaymentMethod": "MAESTRO",
      "Currencies": [
        "EUR"
      ],
      "LogoUrl": "https://www.saferpay.com/static/logo/maestro.svg?v=637381079349290910"
    },
    {
      "PaymentMethod": "PAYPAL",
      "Currencies": [
        "EUR",
        "CHF",
        "USD"
      ],
      "LogoUrl": "https://www.saferpay.com/static/logo/paypal.svg?v=637381079349290910"
    }
  ],
  "Wallets": [
    {
      "WalletName": "APPLEPAY",
      "LogoUrl": "https://www.saferpay.com/static/logo/applepay.svg?v=637381079349290910"
    },
    {
      "WalletName": "GOOGLEPAY",
      "LogoUrl": "https://www.saferpay.com/static/logo/googlepay.svg?v=637381079349290910"
    }
  ]
}

This method is used to retrieve details of one terminal

get

Authorizations

Authorization

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Path parameters

customerIdinteger · int32Required

terminalIdinteger · int32Required

Header parameters

Saferpay-ApiVersionanyRequired

Saferpay-RequestIdanyRequired

Body

application/json

anyOptional

Responses

200Success

application/json

Responseone of | nullable

get

/rest/customers/{customerId}/terminals/{terminalId}

HTTPcURLJavaScriptPython

GET /Api/rest/customers/{customerId}/terminals/{terminalId} HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*

200Success

{
  "TerminalId": "1000001",
  "Type": "ECOM",
  "Description": "Terminal 1 for Payment Page / Ecommerce",
  "PaymentMethods": [
    {
      "PaymentMethod": "VISA",
      "Currencies": [
        "USD"
      ],
      "LogoUrl": "https://www.saferpay.com/static/logo/visa.svg?v=637381079349290910"
    },
    {
      "PaymentMethod": "MASTERCARD",
      "Currencies": [
        "EUR",
        "CHF"
      ],
      "LogoUrl": "https://www.saferpay.com/static/logo/mastercard.svg?v=637381079349290910"
    },
    {
      "PaymentMethod": "MAESTRO",
      "Currencies": [
        "EUR"
      ],
      "LogoUrl": "https://www.saferpay.com/static/logo/maestro.svg?v=637381079349290910"
    },
    {
      "PaymentMethod": "PAYPAL",
      "Currencies": [
        "EUR",
        "CHF",
        "USD"
      ],
      "LogoUrl": "https://www.saferpay.com/static/logo/paypal.svg?v=637381079349290910"
    }
  ],
  "Wallets": [
    {
      "WalletName": "APPLEPAY",
      "LogoUrl": "https://www.saferpay.com/static/logo/applepay.svg?v=637381079349290910"
    },
    {
      "WalletName": "GOOGLEPAY",
      "LogoUrl": "https://www.saferpay.com/static/logo/googlepay.svg?v=637381079349290910"
    }
  ]
}

This function may be used to create a single use payment link

post

Authorizations

Authorization

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Path parameters

customerIdinteger · int32Required

terminalIdinteger · int32Required

Header parameters

Saferpay-ApiVersionanyRequired

Saferpay-RequestIdanyRequired

Body

application/json

Responses

200Success

application/json

Responseone of | nullable

post

/rest/customers/{customerId}/terminals/{terminalId}/spg-offers

HTTPcURLJavaScriptPython

POST /Api/rest/customers/{customerId}/terminals/{terminalId}/spg-offers HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 403

{
  "Payment": {
    "Amount": {
      "Value": "404",
      "CurrencyCode": "CHF"
    },
    "OrderId": "094c2a7ce1374f7ca184591f123b154d",
    "Options": {
      "PreAuth": true
    }
  },
  "ExpirationDate": "2020-04-23T00:00:00+02:00",
  "Payer": {
    "LanguageCode": "de",
    "BillingAddress": {
      "FirstName": "John",
      "LastName": "Doe",
      "Company": "Worldline",
      "Gender": "MALE",
      "Street": "Mustergasse 123",
      "Zip": "8008",
      "City": "Zurich",
      "CountryCode": "CH",
      "Email": "[email protected]"
    }
  }
}

200Success

{
  "OfferId": "503a3d7b-072b-400f-9e7e-8ec15191c737",
  "PaymentLink": "https://www.saferpay.com/SecurePayGate/Payment/123456/12345678/503a3d7b-072b-400f-9e7e-8ec15191c737"
}

This function may be used to fetch the status of a previously created single use payment link

get

Authorizations

Authorization

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Path parameters

customerIdinteger · int32Required

terminalIdinteger · int32Required

offerIdstring · guidRequired

Header parameters

Saferpay-ApiVersionanyRequired

Saferpay-RequestIdanyRequired

Body

application/json

anyOptional

Responses

200Success

application/json

Responseone of | nullable

get

/rest/customers/{customerId}/terminals/{terminalId}/spg-offers/{offerId}

HTTPcURLJavaScriptPython

GET /Api/rest/customers/{customerId}/terminals/{terminalId}/spg-offers/{offerId} HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*

200Success

{
  "OfferId": "503a3d7b-072b-400f-9e7e-8ec15191c737",
  "PaymentLink": "https://www.saferpay.com/SecurePayGate/Payment/123456/12345678/503a3d7b-072b-400f-9e7e-8ec15191c737",
  "Status": "OPEN",
  "Payment": {
    "Amount": {
      "Value": "100",
      "CurrencyCode": "CHF"
    },
    "OrderId": "cd0005bf21bb4906bcbea939d74cee72",
    "Description": "Hallo"
  },
  "CreationDate": "2023-03-01T11:37:47.682+01:00",
  "ExpirationDate": "2023-04-01T00:00:00+02:00"
}

This function may be used to delete a single use payment link before it's expiry

delete

Authorizations

Authorization

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Path parameters

customerIdinteger · int32Required

terminalIdinteger · int32Required

offerIdstring · guidRequired

Header parameters

Saferpay-ApiVersionanyRequired

Saferpay-RequestIdanyRequired

Body

application/json

anyOptional

Responses

204Success

delete

/rest/customers/{customerId}/terminals/{terminalId}/spg-offers/{offerId}

HTTPcURLJavaScriptPython

DELETE /Api/rest/customers/{customerId}/terminals/{terminalId}/spg-offers/{offerId} HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*

204Success

No content

This method may be used to delete a previously created Saferpay Fields Access Token.

delete

Authorizations

Authorization

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Path parameters

customerIdinteger · int32Required

terminalIdinteger · int32Required

accessTokenstring | nullableRequired

Header parameters

Saferpay-ApiVersionanyRequired

Saferpay-RequestIdanyRequired

Body

application/json

anyOptional

Responses

204Success

delete

/rest/customers/{customerId}/terminals/{terminalId}/fields-access-token/{accessToken}

HTTPcURLJavaScriptPython

DELETE /Api/rest/customers/{customerId}/terminals/{terminalId}/fields-access-token/{accessToken} HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*

204Success

No content

Create a Saferpay Fields Access Token that can be used to integrate Saferpay Fields into web pages and is restricted to the given customerId, terminalId and URL(s).

post

Authorizations

Authorization

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Path parameters

customerIdinteger · int32Required

terminalIdinteger · int32Required

Header parameters

Saferpay-ApiVersionanyRequired

Saferpay-RequestIdanyRequired

Body

application/json

Responses

200Success

application/json

Responseone of | nullable

post

/rest/customers/{customerId}/terminals/{terminalId}/fields-access-token

HTTPcURLJavaScriptPython

POST /Api/rest/customers/{customerId}/terminals/{terminalId}/fields-access-token HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "SourceUrls": [
    "https://a.yourshop.com/",
    "https://b.yourshop.com/"
  ],
  "Description": "Saferpay Fields Access Token for YourShop"
}

200Success

{
  "AccessToken": "67f47961-2912-4338-8039-22ac2b8486f3"
}

This method is used to retrieve the current license configuration for a customer

get

Authorizations

Authorization

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Path parameters

customerIdinteger · int32Required

Header parameters

Saferpay-ApiVersionanyRequired

Saferpay-RequestIdanyRequired

Body

application/json

anyOptional

Responses

200Success

application/json

Responseone of | nullable

get

/rest/customers/{customerId}/license

HTTPcURLJavaScriptPython

GET /Api/rest/customers/{customerId}/license HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*

200Success

{
  "Package": {
    "Id": "SAFERPAY_FLEX",
    "DisplayName": "Saferpay Flex"
  },
  "Features": [
    {
      "Id": "MANAGEMENT_API",
      "DisplayName": "Management API"
    },
    {
      "Id": "PAYMENT_API",
      "DisplayName": "Payment API"
    }
  ]
}

DEPRECATED: since Version 1.35. Please use instead: /rest/customers/{customerId}/license This method is used to retrieve the current license configuration for a customer

get

Authorizations

Authorization

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Path parameters

customerIdinteger · int32Required

Header parameters

Saferpay-ApiVersionanyRequired

Saferpay-RequestIdanyRequired

Body

application/json

anyOptional

Responses

200Success

application/json

Responseone of | nullable

get

/rest/customers/{customerId}/license-configuration

HTTPcURLJavaScriptPython

GET /Api/rest/customers/{customerId}/license-configuration HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*

200Success

{
  "Package": {
    "Id": "SAFERPAY_FLEX",
    "DisplayName": "Saferpay Flex"
  },
  "Features": [
    {
      "Id": "MANAGEMENT_API",
      "DisplayName": "Management API"
    },
    {
      "Id": "PAYMENT_API",
      "DisplayName": "Payment API"
    }
  ]
}