API - Preauthorization

Preauthorization - Request

POST {BASE_URL}/wipay-payment-admin/preauthorization

Generates a preauthorization for an user

---

Headers

Name	Value
Content-Type	application/json

Body :

Type	Name	Description	Condition
string	merchantId	Merchant unique identifier	Required
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
number	amount	Toal 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. Languages	Required
string	tokenId	Identifier token for a previously tokenized card	Optional
string	userId	Internal identifier of an existing user	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

Full Request (Includes optional fields)

Body

{
  "merchantId": "124243",
  "terminalId": "0000001",
  "amount": 2,
  "currency": "978",
  "language": "1",
  "tokenId": "324124214134241341235",
  "userId": "user1"
}

Response

200

{
  "sharedPreauthorization": {
    "captured": false,
    "remainingAmountUnlocked": "2.00"
  },
  "successful": true
}

400

404

500

Preauthorization - Capture

POST /v1/wipay-payment-admin/preauthorization/authorization

Executes the actual charge against a previously created pre‑authorization hold. Provide the preauthorizationId and desired amountToCapture to finalize the transaction (full or partial) and release any remaining funds.

---

Headers

Name	Value
Content-Type	application/json

Body

Type	Name	Description	Conditions
string	merchantId	Unique merchant identifier	Required
string	terminalId	Merchant terminal identifier	Optional
string	preauthorizationId	Previously generated preauthorization identifier	Required
number	amount	Total operation amount	Required
string	currency	Currency code identifier; by default = 978	Required
string	reference	Previously generated preauthorization reference	Required
string	userId	Internal identifier of an existing user	Optional

Full request (Including optional fields)

Body

{
  "merchantId": "3241344",
  "terminalId": "00000007",
  "preauthorizationId": "785463673213213",
  "amount": 2,
  "currency": "978",
  "reference": "2321462151341111111",
  "userId": "user1"
}

Response

200

{
  "success": true,
  "result": {
    "captured": true,
    "captureDate": "2025-04-22T00:00:00",
    "finalAmountCharged": "2.00",
    "remainingAmountUnlocked": "0.00"
  }
}

400

404

500