Documentations for API
Name | Type | Values | Description |
---|---|---|---|
Accept | JSON | application/json | |
Content-Type | JSON | application/json | |
clientId | String | ************* | |
clientSecret | String | Access-Token | Auth2.0 verification |
organizationId | String | 223 | Authenticate organization |
Name | Description | Required | Parameter Type | Length | Sample Value |
---|---|---|---|---|---|
processingCode | processingCode | Mandatory | STRING | 12 |
|
merchantType | merchantType | Mandatory | STRING | 4 |
|
traceNo | traceNo | Optional | STRING | 6 |
|
companyName | companyName | Mandatory | STRING | 4 |
|
dateTime | dateTime | Mandatory | STRING | 14 |
|
mobileNo | mobileNo | Mandatory | STRING | 11 |
|
channelId | channelId | Mandatory | STRING | 4 |
|
terminalId | terminalId | Mandatory | STRING | 4 |
|
productId | productId | Mandatory | STRING | 8 |
|
otpPin | otpPin | Mandatory | STRING | 344 |
|
pinType | pinType | Mandatory | STRING | 2 |
|
transactionAmount | transactionAmount | Mandatory | STRING | 5 |
|
reserved1 | reserved1 | Optional | STRING | 0 |
|
reserved2 | reserved2 | Optional | STRING | 0 |
|
reserved3 | reserved3 | Optional | STRING | 0 |
|
reserved4 | reserved4 | Optional | STRING | 0 |
|
reserved5 | reserved5 | Optional | STRING | 0 |
|
reserved6 | reserved6 | Optional | STRING | 0 |
|
reserved7 | reserved7 | Optional | STRING | 0 |
|
reserved8 | reserved8 | Optional | STRING | 0 |
|
reserved9 | reserved9 | Optional | STRING | 0 |
|
reserved10 | reserved10 | Optional | STRING | 0 |
|
{ "DebitPaymentRequest": { "processingCode": "DebitPayment", "merchantType": "0088", "traceNo": "000012", "companyName": "NOVA", "dateTime": "20200906121218", "mobileNo": "xxxxxxxxxxx", "channelId": "NOVA", "terminalId": "NOVA", "productId": "10245185", "otpPin": "01", "pinType": "01", "transactionAmount": "120.0", "reserved1": "01", "reserved2": "", "reserved3": "", "reserved4": "", "reserved5": "", "reserved6": "", "reserved7": "", "reserved8": "", "reserved9": "", "reserved10": "" } }
Name | Description | Parameter Type | Length | Sample Value |
---|---|---|---|---|
processingCode | processingCode | String | 12 | DebitPayment |
MerchantType | MerchantType | String | 4 | 0088 |
TraceNo | TraceNo | String | 6 | 000002 |
CompanyName | CompanyName | String | 4 | NOVA |
DateTime | DateTime | String | 14 | 20200906121218 |
ResponseCode | ResponseCode | String | 1 | 00 |
ResponseDetails | ResponseDetails | object | 14 | ["Successful"] |
rrn | rrn | String | 24 | NOVA20210105201527000033 |
responseDescription | responseDescription | String | 10 | Successful |
responseDateTime | responseDateTime | String | 14 | 20200906121218 |
ransactionId | ransactionId | String | 12 | 911370913067 |
commissionAmount | commissionAmount | String | 4 | 4.31 |
transactionAmount | transactionAmount | String | 6 | 115.69 |
totalTransactionAmount | totalTransactionAmount | String | 5 | 120.0 |
{ "DebitPaymentResponse": { "processingCode": "DebitPayment", "merchantType": "0088", "traceNo": "000002", "companyName": "NOVA", "dateTime": "20200906121218", "responseCode": "00", "responseDetails": ["Successfull"], "rrn": "NOVA20200906121218000002", "responseDescription": "Successfull", "responseDateTime": "20200906121218", "transactionId": "911370913067", "commissionAmount": "4.31", "transactionAmount": "115.69", "totalTransactionAmount": "120.0" } }
{ "DebitPaymentResponse": { "processingCode": "DebitPayment", "merchantType": "0088", "traceNo": "000002", "companyName": "NOVA", "dateTime": "20200906121218", "responseCode": "00", "responseDetails": ["Successfull"], "rrn": "NOVA20200906121218000002", "responseDescription": "Successfull", "responseDateTime": "20200906121218", "transactionId": "911370913067", "commissionAmount": "4.31", "transactionAmount": "115.69", "totalTransactionAmount": "120.0" } }
{ "messages": "Bad Request - Invalid Access Token", "errorcode": "4001" }
{ "messages": "Bad Request - Invalid Request Payload", "errorcode": "4002" }
{ "messages": "Bad Request - Invalid Authorization Header", "errorcode": "4003" }
{ "messages": "Something Went Wrong", "errorcode": "4004" }
{ "messages": "Record Not Found", "errorcode": "4005" }
{ "messages": "Invalid Client Id\/Secret", "errorcode": "4006" }
{ "messages": "Bad Request - Invalid Access Token", "errorcode": "4007" }
Name | Values | Description |
---|---|---|
Content-Type | application/json | Content Type application/json is supported |
Accept | application/json | Content Type application/json is supported |
organizationId | xyz | You will make a call to the auth-blb api and give it your client ID. You should add the client secret and organisation ID it returns here. |
clientId | Enter your verified Client Id | |
clientSecret | Enter Your Verified Client Secret |