API - Checkout (Gateway)
Checkouts and their role in payment flows
Generate a checkout gateway
POST {BASE_URL}/wipay-payment-admin/checkout
Headers
Content-Type
application/json
X-Api-Key
API Key <xxx>
Body
number
amount
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
urlOk
Url to redirect to when the operation goes well
Optional
string
urlKo
Url to redirect to when the operation fails
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
boolean
tokenization
Whether this transaction should include card tokenization (true = register card, false = one‑off payment).
Optional
boolean
subscription
The transaction tokenization purpose. When subscription is sent as true, it means the exemptions to use in the next payments are MIT (client not present)
Only required if tokenization is equals to true
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
boolean
hasRedirection
Defines if the operation involves a redirection to UserArea
Optional
string
subMerchantId
Unique identifier for a sub‑merchant (to distinguish business units or divisions)
Optional
string
userId
Unique user identifier
Optional
string
chargeId
Identifier if it is or it is not a subscription
Optional
string
description
Description of the product to be paid
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
Response
Related pages
Learn how to send users notifications through Wipay
Last updated