Retrieves the full prefilled field data for an existing session for cloning.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a . See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/clone-data" \
  -H "api-key: {{API_KEY}}"

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/clone-data' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, HostedPaymentPagesApi } from '@winkpg/winkpg-api';

const api = new HostedPaymentPagesApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.hppSessionGetCloneData("3fa85f64-5717-4562-b3fc-2c963f66afa6");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/clone-data', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new HostedPaymentPagesApi(config);
var result = await api.HppSessionGetCloneDataAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));

C# (raw HTTP)

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/hostedpaymentpages/sessions/{sessionId}/clone-data");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.HostedPaymentPagesApi(client)
    result = api.hpp_session_get_clone_data("3fa85f64-5717-4562-b3fc-2c963f66afa6")

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/clone-data",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

sessionId required

path

string (uuid)

The session to retrieve clone data from.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

suppressNulls required

query

boolean

If true, omit properties with null values.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.

Responses

200 OK

OK

Body: HppSessionCloneDataDto HppSessionCloneDataDto Each item has these fields.

Field Type Description

hostedPageId required

string (uuid)

The hosted page the source session belongs to. A clone is created on this same page, so a caller that did not arrive from the page's own editor can still resolve where the new link goes.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

merchantId required

string (uuid)

The merchant that owns the source session.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

prefilledFields required

object

The full prefilled field key/value pairs from the source session. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

prefilledListFields required

object

The list-valued prefills for multi-value custom fields from the source session, keyed by field name, or `null` when the source carries none. Cloned verbatim so a link built from another link keeps every list the original carried. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

label required

string

The label from the source session, if any. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

cancelUrl required

string

The Back link address from the source session, if any. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

level3Data required

Level3Data Level3Data

The Level 3 enhanced data from the source session (header fields and line items), or `null` when the source carries none. A copy the caller owns: changing it never changes the source session. Send it back as `level3Data` on the create request so the new link carries the same lines.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of Level3Data:

Field Type Description

shipFromZip required

string

The ZIP code from where the item is shipped. Conditional: When ShipFromZip is not null. Max length: 10. nullablemax length 10

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

destinationZip required

string

The destination ZIP code for the shipment. Conditional: When DestinationZip is not null. Max length: 10. nullablemax length 10

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

destinationCountryCode required

string

The destination country code for the shipment (ISO 3166-1 alpha-3 format). Conditional: When DestinationCountryCode is not empty. Pattern: ^[A-Z]{3}$. nullablemax length 3

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

invoiceNumber required

string

The invoice number associated with the transaction. Conditional: When InvoiceNumber is not null. Max length: 25. nullablemax length 25

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

orderNumber required

string

The order number for the transaction. Conditional: When OrderNumber is not null. Max length: 25. nullablemax length 25

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

dutyAmount required

number (double)

The total duty amount for the transaction. Must be non-negative. Conditional: When DutyAmount is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

freightAmount required

number (double)

The total freight/shipping amount for the transaction. Must be non-negative. Conditional: When FreightAmount is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

discountAmount required

number (double)

The total discount amount applied at the header level. Must be non-negative. Conditional: When DiscountAmount is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lineItems required

array of Level3LineItem array of Level3LineItem

The list of line items associated with the transaction. nullablemax items 250

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

theme required

HostedPageThemeOverrideDto HostedPageThemeOverrideDto

The theme override from the source session, or `null` when it renders with the page's own theme. A copy the caller owns. Send it back as `theme` on the create request so the new link keeps the same look.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of HostedPageThemeOverrideDto:

Field Type Description

backColor required

string

The page background color, in hex. nullablepattern ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

fontColor required

string

The body text color, in hex. nullablepattern ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

font required

string

The body font family name, for example `Open Sans`. nullablemax length 50pattern ^[A-Za-z][A-Za-z0-9 \-]*$

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

fontSize required

integer (int32)

The body font size, in pixels. nullablemin 8max 48

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

headerBackColor required

string

The header background color, in hex. nullablepattern ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

headerBorderColor required

string

The header border color, in hex. nullablepattern ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

headerFont required

string

The header font family name. nullablemax length 50pattern ^[A-Za-z][A-Za-z0-9 \-]*$

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

headerFontColor required

string

The header text color, in hex. nullablepattern ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

headerFontSize required

integer (int32)

The header font size, in pixels. nullablemin 8max 72

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

panelBackColor required

string

The panel background color, in hex. nullablepattern ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

panelBorderColor required

string

The panel border color, in hex. nullablepattern ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

inputFieldBackgroundColor required

string

The input field background color, in hex. nullablepattern ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

inputFieldBackgroundFocusColor required

string

The input field background color while the field has focus, in hex. nullablepattern ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

inputFieldBorderColor required

string

The input field border color, in hex. nullablepattern ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

inputFieldFontColor required

string

The input field text color, in hex. nullablepattern ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

inputFieldFontSize required

integer (int32)

The input field font size, in pixels. nullablemin 8max 48

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

buttonColor required

string

The button color, in hex. nullablepattern ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

buttonBorderColor required

string

The button border color, in hex. nullablepattern ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This response has no documented body fields.

429 Too Many Requests

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors 400 401 403 404 500 501 default

400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
404 Not Found Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of RemoteServiceErrorInfo:

Field Type Description

code required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

message required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

details required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

data required

object

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

validationErrors required

array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by

Authentication

ApiKey with scopes

The API reference isn't available right now

No such operation

This reference may be out of date

Retrieves the full prefilled field data for an existing session for cloning.

Example request

Parameters

Request body

Responses

Errors

Authentication