V7 Webhooks Specification

Card Transaction

Any Card (includes debit, credit and prepaid) will have the following specification.

Element	Description	Specification	Example
ActBal	The actual balance of the account after this transaction is applied. Due to the real time nature of some Scheme types (FPS) this value is subject to change if any transaction is settled before or after this but notified in milliseconds before/after this transaction. This value is a signed value, with negative balances reported with a “-” before the amount. Fixed to two decimal places. No display commas.	signed decimal with fixed 2 decimal places.	60.10
avl_Bal	The actual available balance of the account after all pending transactions pending clearance. Due to the real time nature of some Scheme types (Mastercard/Visa) this value is subject to change if any transaction is settled before or after the clearing date. This value is a signed value, with negative balances reported with a “-” before the amount. Fixed to two decimal places. No display commas.	signed decimal with fixed 2 decimal places.	60.10
bill_Amt	The amount billed to card account	signed decimal with fixed 2 decimal places	1.00
bill_Ccy	Transaction billing currency	alphanumeric 3 character ISO currency code	826
blkAmt	This is the “block amount”, the sum of all pending transactions awaiting clearance.	unsigned (absolute) decimal with fixed 2 decimal places	0.00
cust_Ref	This is the unique id generated for your card account.It is the concatenation of your card account number and unique customer code	4 Alpha + 8 numeric “-“10 alphanumeric	ALGB30141585-YMUEM5KO8Z
ERN	Internal Enumis reference for this transaction. Can be used to uniquely identify the transaction	alphanumeric
fee_Fixed	An Enumis “fixed” fee billed to the card account. The txn_Desc field will provide details of the fee. The fixed fee is a fee that is not rate based.	signed decimal with fixed 2 decimal places	0.00
fee_Rate	An Enumis “rate” fee billed to the card account. The txn_Desc field will provide details of the fee. The fixed fee is a fee that is rate based on the value of the transaction.	signed decimal with fixed 2 decimal places	0.00
mcC_Code	Merchant category code	4 character alphanumeric	0014
mcC_Pad	Merchant category code padding	signed (absolute) decimal with fixed 2 decimal places	0.00
merch_ID_DE42	A unique code identifying the Merchant (also known as the Card Acceptor Identifier)
note	A description of action taken on the account
poS_Data_DE22	DE 22, subfield 1, value 05 (PAN auto-entry via chip) indicates that chip contact technology is used for the transaction. Acquirers must be certified with the full grade profile to use this value. If DE 22, subfield 1 contains value 05, DE 55 (Integrated Circuit Card [ICC] Systemrelated Data) must be present.
poS_Data_DE61	Subfield 11 (POS Card Data Terminal Input Capability) indicates the terminal is EMV chip if and only if the terminal and the acquirer are certified to accept a Mastercard card with chip technology.
poS_Termnl_DE41	Card Acceptor Terminal ID information with all card-read transactions at card acceptor locations with multiple POS devices.
poS_Time_DE12
CurrencyCode		alphanumeric 3 character ISO currency code	826
txn_CCy	Currency of the transaction	alphanumeric 3 character ISO currency code	826
txn_Desc	transaction description	alphanumeric
txn_GPS_Date	The effective date and time of transaction at merchant		2019-02-24 12:32:24.657
tXn_ID	Unique transaction ID	Numeric 10 characters	3205317873
txN_Time_DE07

An example of a transaction activity webhook received on a Card is as follows:

{
"actBal": "60.10",
"avl_Bal": "60.10",
"bill_Amt": "1.00",
"bill_Ccy": "826",
"blkAmt": "0.00",
"cust_Ref": "ALGB30141123-FMWED3RO4X",
"ern": "ern::Enumis::Transaction::ad7be52101ee019a06906b8b83d90e48ea64629860de68e38f6535e8a266aba6",
"fee_Fixed": "0.00",
"fee_Rate": "0.00",
"instCode": "ENU",
"mcC_Code": "",
"mcC_Desc": "",
"mcC_Pad": "0.00",
"merch_ID_DE42": "",
"note": "Web service load by - , Source - 10.180.240.29, Date - Feb 24 2018 12:32PM",
"poS_Data_DE22": "",
"poS_Data_DE61": "",
"poS_Termnl_DE41": "",
"poS_Time_DE12": "",
"txn_Amt": "1.0000",
"txn_CCy": "826",
"txn_Desc": "Load",
"txn_GPS_Date": "2018-02-24 12:32:24.657",
"tXn_ID": 1615217543,
"txN_Time_DE07": ""
}

Current Account/Payment Account Transaction Specification

Object	Nested Object	Description	Specification	Example
transactionId		Unique Id	GUID
status		status of the transaction	Settled, Rejected
scheme		indicates the payment scheme used for this transaction	FasterPayments, Chaps, Bacs
endToEndTransactionId		Our End to End identifier for this transaction	Alphanumeric
schemeId		The scheme End to End identifier for this transaction. This will be communicated between the two institutions and can be used to trace payments.	Alphanumeric
amount		The amount of this transaction. This value is absolute and is subject to the DebitCreditCode to distinguish whether the transaction is a debit or a credit to the account.	unsigned (absolute) value with up to 2 decimal places where appropriate	500.12
timestampSettled		The datetime of when the transaction was settled. This is UTC time	Datetime format
timestampCreated		the datetime the transaction was created (i.e. received). This was differ to the timestampSettled as it includes transactions in clearing and/or compliance but not yet settled.	Datetime format
currencyCode		The alpha currency code.	Alpha 3 character ISO currency code	GBP
debitCreditCode		Direction of the payment	Alpha (either Debit or Credit)	Credit
reference		The payment reference that was sent with or received for this transaction.	Alphanumeric 18 or 35 character
isReturn
account	ownerName	The account holder name of the Enumis account receiving the webhook	Alphanumeric35 characters	Abc Limited
account	transactionOwnerName	This is the name of the account that the sender intended to make payment to. This is sent directly from the counterparty bank, and is not always provided. It provides you with the details that the sender entered as their payee when trying to pay you.	Alphanumeric35 characters	Abc limited
account	institutionName	This will be the institution name of where the account is held.	Alphanumeric	Enumis Ltd
account	bban?	The BBAN of the Enumis account receiving the webhook. The account number can be ascertained by using the last 8 digits on the BBAN and the sort code can be ascertained by using the 6 digits after removing the alphanumeric 4 characters at the beginning of the BBAN.	4 Alphanumeric + 14 numeric18 characters	ENUM04047700000330
account	iban	The IBAN of the Enumis account that this transaction relates to and the webhook is in relation to	2 alpha country code characters + two digit check + 4 character BBAN + sortcode and account number22 characters	GB11ENUM04047600000089
counterpartAccount	ownerName	The account name of the counterparty to this transaction. If the counterparty is a remitter of funds to this account, this information will have been provided by the counterparty bank.	Alphanumeric35 characters
counterpartAccount	transactionOwnerName	If this is a debit from your account, it will be the name of the account that you intended to make payment to.If this is a credit to your account, it is the name of the account that sent payment to you. This is provided by the counterparty bank.	Alphanumeric
counterpartAccount	institutionName	Name of the counterparty bank or PSP	Alphanumeric	Barclays Bank
counterpartAccount	bban	bban of the counterparty	4 Alphanumeric + 14 numeric18 characters
counterpartAccount	iban	iban of the counterparty	2 alpha country code characters + two digit check + dependent on country specification for IBAN
counterpartAccount	oban	any other account identifier (where bban and iban were not available). This is usually for SWIFT payments that are from countries that do not utilise a formal IBAN format or CHAPS from institutions that are not sending IBAN or BBAN.	Alphanumeric
modifiedDate		You may receive a second (or more) webhooks in relation to this transaction (for example, where the account/available balance may change. This field indicates the datetime in Epoch time in milliseconds.	Epoch time in milliseconds
accountBalance		The account balance of the account after this transaction is applied. Due to the real time nature of some Scheme types (FPS) this value is subject to change if any transaction is settled before or after this but notified in milliseconds before/after this transaction. This value is a signed value, with negative balances reported with a “-” before the amount. Fixed to two decimal places. No display commas.	unsigned (absolute) value with up to 2 decimal places where appropriate	3000.00
availableBalance		The available balance of the account, after this transaction is applied. If there are any pending/held transactions their value will NOT be included in the available balance. This field is only transmitted if the availableBalance is not the same as the accountBalance	unsigned (absolute) value with up to 2 decimal places where appropriate	2500.00
ern		Internal Enumis reference for this transaction. Can be used to uniquely identify the transaction	Alphanumeric
supplementaryData	tag	The key name. This will usually be MT103 message details. Please see the References page for more information on what each tag means	Alphanumeric	50A
supplementaryData	value	This is the information relating to the key given in “tag” above	Alphanumeric	ENUMGB21XXX
pending		If this transaction has been held and is not available for us (eg for compliance checks or other reasons) this will be flagged as “true”. This field is only send if it is true.	True or null	true
version		This is the webhook version	numeric with up to 2 decimal places where appropriate	6

Examples of a transaction activity webhooks received on a current account are as follows:

Example V7 with Pending

{  
"transactionId": "6b6239e4-bf50-461b-bda0-3d3914af0535",  
"status": "Settled",  
"scheme": "Transfer",  
"endToEndTransactionId": "14c605ce5ce25c611475f1b3cbf0af4afd7",  
"schemeId": "36602de40ee14a9aab1020210307826040477",  
"amount": "0.01",  
"timestampSettled": "2021-03-07T06:53:04.44Z",  
"timestampCreated": "2021-03-07T06:53:03.967Z",  
"currencyCode": "GBP",  
"debitCreditCode": "Credit",  
"reference": "Internal Transfer",  
"isReturn": false,  
"account": 
      {    
       "ownerName": "CLEAR TEST",    
       "transactionOwnerName": "Clear Test",    
       "institutionName": "Enumis Ltd",    
       "iban": "GB33ENUM04047600000566",    
       "bban": "ENUM04047600000566"  
       },  
"counterpartAccount": 
       {    
       "ownerName": "Clear Test-OP",    
       "transactionOwnerName": "CLEAR TEST-OP",    
       "institutionName": "Enumis Ltd",    
       "iban": "GB34ENUM04047720000315",    
       "bban": "ENUM04047720000315"  
       },  
"accountBalance": "100.14",  
"availableBalance": "100.13",  
"ern": "ern::Enumis::Transaction::c68e9c68007a1d15781c74d8608fc41f8c57f370792e214c7221b0996fb72e00",  
"pending": true,  
"version": 7}

The above demonstrates a transaction that has been held by the system for a compliance check. This will not be available as a cleared payment and therefore the balance that is available is the availableBalance field.

Example V7 Rejected Pending

{  
"transactionId": "6b6239e4-bf50-461b-bda0-3d3914af0535",  
"status": "Settled",  
"scheme": "Transfer",  
"endToEndTransactionId": "14c605ce5ce25c611475f1b3cbf0af4afd7",  
"schemeId": "36602de40ee14a9aab1020210307826040477",  
"internalReference": "TRANSACTION REJECTED",  
"amount": "0.01",  
"timestampSettled": "2021-03-07T06:53:04.44Z",  
"timestampCreated": "2021-03-07T06:53:03.967Z",  
"currencyCode": "GBP",  
"debitCreditCode": "Credit",  
"reference": "Internal Transfer",  
"isReturn": false,  
"account": 
      {    
   "ownerName": "CLEAR TEST",    
      "transactionOwnerName": "Clear Test",    
      "institutionName": "Enumis Ltd",    
      "iban": "GB33ENUM04047600000566",    
      "bban": "ENUM04047600000566"  
       },  
"counterpartAccount": 
      {    
       "ownerName": "Clear Test-OP",    
       "transactionOwnerName": "CLEAR TEST-OP",    
       "institutionName": "Enumis Ltd",    
       "iban": "GB34ENUM04047720000315",    
       "bban": "ENUM04047720000315"  
       },  
"accountBalance": "100.14",  
"ern": "ern::Enumis::Transaction::c68e9c68007a1d15781c74d8608fc41f8c57f370792e214c7221b0996fb72e00",  
"rejected": true,  
"version": 7
}

The above demonstrates the webhook where a previously held payment was rejected (by either the customer or Enumis compliance teams). This information confirms that the payment indicated above has been rejected. It is not the refunding payment.

Example V7 Refunding Pending

{"transactionId": "c58826fb-3776-4a1c-95d2-479761e8399f","status": "Settled","scheme": "Transfer","endToEndTransactionId": "15134c2451ae8bd4431b5e69ba2b8ec9f4f","schemeId": "0e0a2b43580b4a899a1020210307826040476","internalReference": "RETURN TO SENDER","amount": "0.01","timestampSettled": "2021-03-07T06:53:29.437Z","timestampCreated": "2021-03-07T06:53:27.82Z","currencyCode": "GBP","debitCreditCode": "Debit","reference": "Internal Transfer","isReturn": false,"account":{"ownerName": "CLEAR TEST","transactionOwnerName": "CLEAR TEST","institutionName": "Enumis Ltd","iban": "GB33ENUM04047600000566","bban": "ENUM04047600000566"},"counterpartAccount":{"ownerName": "Clear Test-OP","transactionOwnerName": "CLEAR TEST-OP","institutionName": "ENUMIS LIMITED",      "iban": "GB34ENUM04047720000315", "bban": "ENUM04047720000315"},"accountBalance": "100.13","ern": "ern::Enumis::Transaction::f168969cbf5e89713fe05bf0987143c981e0a5083333b965c7706235d8889481","refundingTransactionId": "6b6239e4-bf50-461b-bda0-3d3914af0535","version": 7}

Example V7 Released Pending

{
   "transactionId": "1390a9b4-0ca1-4b1f-8cce-719cb008a65b",
   "status": "Settled",
   "scheme": "Transfer",
   "endToEndTransactionId": "a4c0cc3a817357d8e4f0d6acaf465e56c0d",
   "schemeId": "d6dbf5d096214ea9a41020210307826040477",
   "amount": "0.01",
   "timestampSettled": "2021-03-07T10:26:24.313Z",
   "timestampCreated": "2021-03-07T10:26:24.033Z",
   "currencyCode": "GBP",
   "debitCreditCode": "Credit",
   "reference": "Internal Transfer",
   "isReturn": false,
   "account": {
     "ownerName": "CLEAR TEST",
     "transactionOwnerName": "Clear Test",
     "institutionName": "Enumis Ltd",
     "iban": "GB33ENUM04047600000566",
     "bban": "ENUM04047600000566"
},
   "counterpartAccount": {
     "ownerName": "Clear Test-OP",
     "transactionOwnerName": "CLEAR TEST-OP",
     "institutionName": "Enumis Ltd",
     "iban": "GB34ENUM04047720000315",
     "bban": "ENUM04047720000315"   
},
   "accountBalance": "100.15",
   "ern": "ern::Enumis::Transaction::e43c04382ba23a91618d944e07d24fb4464a4e595450eaca23412483a266c0d5",
   "version": 7
}

Example of V7 Webhook Settled Transaction

{
"transactionId": "1390a9b4-0ca1-4b1f-8cce-719cb008a65b",
"status": "Settled",
"scheme": "Transfer",
"endToEndTransactionId": "a4c0cc3a817357d8e4f0d6acaf465e56c0d",
"schemeId": "d6dbf5d096214ea9a41020210307826040477",
"amount": "0.01",
"timestampSettled": "2021-03-07T10:26:24.313Z",
"timestampCreated": "2021-03-07T10:26:24.033Z",
"currencyCode": "GBP",
"debitCreditCode": "Credit",
"reference": "Internal Transfer",
"isReturn": false,
"account": {
"ownerName": "CLEAR TEST",
"transactionOwnerName": "Clear Test",
"institutionName": "Enumis Ltd",
"iban": "GB33ENUM04047600000566",
"bban": "ENUM04047600000566"
},
"counterpartAccount": {
"ownerName": "Clear Test-OP",
"transactionOwnerName": "CLEAR TEST-OP",
"institutionName": "Enumis Ltd",
"iban": "GB34ENUM04047720000315",
"bban": "ENUM04047720000315"
},
"accountBalance": "100.15",
"ern": "ern::Enumis::Transaction::e43c04382ba23a91618d944e07d24fb4464a4e595450eaca23412483a266c0d5",
"version": 7
}

Example of V7 Webhook Settled Transaction with Supplementary Data

{
"account":
    {
    "bban": "ENUM040476000XXXXX",
    "iban": "GB21ENUM040476000XXXXX",
    "institutionName": "Enumis Ltd",
    "ownerName": "Your Account Limited-MA",
    "transactionOwnerName": "YOUR ACCOUNT LTD"
    },
"accountBalance": 65524.18,
"amount": 12400,
"counterpartAccount":
    {
    "institutionName": "Not Provided",
    "oban": "HSBCUSVHXXXX-131041118115",
    "ownerName": "MR PAYEE FORYOU",
    "transactionOwnerName": "MR PAYEE FORYOU"
    },
"currencyCode": "GBP",
"debitCreditCode": "Credit",
"endToEndTransactionId": "GBS011210GQFCXN2",
"ern": "ern::Enumis::Transaction::715cdxxxxtttttsssttttxxxxc9d6430fc9vvvvvvvvvvvvvvvvv1122124a2eg0",
"isReturn": false,
"modifiedDate": 1500508100000,
"reference": "To buy something",
"scheme": "SWIFT",
"schemeId": "GBS011210GQFCXN2",
"status": "Settled",
"supplementaryData":
    [
        {
        "tag": "20",
        "value": "GBS011210GQFCXN2"
        },
        {
        "tag": "23B",
        "value": "CRED"
        },
        {
        "tag": "32A",
        "value": "200504GBP12400,00"
        },
        {
        "tag": "33B",
        "value": "GBP12400,00"
        },
        {
        "tag": "50K",
        "value": "/11203222122\r\nMrs SALLY WEBSTER\r\n100A NEWBLOCK, PRINCE A\r\nVENUE, LONDONTOWN, LONDONCITY, LOND\r\nON, NW1 1NN, UNITED KINGDOM"
        },
        {
        "tag": "52A",
        "value": "HSBCUSVHXXX"
        },
        {
        "tag": "57A",
        "value": "ENUMGB21XXX"
        },
        {
        "tag": "59",
        "value": "/000XXXX\r\nYOUR ACCOUNT LTD\r\n100 YOUR ROAD\r\nYOUR TOWN\r\nLONDON, LL1 9ZZ GB"
        },
        {
        "tag": "70",
        "value": "To buy something"
        },
        {
        "tag": "71A",
        "value": "OUR"
        },
        {
        "tag": "72",
        "value": "/NNNNNNNN"
        }
    ],
"timestampCreated": "2020-04-04T09:21:40.512Z",
"timestampSettled": "2020-04-04T09:21:40.751Z",
"transactionId": "sf222e11-sse0-1111-a2f7-xxxyyyyvv5aa",
"version": 6
}

API Overview

PKI Setup

Executing a Transaction Using PKI

Webhooks

Webhooks Specifications

API Authorisation Access

V7 Webhooks Specification

Card Transaction

Current Account/Payment Account Transaction Specification

Example V7 with Pending

Example V7 Rejected Pending

Example V7 Refunding Pending

Example V7 Released Pending

Example of V7 Webhook Settled Transaction

Example of V7 Webhook Settled Transaction with Supplementary Data

What are your Feelings

Card Transaction

Current Account/Payment Account Transaction Specification

Example V7 with Pending

Example V7 Rejected Pending

Example V7 Refunding Pending

Example V7 Released Pending

Example of V7 Webhook Settled Transaction

Example of V7 Webhook Settled Transaction with Supplementary Data

What are your Feelings

Share This Article :