Section S - Payment details API
S1 - Get all Payment IDs
GET Method :
/api/v1/get_all_payment_ids/< fromDate >/
Input :
Argument | Mandatory | Value |
---|---|---|
fromDate | No | From Date < Date Format yyyy-mm-dd> |
toDate | No | To Date |
Sample Output :
{
"300":300,
"301":301,
"302":302,
"400":400,
"401":401,
"600":600,
"303":303
}
S2 - Payment details
GET Method :
/api/v1/get_payment_details/< userId > with the following data:
Input :
Argument | Mandatory | Value |
---|---|---|
userId | Yes | Numeric < Id of the user> |
Sample Output :
{ "customerNumber":"2"
} { "Payment":
{ "id":7400,
"amount":"50.0000000000",
"create_datetime":"2016-03-23 12:06:03.156+05:30"
}},
{ "PaymentInvoice":
{ "payment_id":7400,
"invoice_id":14700
}},
{ "PaymentInfoCheque":
{ "payment_id":7400,
"bank":"Cash"
}}
S3 - Payment details by date
GET Method :
/api/v1/get_payment_details_by_date/< fromDate >/ < toDate > with the following
Input :
Argument | Mandatory | Value |
---|---|---|
fromDate | Yes | From Date < Date Format yyyy-mm-dd> |
toDate | Yes | To Date |
Sample Output :
[[{
"customer_number":"1",
"user_id":"1",
"payment_id":200,
"amount":"115.0000000000",
"payment_date":"2016-09-08 19:23:04.693+05:30",
"invoices":
[{
"invoice_id":100
}],
"payment_type":"Payment gateway"
}]]
S4 - Get payment details by userid and date
GET Method :
/api/v1/get_payment_details_by_userid_and_date/< userId>/
Input :
Argument | Mandatory | Value |
---|---|---|
userId | Yes | Numeric < Id of the user> |
fromDate | Yes | From Date < Date Format yyyy-mm-dd> |
toDate | Yes | To Date |
Sample Output :
{ "customerNumber":"2"
} { "Payment":
{ "id":7400,
"amount":"50.0000000000",
"create_datetime":"2016-03-23 12:06:03.156+05:30"
}},
{ "PaymentInvoice":
{ "payment_id":7400,
"invoice_id":14700
}},
{ "PaymentInfoCheque":
{ "payment_id":7400,"bank":"Cash" }}
S5 - Get payment logs
GET Method :
/api/v1/get_payment_logs/< userId> with the following data:
Input :
Argument | Mandatory | Value |
---|---|---|
userId | Yes | Numeric < Id of the user> |
Sample Output :
Note: This is a sample transaction, may differ based on the external payment gateway which user chooses.
{ "ExternalPayment":{
"merchantTxnId":"56eddfdf3355d71458219261",
"gateway_txn_id":"2534341604",
"details":"{\u0022txn_status\u0022:\u00220300\u0022,\u0022txn_msg\
u0022:\u0022success\u0022,\u0022txn_err_msg\u0022:\u0022NA\u0022,\
u0022clnt_txn_ref\u0022:\u002256easdqq55d71458219261\u0022,\
u0022tpsl_bank_cd\u0022:\u00221110\u0022,\u0022tpsl_txn_id\u0022:\
u0022333321604\u0022,\u0022txn_amt\u0022:\u00221.01\u0022,\
u0022clnt_rqst_meta\u0022:\u0022{itc:email}{custname:user_name}\u0022,\
u0022tpsl_txn_time\u0022:\u002217-03-2016 18:24:28\u0022,\u0022tpsl_rfnd_id\
u0022:\u0022NA\u0022,\u0022bal_amt\u0022:\u0022NA\u0022,\
u0022rqst_token\u0022:\u002254849facd9-0917-43fa-b37a-74543a361007\
u0022,\u0022hash\u0022:\u0022f112a87af8544a662a3b77abeb132e96e65bd228\
u0022}",
"number":"INR",
"operator":"techprocess-pay"
}}
S6 - Get payment logs by date
GET Method :
/api/v1/get_payment_logs_by_date/
Input :
Argument | Mandatory | Value |
---|---|---|
fromDate | Yes | From Date < Date Format yyyy-mm-dd> |
toDate | Yes | To Date |
Sample Output :
Note: This is a sample transaction, may differ based on the external payment gateway which user chooses.
{ "ExternalPayment":{
"merchantTxnId":"56eddfdf3355d71458219261",
"gateway_txn_id":"2534341604",
"details":"{\u0022txn_status\u0022:\u00220300\u0022,\u0022txn_msg\
u0022:\u0022success\u0022,\u0022txn_err_msg\u0022:\u0022NA\u0022,\
u0022clnt_txn_ref\u0022:\u002256easdqq55d71458219261\u0022,\
u0022tpsl_bank_cd\u0022:\u00221110\u0022,\u0022tpsl_txn_id\u0022:\
u0022333321604\u0022,\u0022txn_amt\u0022:\u00221.01\u0022,\
u0022clnt_rqst_meta\u0022:\u0022{itc:email}{custname:user_name}\u0022,\
u0022tpsl_txn_time\u0022:\u002217-03-2016 18:24:28\u0022,\u0022tpsl_rfnd_id\
u0022:\u0022NA\u0022,\u0022bal_amt\u0022:\u0022NA\u0022,\
u0022rqst_token\u0022:\u002254849facd9-0917-43fa-b37a-74543a361007\
u0022,\u0022hash\u0022:\u0022f112a87af8544a662a3b77abeb132e96e65bd228\
u0022}",
"number":"INR",
"operator":"techprocess-pay"
}}
S7 - Get payment logs by userid and date
GET Method :
/api/v1/get_payment_logs_by_userid_and_date/< userId>/< fromDate >/ < toDate > with the following data:
Input :
Argument | Mandatory | Value |
---|---|---|
userId | Yes | Numeric < Id of the user> |
fromDate | Yes | From Date < Date Format yyyy-mm-dd> |
toDate | Yes | To Date |
Sample Output :
Note: This is a sample transaction, may differ based on the external payment gateway which user chooses.
{ "ExternalPayment":{
"merchantTxnId":"56eddfdf3355d71458219261",
"gateway_txn_id":"2534341604",
"details":"{\u0022txn_status\u0022:\u00220300\u0022,\u0022txn_msg\
u0022:\u0022success\u0022,\u0022txn_err_msg\u0022:\u0022NA\u0022,\
u0022clnt_txn_ref\u0022:\u002256easdqq55d71458219261\u0022,\
u0022tpsl_bank_cd\u0022:\u00221110\u0022,\u0022tpsl_txn_id\u0022:\
u0022333321604\u0022,\u0022txn_amt\u0022:\u00221.01\u0022,\
u0022clnt_rqst_meta\u0022:\u0022{itc:email}{custname:user_name}\u0022,\
u0022tpsl_txn_time\u0022:\u002217-03-2016 18:24:28\u0022,\u0022tpsl_rfnd_id\
u0022:\u0022NA\u0022,\u0022bal_amt\u0022:\u0022NA\u0022,\
u0022rqst_token\u0022:\u002254849facd9-0917-43fa-b37a-74543a361007\
u0022,\u0022hash\u0022:\u0022f112a87af8544a662a3b77abeb132e96e65bd228\
u0022}",
"number":"INR",
"operator":"techprocess-pay" }}
S8 - Get payment receipt
GET Method :
/api/v1/get_payment_receipt/< userId>/< paymentId> with the following data:
Input :
Argument | Mandatory | Value |
---|---|---|
userId | Yes | Numeric < Id of the user> |
paymentId | Yes | Numeric < Id of the payment > |
Sample Output :
{
"status": "success",
"errorCode": 200,
"message": "http://10.0.0.91:8095/jazetest/receipt10.pdf"
}