Ecommerce
This service is used when a transaction is done through Ecommerce portal e.g., Amazon giving card_number and other related data.
Request parameters:
Name | Type | Max | Description | Sample | Remarks |
Message_Version | String | Up to 8 Char | Version of the message based on NI Issuing API spec. | 1 | Required |
Message_Type | String | 20 char | The Message Type Identifier (MTI) is a four-digit numeric data element describing the type of | Ecom_Rqst | Required |
message being interpreted. | |||||
CARD_NUMBER | Number | B/n 13 and 19 Char | Payment card number used in transaction. | 539987******5980 | Required |
From_Account | String | 6 char | Cardholder “From Account” Type Code) describes the cardholder account | Saving | Required |
type affected for cardholder account debits and inquiries and the “from account” type example are Saving, Credit and Current | |||||
Transaction_Amount | Number | 12 char | (Amount, Transaction) is the amount of funds the cardholder requested in the local | 20000 | Required |
currency of the acquirer or source location of the transaction. | |||||
Transaction_Amount_Cardholder_Billing | Number | 12 char | (Processing Code) describes the effect of a transaction on the customer account and the | 20000 | Required |
type of accounts affected. | |||||
Transmission_Date_Time | String | 14 char | (Transmission Date and Time) is the date and time that a message is entered into the | 01/11/yy 14:11:53 | Required |
Mastercard Network. Date and time must be expressed in Coordinated Universal Time (UTC). | |||||
System_Trace_Audit_Number | Number | 6 | (Systems Trace Audit Number [STAN]) is a number a message initiator assigns to | 759099 | Required |
uniquely identify a transaction. | |||||
Local_Date_Time | String | 8 char | (Time, Local Transaction) is the local time at which the transaction takes place at the | 01/11/yy 18:10:37 | Required |
point of card acceptor location. | |||||
Card_Expiry_Date | String | 8 char | (Date, Expiration) specifies the year and month after which an issuer designates a | dd/05/25 | Required |
cardholder’s card to be “expired.” | |||||
Currency_Conversion_Date | String | 8 char | (Date, Conversion) indicates the effective date of DE 9 (Conversion Rate, Settlement) | 09/16/yy | Optional |
and also DE 10 (Conversion Rate, Cardholder Billing) whenever these data elements are | |||||
present within a message. | |||||
Capture_Date | String | 8 char | (Date, Capture) is the month and day the acquirer processed the transaction data. | 01/11/yy | Required |
Merchant_Type | String | 4 char | (Merchant Type) is the classification (card acceptor business code/merchant category | 5411 | Required |
code [MCC]) of the merchant’s type of business or service. | |||||
POS_Enty_Mode | Number | 3 char | (Point-of-Service [POS] Entry Mode) indicates the method used for PAN entry to initiate | 51 | Required |
a transaction and the PIN entry capabilities. subfield 1 (POS Terminal PAN Entry Mode) indicates the method used for PAN entry to initiate a transaction. (2 char). subfield 2 (POS Terminal PIN Entry Mode) describes | |||||
the capability of the terminal device to support/accept PIN entry. (1 char) | |||||
Card_Sequence_Number | String | 3 char | distinguishes among separate cards having the same DE 2 | 0 | Required |
(Primary Account Number [PAN]) | |||||
POS_Condition_Code | String | 2 Char | (Point-of-Service [POS] Condition Code) is an ID of the condition under which the transaction takes place at the point of interaction. | 15 | Required |
Transaction_Fee | String | 9 char | (Amount, Transaction Fee) is the fee charged (for example, by the acquirer) for transaction activity in the currency of DE 4 (Amount, Transaction). subfield 1 (Debit/Credit Indicator) indicates the program type. (1 char). subfield 2 (Amount) indicates the fee amount in the currency of DE 4 (Amount,Transaction). (8 char) | C00000500 | Required |
Acquiring_Institution_Code | String | 6 char | (Acquiring Institution ID Code) identifies the acquiring institution (for example,merchant bank) or its agent. | 587387 | Required |
Retrieval_Reference_Number | Number | 12 char | (Retrieval Reference Number) is a document reference number supplied by the system | 5.1241E+11 | Required |
retaining the original source document of the transaction and assists in locating that source | |||||
document or a copy thereof. | |||||
Card_Acceptor_Terminal_ID | String | 8 char | (Card Acceptor Terminal ID) uniquely identifies a terminal at the card acceptor location | ABCD0501 | Required |
of acquiring institutions or merchant POS systems. | |||||
Card_Acceptor_Identification_Code | String | 15 char | (Card Acceptor ID Code) identifies the card acceptor that defines the point of the | ABCD Bank | Required |
transaction in both local and interchange environments. | |||||
Card_Acceptor_Name_Location | String | Up to 40 char | (Card Acceptor Name/Location) contains the name and location of the card acceptor | MALL OF THE EMIRATES DUBAI DUBAE | Required |
Currency_Code_Transaction | String | 3 char | (Currency Code, Transaction) is the local currency of the acquirer or source location of | 784 | Required |
the transaction. | |||||
Currency_Code_Cardholder_Billing | String | 3 char | (Currency Code, Cardholder Billing) defines the currency of DE 6 (Amount, Cardholder | 784 | Required |
Billing) and DE 8 (Amount, Cardholder Billing Fee). | |||||
Banknet_Data | String | B/n 6 and 9 char | (Banknet Reference Number) is generated by the Authorization Platform for | 2245 | Required |
each originating message it routes. | |||||
From_Account_No | Number | Up to 28 char | (Account ID-1) is a series of digits that identify a customer account or relationship. Customers primarily use it for the “from” account in a transfer transaction. | 101**********105 | Required |
Request Json
{
"Message_Version": "1.0",
"Message_Type": "Ecom_Rqst",
"Card_Number ": "470468******5980",
"From_Account": "Saving",
"Transaction_Amount": "000000020000",
"Transaction_Amount_Cardholder_Billing": "000000020000",
"Transmission_Date_Time": "01/11/yy 14:11:53",
"System_Trace_Audit_Number": "759099",
"Local_Date_Time": "01/11/yy 18:10:37",
"Card_Expiry_Date ": "dd/05/25",
"Currency_Conversion_Date": "09/16/yy",
"Capture Date": "01/11/yy",
"Merchant_Type": “4816”,
"POS_Enty_Mode": "051",
"Card_Sequence_Number": "000",
"POS_Condition_Code": "15",
"Transaction_Fee": "C00000500",
"Acquiring_Institution_Code": "587387",
"Retrieval_Reference_Number": "512410002459",
"Card_Acceptor_Terminal_ID": "ABCD0501",
"Card_Acceptor_Identification_Code": "ABCD Bank",
"Card_Acceptor_Name_Location": "MALL OF THE EMIRATES DUBAI DUBAE",
"Currency_Code_Transaction": "784",
"Currency_Code_Cardholder_Billing": "784",
"Banknet_Data": "002245",
"From_Account_No": "101**********105"
}
Response parameters:
Name | Type | Max | Description | Sample | Remarks |
Message_Version | String | Up to 8 Char | Version of the message based on NI Issuing API spec. | 1 | Required |
Message_Type | String | 4 char | The Message Type Identifier (MTI) is a four-digit numeric data element describing the type of | Ecom_Resp | Required |
message being interpreted. | |||||
CARD_NUMBER | Number | B/n 13 and 19 Char | Payment card number used in transaction. | 539987******5980 | Required |
From_Account | String | 6 char | Cardholder “From Account” Type Code) describes the cardholder account | Saving | Required |
type affected for cardholder account debits and inquiries and the “from account” type example are Saving, Credit and Current | |||||
Transaction_Amount | Number | 12 char | (Amount, Transaction) is the amount of funds the cardholder requested in the local | 20000 | Required |
currency of the acquirer or source location of the transaction. | |||||
Transaction_Amount_Cardholder_Billing | Number | 12 char | (Processing Code) describes the effect of a transaction on the customer account and the | 20000 | Required |
type of accounts affected. | |||||
Transmission_Date_Time | String | 14 char | (Transmission Date and Time) is the date and time that a message is entered into the | 01/11/yy 14:11:53 | Required |
Mastercard Network. Date and time must be expressed in Coordinated Universal Time (UTC). | |||||
System_Trace_Audit_Number | Number | 6 | (Systems Trace Audit Number [STAN]) is a number a message initiator assigns to | 759099 | Required |
uniquely identify a transaction. | |||||
Local_Date_Time | String | 8 char | (Time, Local Transaction) is the local time at which the transaction takes place at the | 01/11/yy 18:10:37 | Required |
point of card acceptor location. | |||||
Card_Expiry_Date | String | 8 char | (Date, Expiration) specifies the year and month after which an issuer designates a | dd/05/25 | Required |
cardholder’s card to be “expired.” | |||||
Settlement_Date | String | 8 char | (Date, Settlement) is the date (month and day) that funds will be transferred between | 01/11/yy | Required |
an acquirer and an issuer or an appropriate intermediate network facility (INF). | |||||
Currency_Conversion_Date | String | 8 char | (Date, Conversion) indicates the effective date of DE 9 (Conversion Rate, Settlement) | 09/16/yy | Optional |
and also DE 10 (Conversion Rate, Cardholder Billing) whenever these data elements are | |||||
present within a message. | |||||
Capture_Date | String | 8 char | (Date, Capture) is the month and day the acquirer processed the transaction data. | 01/11/yy | Required |
POS_Enty_Mode | Number | 3 char | (Point-of-Service [POS] Entry Mode) indicates the method used for PAN entry to initiate | 12 | Required |
a transaction and the PIN entry capabilities. subfield 1 (POS Terminal PAN Entry Mode) indicates the method used for PAN entry to initiate a transaction. (2 char). subfield 2 (POS Terminal PIN Entry Mode) describes | |||||
the capability of the terminal device to support/accept PIN entry. (1 char) | |||||
Card_Sequence_Number | String | 3 char | distinguishes among separate cards having the same DE 2 | 0 | Required |
(Primary Account Number [PAN]) | |||||
POS_Condition_Code | String | 2 Char | (Point-of-Service [POS] Condition Code) is an ID of the condition under which the transaction takes place at the point of interaction. | 15 | Required |
Acquiring_Institution_Code | String | 6 char | (Acquiring Institution ID Code) identifies the acquiring institution (for example, | 587387 | Required |
merchant bank) or its agent. | |||||
Retrieval_Reference_Number | Number | 12 char | (Retrieval Reference Number) is a document reference number supplied by the system | 5.1241E+11 | Required |
retaining the original source document of the transaction and assists in locating that source | |||||
document or a copy thereof. | |||||
Approval_Code | String | 6 char | (Authorization ID Response) is a transaction response ID code that the authorizing | 1999 | Required |
institution assigns. | |||||
Action_Code | String | 2 char | (Response Code) defines the disposition of a previous message or an action taken as a | 0 | Required |
result of receipt of a previous message. | |||||
Card_Acceptor_Terminal_ID | String | 8 char | (Card Acceptor Terminal ID) uniquely identifies a terminal at the card acceptor location | ABCD0501 | Required |
of acquiring institutions or merchant POS systems. | |||||
Card_Acceptor_Identification_Code | String | 15 char | (Card Acceptor ID Code) identifies the card acceptor that defines the point of the | ABCD Bank | Required |
transaction in both local and interchange environments. | |||||
Additional_Response_Data | String | Up to 24 char | DE 44 (Additional Response Data) provides other supplemental data that may be required in | 4E+24 | Required |
response to an authorization or other type of transaction request. | |||||
Currency_Code_Transaction | String | 3 char | (Currency Code, Transaction) is the local currency of the acquirer or source location of | 784 | Required |
the transaction. | |||||
Currency_Code_Cardholder_Billing | String | 3 char | (Currency Code, Cardholder Billing) defines the currency of DE 6 (Amount, Cardholder | 784 | Required |
Billing) and DE 8 (Amount, Cardholder Billing Fee). | |||||
From_Account_No | Number | Up to 28 char | (Account ID-1) is a series of digits that identify a customer account or relationship. Customers primarily use it for the “from” account in a transfer transaction. | 101**********105 | Required |
Response Json
{
"Message_Version": "1.0",
"Message_Type": "Ecom_Resp",
"Card_Number ": "470468******5980",
"From_Account": "Saving",
"Transaction_Amount": "000000000000",
"Transaction_Amount_Cardholder_Billing": "000000020000",
"Transmission_Date_Time": "01/11/yy 14:11:53",
"System_Trace_Audit_Number": "759099",
"Local_Date_Time": "01/11/yy 18:10:37",
"Card_Expiry_Date ": "dd/05/25",
"Settlement_Date": "01/11/yy",
"Capture Date": "01/11/yy",
"POS_Enty_Mode": "051",
"Card_Sequence_Number": "000",
"POS_Condition_Code": "15",
"Acquiring_Institution_Code": "587387",
"Retrieval_Reference_Number": "512410002459",
"Approval_Code": "587387",
"Action_Code": "00",
"Card_Acceptor_Terminal_ID": "ABCD0501",
"Additional_Response_Data": "4000000020299000000020299",
"Currency_Code_Transaction": "784",
"Currency_Code_Cardholder_Billing": "784",
"From_Account_No": "101**********105"
}
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.