Update Readme with exmaple reponse

This commit is contained in:
Shihaam Abdul Rahman 2024-10-20 01:39:32 +05:00
parent 48bf3b864b
commit a5ea55d725
Signed by: shihaam
GPG Key ID: 6DA2E87EBC227636

View File

@ -1,10 +1,8 @@
Here are example curl commands to test different scenarios: Here are example curl commands to test different scenarios:
1. With both benefName and accountNo: 1. With both benefName and accountNo:
``` ```bash
curl -X POST http://localhost:5000/verify-payment \ curl -X POST http://localhost:5000/verify-payment \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d '{ -d '{
@ -17,7 +15,7 @@ curl -X POST http://localhost:5000/verify-payment \
In this request, it will first try to verify with benfName, if it fails, then it will try with accountNo. In this request, it will first try to verify with benfName, if it fails, then it will try with accountNo.
2. With only benefName: 2. With only benefName:
``` ```bash
curl -X POST http://localhost:5000/verify-payment \ curl -X POST http://localhost:5000/verify-payment \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d '{ -d '{
@ -27,7 +25,7 @@ curl -X POST http://localhost:5000/verify-payment \
}' }'
``` ```
3. With only accountNo: 3. With only accountNo:
``` ```bash
curl -X POST http://localhost:5000/verify-payment \ curl -X POST http://localhost:5000/verify-payment \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d '{ -d '{
@ -36,3 +34,28 @@ curl -X POST http://localhost:5000/verify-payment \
"time": "2024-10-16 16:08" "time": "2024-10-16 16:08"
}' }'
``` ```
Exmaple Succcess responses;
1. Both benefName and accountNo or only benefName provided
```json
{
"message": "Payment verified using beneficiary name",
"success": true
}
```
2. Both benefName and accountNo or only accountNo provided, but failed with benefName
```json
{
"message": "Payment verified using account number",
"success": true
}
```
Example Failed response:
1.
```json
{
"message": "Transaction not found, contact support",
"success": false
}
```