Card Transaction
This process is used to post online Payments / Payment reversals and Debit/Debit reversals to cardholder account. Below are the detailed specifications of this API.
Request Parameters:
Node | Child Node | Type | Length | Description | Remarks | ||
header | msg_id | A/N | 12 | Unique Source Message ID | Mandatory | ||
msg_type | String | 12 | Request Type Default: "TRANSACTION" | Mandatory | |||
msg_function | String | 50 | Function name to be used Default: "
REQ_CARD_TRANSACTION
" |
Mandatory | |||
src_application | String | 10 | Source requesting channel Ex: IVR | Mandatory | |||
target_application | String | 10 | Target application name Ex. : "PCMS" | Mandatory | |||
timestamp | String | 30 | Timestamp of the request Format “DD/MM/YYYY HH:MM:SS” | Mandatory | |||
tracking_id | String | 15 | Transaction Tracking Id | Optional | |||
bank_id | String | 4 | Source Bank Id Ex: bankID | Mandatory | |||
body | card_identifier_type | String | 20 |
CONTRACT_NUMBER or EXID |
Mandatory | ||
card_identifier_id | String | 32 | 454545XXXXXX1234 | Mandatory | |||
wallet_id | String | 20 | e.g: XXXXXXXXXXXX0833 | Conditional (Applicable for PCMS) | |||
transaction | transaction_code | String | 32 |
Transaction code For Payment- PAYCC For Reversal- PAYACC-REV For Debit- DEBITCC For Debit Reversal- DEBITCC-REV |
Mandatory | ||
amount | String | 20 | Amount | Mandatory | |||
currency | String | 3 | Currency | Mandatory | |||
description | String | 255 | Transaction description | Optional | |||
counter_party_number | String | 20 | Source Number | Optional | |||
transaction_ref_number | String | 12 | Transaction reference number | Mandatory | |||
custom_fields | key | String | 32 | Custom Tag | Optional | ||
value | String | 128 | Tag value | Optional |
Request JSON
{
"NISrvRequest":{
"request_card_transaction":{
"header":{
"msg_id":"224001",
"msg_type":"TRANSACTION",
"msg_function":"REQ_CARD_TRANSACTION",
"src_application":"IVR",
"target_application":"PCMS",
"timestamp":"2020-07-19T13:04:30.356+04:00",
"tracking_id":"224001",
"bank_id":"bankID"
},
"body":{
"card_identifier_type":"CONTRACT_NUMBER/EXID",
"card_identifier_id":"454545XXXXXX1234",
"wallet_id": "",
"transaction": {
"transaction_code":"",
"amount":"",
"currency":"",
"description":"",
"counter_party_number":"",
"transaction_ref_number":"",
"custom_fields":{
"key": "",
"value": ""
}
}
}
}
}
}
Response Parameters:
Node | Child Node | Type | Length | Description | Remarks | |
header | msg_id | String | 12 | The msg_id sent in the request will be sent back in response in this field. Unique Source Message ID e.g. “ada123456fdsf” |
Mandatory | |
msg_type | String | 12 | msg_type sent in the request will be sent back in response in this field. | Mandatory | ||
msg_function | String | 50 | Default: “
REP_CARD_TRANSACTION
” |
Mandatory | ||
src_application | String | 10 | The src_application sent in the request will be sent back in response in this field. Source requesting channel e.g. “SSP” |
Mandatory | ||
target_application | String | 10 | The target_application sent in the request will be sent back in response in this field. | Mandatory | ||
timestamp | String | 30 | Timestamp of the response Date & time. Format “DD/MM/YYYY HH:MM:SS” |
Mandatory | ||
tracking_id | String | 15 | The tracking_id sent in the request will be sent back in response in this field. | Optional | ||
bank_id | String | 4 | The bank_id sent in the request will be sent back in response in this field. E.g. ‘ABCD | Mandatory | ||
instance_id | String | 10 | N/A | Optional | ||
Exception_details | application_name | String | 20 | Tibco Application Name | Mandatory | |
date_time | String | 30 | Timestamp of the response Format “DD/MM/YYYY HH:MM:SS” |
Mandatory | ||
status | String | 1 | Status of the request (S/F) Success- S, Failure - F |
Mandatory | ||
error_code | String | 4 | EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions) | Mandatory | ||
error_description | String | 100 | Error Description (Check error codes section for the complete list of error codes and error code descriptions) | Mandatory | ||
transaction_ref_id | String | 20 | The tracking_id sent in the request will be sent back in response in this field. | Optional | ||
body | card_identifier_type | String | 20 |
CONTRACT_NUMBER or EXTD |
Mandatory | |
card_identifier_id | String | 32 | 454545XXXXXX1234 | Mandatory | ||
response_code | Number | 3 | Return code | Mandatory | ||
status | String | 50 | Posting status | Mandatory |
Response JSON
{
"NISrvResponse":{
"response_card_transaction":{
"header":{
"msg_id":"224001",
"msg_type":"TRANSACTION",
"msg_function":"REP_CARD_TRANSACTION",
"src_application":"IVR",
"target_application":"PCMS",
"timestamp":"19/07/2020 13:04:31",
"tracking_id":"224001",
"bank_id":"bankID"
},
"exception_details":{
"application_name":"NITIB_TCC_ADP_SSP_1",
"date_time":"2020-07-19T12:57:49.439+04:00",
"status":"S",
"error_code":"000",
"error_description":"Success",
"transaction_ref_id":null
},
"body": {
"card_identifier_type":"CONTRACT_NUMBER/EXID",
"card_identifier_id":"454545XXXXXX1234",
"response_code": "",
"status": ""
}
}
}
}
paytabs/NI@paytab9