PCpci-proxy

POST /v1/links

Generate Tokenization Link

Request

  • Base URL
    https://api.link.sandbox.pci-proxy.com
  • URL
    https://api.link.sandbox.pci-proxy.com/v1/links
  • Auth
    API key in header pci-proxy-api-key

Request body

referencestring required

The merchant's reference number. It should be unique for each process.

successUrlstring

The URL where the customer is redirected to after successful processing.

webhookEndpointstring

The URL where the webhook has to be sent to.

contextobject

Key-value pairs of strings to be displayed on the payment page. Typically used to detail the purpose of the card data collection. Example: {"Purpose": "Stay at The Vintage Hotel", "Guest name": "John Doe", "Booking reference": "2024-1234"}

amountinteger

The amount of the transaction in the currency's smallest unit. For example use 1000 for CHF 10.00. Can be omitted for use cases where only a registration should take place (if the payment method supports registrations)

currencystring

3 letter <a href='https://en.wikipedia.org/wiki/ISO_4217' target='_blank'>ISO-4217</a> character code. For example CHF or USD

collectCardholderNameboolean

Whether to collect cardholder name from the customer during the payment process.

Example request

{
  "reference": "20230131-0123456789",
  "successUrl": "https://example.org?success",
  "webhookEndpoint": "https://example.org?webhook",
  "context": {
    "Purpose": "Stay at The Vintage Hotel",
    "Guest name": "John Doe",
    "Booking reference": "2024-1234"
  },
  "amount": 1000,
  "currency": "USD",
  "collectCardholderName": true
}

Response

Success

idstring

Tokenization Link UUID

linkstring

URL of the public Tokenization page

Changes

No recorded changes to this operation across all 1 revision of this API.