Skip to main content
POST
Register Destination
Adds a host to your account’s destination allowlist. The forward proxy only sends card data to hosts on this list; there is no “any host” mode. See the Destination Allowlist guide for how matching works.
Adding a destination is sensitiveRegistering a host widens where your stored cards can be sent. Restrict who can manage the allowlist and review any unexpected additions.

Authorizations

public-api-key
string
header
default:<Your public-api-key>
required
private-secret-key
string
header
default:<Your private-secret-key>
required

Body

application/json
hostname
string
required

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

Example:

"api.example-processor.com"

purpose
string

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

Example:

"Direct acquiring — Processor X"

account_id
string<uuid> | null

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

Example:

null

Response

The destination was registered.

id
string<uuid>

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

Example:

"d7e8f9a0-1234-4b5c-8d6e-7f8091a2b3c4"

account_id
string | null

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

Example:

null

hostname
string

The registered hostname.

Example:

"api.example-processor.com"

status
enum<string>

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

Available options:
ENABLED,
DISABLED
Example:

"ENABLED"

purpose
string

The label you provided when registering the destination.

Example:

"Direct acquiring — Processor X"

created_at
string<date-time>

When the destination was registered.

Example:

"2026-07-09T13:05:36Z"

updated_at
string<date-time>

When the destination was last changed.

Example:

"2026-07-09T13:05:36Z"