Vault Proxy Connections

Get connection version details

Get connection version details by connection id and version id.

get/token/connections/{connectionId}/versions/{connectionVersionId}

Request

Base URL
https://api.staging.payrails.io
Auth
HTTP bearer
TypeScript
https://skmtc.dev/payrails/apis/payrails-api-reference/docs/token/connections/:connectionId/versions/:connectionVersionId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

connectionIdstring uuid required

Identifier of the resource in Payrails.

connectionVersionIdstring uuid required

Identifier of the resource in Payrails.

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

Changes

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