Try our APIs

Try it in your browser!

Submit sample requests to our endpoints in your browser:

1. Select the endpoint you want to try. This sets the required --url for the underlying cURL request.
2. Select the EXAMPLES dropdown, and fill the required fields with Request Example values.
3. Enter unique values for api_unique_identifier and client_id. Alternatively, you can fill in the request fields yourself. During onboarding, you will receive your client_id.
4. Click Try it! to submit a sample request and get a response.

Note: In addition to standard HTTP response codes, PayAPI can return this comprehensive set of response codes.

Submit a cURL request

To send a web service request using cURL:

1. You first need the client SSL certificate, which is provided by the Banking.Live technical team. The certificates are in the format: *****.crt , *****.p12 or *****.key.

   In some cases, the cURL command expects the .pem format for SSL verification. So you need to export the certificate as .pem using OpenSSL. If, for example, the client certificate (client.p12) is provided by the Banking.Live team, you can run the commands below to convert it to .pem:

   Shell

   $ cd <directory where .p12 is stored> 
   $ openssl
   OpenSSL> pkcs12 -in client.p12 -out client.pem
       Enter Import Password:
       Enter PEM pass phrase:
       Verifying - Enter PEM pass phrase:
   OpenSSL>

2. Run the cURL commands for the request. Some samples are shown below.

curl -vk --cert ./***.pem:passphrase -X POST -H "Content-Type:application/json" BASE_URL/api/pws/pws_ping_api -d '{ "api_call_unique_identifier": "1212009001" , "client_id" : "123456" }'

curl -vk --cert ./***.pem:passphrase -X POST -H "Content-Type:application/json" BASE_URL/api/pws/pws_ping_api -d '{ "api_call_unique_identifier": 1212009001, "client_id" : 123456 }'

curl -vk --cert ./***.pem:passphrase -X POST -H "Content-Type:application/json" BASE_URL/api/pws/pws_ping_api -d @D:/ping.txt

Request and view examples

You can request and view an example API request body in any listed programming language for each API.

You do this by navigating to the top right of the REQUEST box and selecting Request Example in the EXAMPLES drop down menu.