Description and Details

  • This API is used to validate a domestic payment request against a previously issued access consent. It confirms that the consent is valid, active, and authorized to perform the specified payment, and checks whether the payment details are correct and compliant with policy.


Endpoint

https://api-dev-isolution.xyz/opentest/v1/access-consent/{consent_id}/domesticpayment-validation

Verb Method

POST


Headers Request Parameters

Header KeyValueDescription
Content-Typeapplication/jsonSpecifies JSON payload format
Acceptapplication/jsonExpected response format
AuthorizationBearer {token}OAuth 2.0 Bearer token

Body Request Parameters
 

ParameterTypeRequiredDescription
debtorAccountstringYesAccount number or ID of payer
creditorAccountstringYesAccount number or ID of payee
amountstringYesAmount to transfer
currencystringYesISO currency code (e.g., PKR, USD)
paymentDatestringYesScheduled payment date in ISO 8601 format
paymentReferencestringNoOptional reference message

Response Parameters

ParameterTypeDescription
validbooleanIndicates whether the payment is valid
messagestringHuman-readable message describing the result
consentStatusstringCurrent status of the consent (e.g., Authorised)

HTTP Codes

CodeMeaning
200OK – Validation successful
400Bad Request – Missing or invalid parameters
401Unauthorized – Token missing or invalid
403Forbidden – Consent not authorized
404Not Found – Consent ID does not exist
500Internal Server Error