API - Easy Payment (email payment)
Create an Easypayment Link
POST {BASE_URL}/v1/wipay-payment-admin/payment/easy
Generates a one‑time, secure payment link for remote transactions. Given certain parameters, the API will return a payment URL, with built‑in tokenized security and audit logging.
Headers
Content-Type
application/json
Body
string
merchantId
Unique merchant identifier
Required
string
subMerchantId
Identifier of the sub‑merchant (used to distinguish divisions or separate units within the same merchant)
Optional
number
amount
Total operation amount
Required
string
currency
Currency identifier code; by default = 978 . The following link contains the ISO 4217 currencies codes that are supported. Currencies
Required
string
language
Language identifier code; by default = es. The following link contains the ISO 639-1 language codes that are supported.
Required
string
userId
Identifier of the user (can represent an internal ID from the merchant’s system)
Optional
date
expirationDate
Defines when the generated link expires, in ISO 8601 format (e.g., 2025-04-10T16:47:32.123)
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
merchantOperationId
Optional field that you can use in order to identify operations in your system (is gonna be returned in the WebHook communication)
Optional
Request (Includes optional parameters)
{
"merchantId": "123124",
"subMerchantId": "subtest001",
"amount": 200,
"currency": "978",
"language": "1",
"terminalId": "12314",
"userId": "user1",
"expirationDate": "2025-04-14T15:06:19.668Z"
}Response
400 Bad Request: Invalid data entered (ej. amount ≤ 0, moneda inválida, etc.)
404 Not Found: Merchant not found
500 Internal Server Error: Easy payment link couldn't be created
Cancel an Easy Payment Link
POST /v1/wipay-payment-admin/payment/easy/cancel
Enables cancelling a previously generated payment link using a secure cancellation token.
Headers
Content-Type
application/json
Body
id
Unique identifier from the previously generated Easypayment link
Required
merchantId
Unique merchant identifier
Required
cancellationToken
Secret token returned when creating the link
Required
terminalId
Unique terminal identifier
Optional
Request (Including optional fields )
Response
400 Bad Request examples:
"The token does not match""This payment cannot be cancelled"
Last updated