v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Register Destination

Adds a host to your account's allowlist so the forward proxy can send card data to it. Matching is on the exact hostname, case-insensitive; subdomains and wildcards are not implied. A newly registered host is usable within minutes.

post/pci-proxy/destinations

Request body

hostnamestring required

The bare public hostname to allow, without scheme, port, or path (for example api.example-processor.com). Matched exactly, case-insensitive.

purposestring

An optional human-readable label describing why this host is allowed. Shown when you list destinations.

account_idstring uuid nullable

Optional. Restrict this destination to a single account (a UUID). Omit (or send null) to allow the host for the whole organization.

Example request

{
  "hostname": "api.example-processor.com",
  "purpose": "Direct acquiring — Processor X"
}

Response

The destination was registered.

idstring uuid

Unique identifier of the destination. Use it to remove the destination.

account_idstring nullable

The account this destination is scoped to, or null when it applies to the whole organization.

hostnamestring

The registered hostname.

status'ENABLED' | 'DISABLED'

Whether the destination is active. Only ENABLED destinations are used by the forward path.

purposestring

The label you provided when registering the destination.

created_atstring date-time

When the destination was registered.

updated_atstring date-time

When the destination was last changed.

Example response

{
  "id": "d7e8f9a0-1234-4b5c-8d6e-7f8091a2b3c4",
  "hostname": "api.example-processor.com",
  "status": "ENABLED",
  "purpose": "Direct acquiring — Processor X",
  "created_at": "2026-07-09T13:05:36Z",
  "updated_at": "2026-07-09T13:05:36Z"
}