v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB
Vault Proxy Connections

Create a new version of a connection

Saves the connection version data and returns connection version with ID.

post/token/connections/{connectionId}/versions

Path parameters

connectionIdstring required

Parameter connectionId is required for which connection version is created.

Request body

namestring

Name of connection version.

descriptionstring

Description of connection version.

httpMethodsstring[]

HTTP Methods this connection should be invoked by. You can create different connections that are invoked using same URL but which should behave differently depending on method. For example, there can be connection version that handles requests for "GET /orders" and another connection that handles requests for "POST /orders".

publicUrlstring

Public url that will be invoked by third party or merchant.

statusstring

Example request

{
  "name": "Fetch reservations",
  "description": "Get all reservations",
  "httpMethods": [
    "POST",
    "PATCH"
  ],
  "publicUrl": "/v1/reservations",
  "anyOf": {
    "proxyUrl": "https://merchant.com/v2/reservations",
    "trustedDestinationHosts": [
      "stripe.com",
      "example.com"
    ]
  },
  "rules": [
    {
      "action": "tokenization",
      "config": {
        "targetRecordType": "networkToken",
        "targetContentType": "xml",
        "expiresIn": 5000,
        "recordSelector": "/networkToken"
      }
    }
  ],
  "status": "draft"
}

Response

Success.

namestring

Name of connection version.

descriptionstring

Description of connection version.

httpMethodsstring[]

HTTP Methods this connection should be invoked by. You can create different connections that are invoked using same URL but which should behave differently depending on method. For example, there can be connection version that handles requests for "GET /orders" and another connection that handles requests for "POST /orders".

publicUrlstring

Public url that will be invoked by third party or merchant.

statusstring

Example response

{
  "name": "Fetch reservations",
  "description": "Get all reservations",
  "httpMethods": [
    "POST",
    "PATCH"
  ],
  "publicUrl": "/v1/reservations",
  "anyOf": {
    "proxyUrl": "https://merchant.com/v2/reservations",
    "trustedDestinationHosts": [
      "stripe.com",
      "example.com"
    ]
  },
  "rules": [
    {
      "action": "tokenization",
      "config": {
        "targetRecordType": "networkToken",
        "targetContentType": "xml",
        "expiresIn": 5000,
        "recordSelector": "/networkToken"
      }
    }
  ],
  "status": "draft"
}