amount — only payments that match are accepted and settled. This lets you gate a virtual account to a single known payment, preventing partial payments or unrelated credits from being processed against it.
Endpoint
Authorization header as Bearer <access_token>. Obtain a token via Generate Token.
Request
Body Parameters
The virtual account number to apply the validation to. Maximum 255 characters. Provide either
account_number or pool_account_number (or both) to identify the target account.The pool account linked to the virtual account. Maximum 255 characters. Used when you want to set validation on a virtual account by referencing its parent pool account.
The exact payment amount that must be received for the collection to be accepted. Format: up to 8 integer digits and 2 decimal places (e.g.,
"5000.00").How long the validation remains active, in minutes. The account is locked and unavailable for other collections until the duration elapses or a matching payment is received. Minimum:
1.Response
A successful response confirms that the validation rule has been applied to the specified account.Response Fields
true when validation was successfully configured."00" on success.Human-readable confirmation message.
Additional details about the configured validation, if returned by the server.
Example
Request
Response
Validation is applied per account. If you set validation on a virtual account, only payments for exactly the configured
amount will be accepted. Any payment that does not match will be rejected until the validation expires or is cleared. To remove validation before expiry, call the clear validation endpoint.Error Codes
| Response Code | Meaning |
|---|---|
00 | Success |
41 | Customer not found — invalid API credentials |
42 | Account not found — invalid account_number or pool_account_number |
60 | Customer not active |