Contact Us
Skip Navigation LinksHome > Auth Test  

Authorisation Test

The AuthorisationTest method has been provided to help developers get up and running with the PayFac API. Use this method to ensure you have your authorisation header, client SSL certificates and client certificate used for mTLS authentication configured correctly.

As with all PayFac API methods an Authorisation header is required in the following format:

Authorization : username:AccountKey

The certificate used for mTLS authentication must be included in the request.

Use the HTTP GET method with the url below:

https://api.payfac.com/api.svc/authorisationTest

The most likely response codes are:

  • HTTP 200 - OK. This code means you have been authorised and authenticated correctly. No other data is returned from this service.
  • HTTP 401 - Unauthorised. This return code suggestes the authorisation header is missing, incorrect or is not active in PayFac
  • HTTP 403 - Forbidden. This return code means that the transport layer SSL certificate is either not valid or missing.