Validate Payment Batch
The Validate Payment Batch method can be used before submitting a Payment Batch to ensure all required payment data is present.
This method can also be used to determine what data is required for a specific payment. For example, if you want to pay INR to India using the ACH payment method then a payment code is required. This is just one of many rules that vary based on currency/delivery method and country. Rather than coding all these rules into your system (they are subject to change by our banking partners) you can pass a minimal amount of data and this method will return a number of ValidationMessage elements that will describe what is required. You can then code your application such that the payment code field is required and populate it with the codes supplied in the SuggestedValues element.
When valid, a QuoteCode and ExchangeRate element will be populated in the response. The quote code will be valid for 30 seconds and when passed with a request to submit a payment batch the quoted rate will be applied to the payment.
Use the HTTP POST method with the url below:
https://api.payfac.com/api.svc/validate/paymentBatch/
- An Authorisation header is required in the following format: Authorization : username:AccountKey
- The certificate used for mTLS authentication must be included in the request
- The request schema and request example show the XML format required by this method
- The response schema and response example define the XML format that is returned for this method