API - Amount Selection Link

Endpoint

POST {BASE_URL}/wipay-payment-admin/link/flow/amount-selection

Creates a secure payment link that lets a user choose or enter an amount.

Headers

Header	Required	Description	Example
Authorization	Yes	Bearer token for authentication	Bearer...
x-api-key	Yes	API key for service access	xxxxxxxxxxxxxxxxxx
Content-Type	Yes	Must be application/json	application/json

Body

Type	Name	Description	Conditions
string	subMerchantId	Unique identifier for a sub‑merchant (to distinguish business units or divisions)	Optional
string	terminalId	Unique merchant terminal identifier. If your merchant account has multiple terminals, you must specify the terminal ID to indicate which one to use. If you have only one terminal, you may omit this field—it will default to the only available terminal.	Optional
string	language	Language identifier code; by default = es. The following link contains the ISO 639-1 language codes that are supported. Languages	Required
string	currency	Currency identifier code; by default = 978 . The following link contains the ISO 4217 currencies codes that are supported. Currencies	Required
date	expirationDate	Defines the expiration date of the operation. It must be in ISO-8601 format with time zone (OffsetDateTime type). For example: 2025-04-10T16:47:32.123-05:00 2025-04-10T21:47:32.123Z	Optional
number	amount	Operation amount	Optional
number	amounts	List of allowed amounts for the operation	Optional
number	minAmount	Minimum amount allowed	Optional
number	maxAmount	Maximum amount allowed ; by default: 1500	Optional
number	amountMultiple	The required multiple for any selectable or custom‑entered amount.	Optional
string	urlOk	Url to redirect to when the operation goes well	Optional
string	urlKo	Url to ridect to when the operation fails	Optional
boolean	isTokenization	Whether this transaction should include card tokenization (true = register card, false = one‑off payment).	Optional
string	oneTransaction	Identifies if the link is only for one use
string	linkPurpose	Always "PAYMENT" for now, it declares the type of operation it will generate

Request

Body

{
  "language": "es",
  "currency": "978",
  "expirationDate": "2025-11-26T16:18:07.693Z",
  "amounts": [
        200,
        5,
        4
    ],
  "minAmount": 1,
  "maxAmount": 1500,
  "linkPurpose": "PAYMENT",
	"amountOthers": true,
  "oneTransaction": true
}

Important Notes

• amount: If provided, the link directs straight to payment of that fixed amount.

• amounts: If provided, the customer can choose from the listed amounts.

• Mutually Exclusive: You must define either amount or amounts, not both.

• expirationDate: Must be a future timestamp; if omitted, a default expiration is applied.

Response

201 - with amount

{
  "success": true,
  "result": "https://user-area.wipay.es/api/checkout/link/980002372-25-0-i4aPd7pDBr9jTnff_nlzy_K"
}

201 - with amount list

400

404