API - Pay with Token

Request: execute a payment using a stored token

POST {BASE_URL}/wipay-payment-admin/payment/token/{tokenId}

This endpoint processes a payment using a previously stored card token. The system validates the merchant, retrieves the associated token, builds the Payment entity, executes the transaction with the configured processor, and updates the payment status accordingly.

Headers

Name	Value
Content-Type	application/json
X-Api-Key	API Key <xxx>

Path Parameters

Name	Type	Description	Conditions
tokenId	string	Unique identifier of the token	Required

Body

Type	Name	Description	Required
string	userId	Unique user identifier associated with the token	Required
string	merchantId	Unique merchant identifier	Required
string	chargeId	Unique charge identifier for recurring charges; used to distinguish between charges	Optional
number	amount	Total transaction amount	Required
string	currency	ISO currency code (default = 978)	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
string	subMerchantId	Sub-merchant identifier if the merchant uses multiple merchant structures	Optional
string	merchantOperationId	Optional field to identify operations in your system (returned in WebHook notifications)	Optional

Example request

{
  "userId": "12345-550e8400-e29b-41d4-a716-446655440000",
  "merchantId": "merchant123",
  "chargeId": null,
  "amount": 150.00,
  "currency": "978",
  "terminalId": "term-001",
  "subMerchantId": "submerchant-123",
  "merchantOperationId": "myOpId-123"
}

Response

200

{
  "chargeId": "445",
  "pendingRefundId": null,
  "moto": false,
  "methodData": {
    "maskedPan": "4111********1111",
    "expiryMonth": "12",
    "expiryYear": "27",
    "brand": "VISA"
  },
  "generatedTokenId": null,
  "usedTokenId": "tok-abc-123"
}

404