SendPasswordResetCodeWithUsername for Account

POST /api/app/account/send-password-reset-code-with-username deprecated

No permission required.

Performs SendPasswordResetCodeWithUsername operation on Account resource via POST method.

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 SendPasswordResetCodeExtendedDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/app/account/send-password-reset-code-with-username" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "developer@example.com",
  "appName": ""
}'

PowerShell

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

$body = @'
{
  "email": "developer@example.com",
  "appName": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/app/account/send-password-reset-code-with-username' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.accountSendPasswordResetCodeWithUsername({
  "email": "developer@example.com",
  "appName": ""
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/app/account/send-password-reset-code-with-username', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email": "developer@example.com",
    "appName": ""
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

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

var api = new AccountApi(config);
var body = JsonSerializer.Deserialize<SendPasswordResetCodeExtendedDto>("""
    {
      "email": "developer@example.com",
      "appName": ""
    }
    """);

var result = await api.AccountSendPasswordResetCodeWithUsernameAsync(body);

C# (raw HTTP)

using System.Text;

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

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/app/account/send-password-reset-code-with-username");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "email": "developer@example.com",
      "appName": ""
    }
    """, Encoding.UTF8, "application/json");

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.AccountApi(client)
    body = winkpg_api.SendPasswordResetCodeExtendedDto.from_dict({
      "email": "developer@example.com",
      "appName": ""
    })
    result = api.account_send_password_reset_code_with_username(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "email": "developer@example.com",
  "appName": ""
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/app/account/send-password-reset-code-with-username",
    headers=headers,
    json=body,
)
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

application/json , required

Field	Type	Description
`email` required	string (email)	Email address to which the password reset code/link should be sent. min length 0max length 256
`appName` required	string	Client/application name used for branding the reset experience or selecting templates. min length 1
`returnUrl` required	string	URL to redirect the user to after completing the reset process. nullable
`returnUrlHash` required	string	Optional fragment/hash (e.g., SPA route) to append to the return URL after reset. nullable
`userName` required	string	User name of the account requesting a password reset. Useful when email alone is not sufficient to identify the user. nullable

This request body has no documented fields.