- Previous: Card Statement Summary
- Up: Version 1.0
- Next: Utility Payments
Card Transaction
This process is used to post online Payments / Payment 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. : "WAY4" | 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_number | String | Min – 16 Max - 19 | 16 to 19-digit card no e.g: XXXXXXXXXXXX0833 First 6 digits will be BIN for cards |
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 |
Mandatory | ||
amount | String | 20 | Amount | Mandatory | |||
currency | String | 3 | Currency | Mandatory | |||
description | String | 255 | Transaction description | Optional | |||
counter_party_number | String | 20 |
Source Number PAYM_ONLINE |
Optional | |||
transaction_ref_number |
String | 12 | Transaction reference number | Mandatory | |||
transaction_date |
String | 19 |
Date of transaction YYYY-MM-DD HH:MM:SS 2021-01-15 16:26:36 |
Optional | |||
custom_fields | key | String | 32 | Custom Tag | Optional | ||
value | String | 128 | Tag value | Optional |
Request JSON
{
"NISrvRequest":{
"request_card_transaction":{
"header":{
"msg_id":"6546126",
"msg_type":"TRANSACTION",
"msg_function":"REQ_CARD_TRANSACTION",
"src_application":"MOB",
"target_application":"WAY4",
"timestamp":"2022-01-17T10:49:02.366+04:00",
"tracking_id":"6546126",
"bank_id":"ALMR"
},
"body":{
"card_number":"5147XXXXXXXX2258",
"wallet_id":"",
"transaction":{
"transaction_code":"PAYACC",
"amount":"210.00",
"currency":"AED",
"description":"Card Payment",
"counter_party_number":"PAYM_ONLINE",
"transaction_ref_number":"6546125",
"transaction_date":"2021-01-15 16:26:36",
"custom_fields":[
{
"key":"counter_party_member_id",
"value":"PAY321"
},
{
"key":"settl_amount",
"value":"210.00"
}
]
}
}
}
}
}
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_PAYMENT / REP_CARD_PAYMENT_REVERSAL
” |
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_number | String | Min – 16 Max - 19 |
14/16-digit card no e.g: XXXXXXXXXXXX0833 e.g: XXXXXXXXXXXX0833 |
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_PAYMENT",
"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_number": "",
"response_code": "",
"status": ""
}
}
}
}
paytabs/NI@paytab9
- Previous: Card Statement Summary
- Up: Version 1.0
- Next: Utility Payments
Docs Navigation
- API Security
- Falcon Services
- Card Services
- BETA
- Version 1.0
- Card Balance Enquiry
- Card Activation
- Card Set Pin
- Card Change PIN
- Card PIN Verification
- Card Status Update
- Card Limit Update
- Card Details
- Customer Details
- List Of Cards
- Customer Demographic Update
- Card Used Limits
- Card Statement Summary
- Card Transaction
- Utility Payments
- Account Create
- Account Update
- Account Closure
- Card Create
- Card Update
- Card Replacement
- Client Create
- Client Update
- Transaction Details
- PIN Retries Counter Reset
- Digital Status Chnage
- Get CVV2 Service
- Card Link Delink
- Card Insurance Products
- Card Change Insurance Product Status
- Card Direct Debit
- Update Card Direct Debit
- Card Balance Conversion Enquiry
- Card Balance Conversion
- Card Transaction Eligibility
- Card Transaction EPP Conversion
- Card Replacement Embossing
- Card NMON Transactions
- Retail Banking Transactions
- Appendix 1
- Appendix 2
- Appendix 3
- Appendix 4
- HTTP Codes
- Error Codes
- Version 2.0
- Lookup Card Identifier
- List Of Cards
- Card Activation
- Card Set PIN
- Card Change PIN
- Card Status Update
- Client Create
- Account Create
- Card Create
- Customer Demographic Update
- Account Update
- Card Update
- Card Replacement
- Customer Details
- Card Details
- Client Update
- Card Balance Enquiry
- Card Transaction
- Card Limit Update
- Card PIN Verification
- PIN Retried Counter Reset
- Get CVV2 Service
- Card Verification
- Card Transaction Details
- Get Encryption Certificate
- Get Dictionaries MCC
- Get Account Balance
- Card Insurance Product
- Card Insurance Product Update
- Card Direct Debit Update
- Card Direct Debit
- P2P Transfer
- Account Transaction
- Account Status Change
- Card Statement Summary
- Account Transaction Details
- Card Contact Details
- List of Accounts
- Account Hierarchy
- Notification Service
- Appendix 1
- Appendix 2
- Appendix 3
- Appendix 4
- HTTP Codes
- Error Codes
- Buy Now Pay Later
- Card Limits
- Insurance Services
- Webhook Services
- Switch Services
- Card Control Services
- Merchant Digital Onboarding
- Notification Service
- SMS Security Services
- Terms and Condition
0 Comments
Please sign in to post a comment.