API - Recharge Link

The Recharge Link API lets you create a link that reserves or charges customer’s card for top‑ups. Configure predefined or custom amounts, set expiration, and track device identifiers and confirmation

Request a Recharge Link

POST {BASE_URL}/wipay-payment-admin/link/flow/recharge

Creates a custom link used for a payment operation with a custom view for choosing amounts.

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	Condiciones
string	deviceId	Unique identifier for the device used in the operation	Required
number	maxAmount	Maximun amount allowed to pay	Optional
number	minAmount	Minimum amount allowed to pay	Optional
number	amountMultiple	Ensures any user‑entered custom amount is a multiple of this value	Optional
date	expirationDate	The exact timestamp when the link expires (e.g., 2025-04-10T16:47:32.123). (Default expiration is 15 minutes)	Optional
boolean	amountOthers	Whether the user may enter their own amount. If false, they must choose from amounts	Optional
list<numbers>	amounts	A list of predefined amounts to display in the selection view	Optional
string	textToRender	A custom message to show above or alongside the amount options.	Optional
string	language	Language identifier code; by default = es. The following link contains the ISO 639-1 language codes that are supported. Languages	Optional
string	currency	Currency identifier code; by default = 978 . The following link contains the ISO 4217 currencies codes that are supported. Currencies	Optional
string	subMerchantId	Unique identifier of the sub‑merchant.	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

Request

Body with multiple amounts

{
    "amountOthers": true,
    "deviceId": "1234567890",
    "language": "es",
    "currency": 978,
    "amounts": [
        1,
        3,
        5
    ],
    "textToRender": "Esto es una prueba de comercio",
    "maxAmount": 15,
    "minAmount": 1,
    "amountMultiple": 1,
	"tokenization": true
}

Body for single amount request

Response

200

{
    "url": "https://user-area-dev.wipay.es/merchant/123456/link/123456-25-0-l7NGFjtBwp9-fmjQ1KA4pO2swkHbCXj4jrg/amount-selection",
    "baseUrl": "https://user-area-dev.wipay.es",
    "tokenId": "123456-25-0-l7NGFjtBwp9-fmjQ1KA4pO2swkHbCXj4jrg"
}

400