Alias

This method may be used to delete previously inserted aliases.

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Alias/Delete

POST /Api/Payment/v1/Alias/Delete HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request id]",
    "RetryIndicator": 0
  },
  "AliasId": "alias35nfd9mkzfw0x57iwx"
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  }
}

This method may be used to update an alias' lifetime and / or its credit card expiry date

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Alias/Update

POST /Api/Payment/v1/Alias/Update HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 307

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[your request id]",
    "RetryIndicator": 0
  },
  "AliasUpdate": {
    "Id": "[your alias id]",
    "Lifetime": "[your lifetime]"
  },
  "UpdatePaymentMeans": {
    "Card": {
      "ExpMonth": "[your expiry month]",
      "ExpYear": "[your expiry year]"
    }
  }
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "Alias": {
    "Id": "alias35nfd9mkzfw0x57iwx",
    "Lifetime": 1000
  },
  "PaymentMeans": {
    "Brand": {
      "PaymentMethod": "VISA",
      "Name": "VISA Saferpay Test"
    },
    "DisplayText": "9123 45xx xxxx 1234",
    "Card": {
      "MaskedNumber": "912345xxxxxx1234",
      "ExpYear": 2015,
      "ExpMonth": 9,
      "HolderName": "Max Mustermann",
      "CountryCode": "CH"
    }
  }
}

This method may be used to insert an alias directly with card-data collected by using your own HTML form. Warning: Only respectively PCI certified merchants may submit the card-data directly, or use their own HTML form! Click here for more information!

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Alias/InsertDirect

POST /Api/Payment/v1/Alias/InsertDirect HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 320

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[your request id]",
    "RetryIndicator": 0
  },
  "PaymentMeans": {
    "Card": {
      "Number": "912345678901234",
      "ExpYear": 2015,
      "ExpMonth": 9,
      "HolderName": "Max Mustermann",
      "VerificationCode": "123"
    }
  },
  "RegisterAlias": {
    "IdGenerator": "RANDOM"
  }
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "Alias": {
    "Id": "alias35nfd9mkzfw0x57iwx",
    "Lifetime": 1000
  },
  "PaymentMeans": {
    "Brand": {
      "PaymentMethod": "VISA",
      "Name": "VISA Saferpay Test"
    },
    "DisplayText": "9123 45xx xxxx 1234",
    "Card": {
      "MaskedNumber": "912345xxxxxx1234",
      "ExpYear": 2015,
      "ExpMonth": 9,
      "HolderName": "Max Mustermann",
      "CountryCode": "CH"
    }
  }
}

This method may be used to inquire the Alias Id and further information after a successful Alias Insert call. This function can be called up to 24 hours after the transaction was initialized. Caution: Please DO NOT use the AssertInsert request for polling. You should always await the reception of the SuccessUrl.

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Alias/AssertInsert

POST /Api/Payment/v1/Alias/AssertInsert HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request identifier]",
    "RetryIndicator": 0
  },
  "Token": "234uhfh78234hlasdfh8234e"
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "Alias": {
    "Id": "alias35nfd9mkzfw0x57iwx",
    "Lifetime": 1000
  },
  "PaymentMeans": {
    "Brand": {
      "PaymentMethod": "VISA",
      "Name": "VISA Saferpay Test"
    },
    "DisplayText": "9123 45xx xxxx 1234",
    "Card": {
      "MaskedNumber": "912345xxxxxx1234",
      "ExpYear": 2015,
      "ExpMonth": 9,
      "HolderName": "Max Mustermann",
      "CountryCode": "CH"
    }
  }
}

This function may be used to insert an alias without knowledge about the card details. Therefore a redirect of the customer is required. Warning: Only PCI certified merchants may submit the card-data directly, or use their own HTML form! Click here for more information!

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Alias/Insert

POST /Api/Payment/v1/Alias/Insert HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 255

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[your request id]",
    "RetryIndicator": 0
  },
  "RegisterAlias": {
    "IdGenerator": "RANDOM"
  },
  "Type": "CARD",
  "ReturnUrl": {
    "Url": "[your shop alias registration url]"
  }
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "Token": "234uhfh78234hlasdfh8234e",
  "Expiration": "2015-01-30T12:45:22.258+01:00",
  "RedirectRequired": true,
  "Redirect": {
    "RedirectUrl": "https://www.saferpay.com/VT2/api/...",
    "PaymentMeansRequired": false
  }
}

This method can be used to get the latest details of an alias

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Alias/Inquire

POST /Api/Payment/v1/Alias/Inquire HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request identifier]",
    "RetryIndicator": 0
  },
  "AliasId": "alias35nfd9mkzfw0x57iwx"
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "Alias": {
    "Id": "alias35nfd9mkzfw0x57iwx",
    "Lifetime": 1000
  },
  "PaymentMeans": {
    "Brand": {
      "PaymentMethod": "VISA",
      "Name": "VISA Saferpay Test"
    },
    "DisplayText": "9123 45xx xxxx 1234",
    "Card": {
      "MaskedNumber": "912345xxxxxx1234",
      "ExpYear": 2015,
      "ExpMonth": 9,
      "HolderName": "Max Mustermann",
      "CountryCode": "CH"
    }
  }
}

PreviousBatch NextManagement

Last updated 9 minutes ago

Was this helpful?

hashtagThis method may be used to delete previously inserted aliases.

hashtagThis method may be used to update an alias' lifetime and / or its credit card expiry date

hashtagThis method may be used to insert an alias directly with card-data collected by using your own HTML form. Warning: Only respectively PCI certified merchants may submit the card-data directly, or use their own HTML form! Click here for more information!

hashtagThis function may be used to insert an alias without knowledge about the card details. Therefore a redirect of the customer is required. Warning: Only PCI certified merchants may submit the card-data directly, or use their own HTML form! Click here for more information!

hashtagThis method can be used to get the latest details of an alias

This method may be used to delete previously inserted aliases.

This method may be used to update an alias' lifetime and / or its credit card expiry date

This method may be used to insert an alias directly with card-data collected by using your own HTML form. Warning: Only respectively PCI certified merchants may submit the card-data directly, or use their own HTML form! Click here for more information!

This function may be used to insert an alias without knowledge about the card details. Therefore a redirect of the customer is required. Warning: Only PCI certified merchants may submit the card-data directly, or use their own HTML form! Click here for more information!

This method can be used to get the latest details of an alias