Uploads a banner or product image.

POST /api/hostedpaymentpages/images/upload deprecated

Requires: HostedPaymentPage.HostedPaymentPages.Update, merchant scope.

Returns the generated blob filename plus its CDN preview URL. Accepts multipart/form-data (max 2 MB, max 4000x4000 pixels; gif, jpg, jpeg, png, or webp). The stored filename is server-generated; place the returned `blobName` in a page's `bannerImage` or `productImageBlobName`. Invalid uploads return a field-attributed 400 validation error.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

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 POST "{{BASE_URL}}/api/hostedpaymentpages/images/upload" \
  -H "api-key: {{API_KEY}}" \
  -F "File=@/path/to/file" \
  -F "ExtraProperties=EXTRA_PROPERTIES"

PowerShell

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

# -Form requires PowerShell 7. Windows PowerShell 5.1 has no multipart support.
$form = @{
    'File' = Get-Item '/path/to/file'
    'ExtraProperties' = 'EXTRA_PROPERTIES'
}

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/hostedpaymentpages/images/upload' `
    -Headers $headers -Form $form

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.hppImageUploadImage(fileInput.files[0], "EXTRA_PROPERTIES");

TypeScript (raw HTTP)

const form = new FormData();
form.append('File', fileInput.files[0]);
form.append('ExtraProperties', 'EXTRA_PROPERTIES');

const response = await fetch('{{BASE_URL}}/api/hostedpaymentpages/images/upload', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
  },
  body: form,
});

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.HppImageUploadImageAsync(File.OpenRead("/path/to/file"), "EXTRA_PROPERTIES");

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/hostedpaymentpages/images/upload");
request.Headers.Add("api-key", "{{API_KEY}}");

var form = new MultipartFormDataContent();
form.Add(new StreamContent(File.OpenRead("/path/to/file")), "File", "file");
form.Add(new StringContent("EXTRA_PROPERTIES"), "ExtraProperties");
request.Content = form;

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_image_upload_image(open("/path/to/file", "rb").read(), "EXTRA_PROPERTIES")

pip install requests

Python (raw HTTP)

import requests

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

files = {
    "File": open("/path/to/file", "rb"),
    "ExtraProperties": (None, "EXTRA_PROPERTIES"),
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/hostedpaymentpages/images/upload",
    headers=headers,
    files=files,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

multipart/form-data , required

Field	Type	Description
`File` required	string (binary)	The uploaded image content. The multipart filename is used only to read the claimed extension for the magic-byte cross-check; it never becomes the stored name. Required: the endpoint rejects a missing file with a field-attributed validation error.
`ExtraProperties` required	object

This request body has no documented fields.