Data Items Reference

Permitted Character Sets and Formats

Character set AN

📘
The MyBank character set AN consists of only the following characters:
a b c d e f g h i j k l m n o p q r s t u v w x y z
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
0 1 2 3 4 5 6 7 8 9
/ - ? : ( ) . , ' +
Space

Within the individual Data Element definitions terms such as “Max 140 AN” are used. This is a short way of writing, in this case, “Between 1 and 140 characters from the AN character set”.
Note that empty Data Elements are not allowed so that the minimum length is always 1.

Character set UTF8

This is the native ISO schema character set. MyBank does not impose further restrictions.
The UTF8 character set is used for data elements such as email addresses, URLs and specific elements which allow local language names.
Within the individual Data Element definitions terms such as “Max 2048 UTF8” are used. This is a short way of writing, in this case, “Between 1 and 2048 characters from the UTF8 character set”.
Note that empty Data Elements are not allowed so that the minimum length is always 1.

Date format

All dates and date-time stamps used within the Server are ISO 8601 that MUST include an explicit time-zone indicator set to UTC and MUST conform to the following rules:

📘
Format
Date MUST have the form: YYYY”-“MM”-“DD”Z”
DateTime MUST have the form: YYYY”-“MM”-“DD”T”hh”:”mm”:”ss[“.”1*(n)]”Z”
Where:

YYYY is any valid four-digit year number (e.g. 2021)

MM is any valid two-digit month number (e.g. 10 which indicates October)

DD is any valid two-digit day number (e.g. 03 which indicates the third day of the month)

hh is any valid two-digit hour number (24-hour notation) in the range 00 to 23 (e.g. 10 indicates 10 a.m.)

mm is any valid two-digit minute number in the range 00 to 59 (e.g. 04 which indicates 4 minutes into the hour)

ss is any valid two-digit seconds number in the range 00 to 59 (e.g. 09 which indicates 9 seconds into the minute).Note that the number 60 is used to represent leap seconds.

n is any digit.

Data Items

The following table lists all the MyBank data items included within one or more APIs.
The last column of the table specifies the SCT path for the data items included within the SCT underlying the MyBank transaction.

Parameter	Description	Format / Value	SCT Path
authorisingAccessMode	Type of client used by the Payer to access MyBank Authorisation page. See `landingAccessMode`. The client used to access MyBank Authorisation page will in most cases be the same as the client used to access MyBank Login page. It may be different, for example, if the Payer PSP serves a web-based Login page which includes a QR-Code allowing to continue the payment in a Mobile App.	`"MOBILE_APP"`, `"DESKTOP_WEBSITE"`, `"MOBILE_WEBSITE"`, or `"WEBSITE"`
authorisingUserAgent	Description of the client used by the Payer to access MyBank Authorisation page. See `landingUserAgent`.	Max 512UTF8
businessError	Flag indicating whether the MyBank transaction's final `"ERROR"` status is due to a business ("1") or to a technical error ("0").	Boolean ("0","1")
buyerBic	Business Identifier Code (BIC) related to the Buyer’s payment account held by the Buyer Bank.	8AN or 11AN character ISO code	/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/DbtrAgt/FinInstnId/BIC
buyerIban	The International Bank Account Number of the Buyer’s payment account held by the Buyer Bank.	ISO 13616 - Max 34AN	/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/DbtrAcct/Id/IBAN
buyerName	Name of Buyer.	Max 70UTF8	/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/Dbtr/Nm
confirmedExecutionDate	Date on which the SCT or SCT Inst will be executed. For SCT, it is the Payer PSP's responsibility to execute the authorised SCT on the first banking business day on or after the `transactionSCT01DB.requestedExecutionDate`. The Buyer will be debited on the date that the payment is executed.	YYYY”-“MM”-“DD”T”hh”:”mm”:”ss[“.”1(n)][“.”1(n)]”Z” Time part will be zero.
institute	Identifier of the Payer PSP invoking the API. The value will be communicated by the Solution Manager after the onboarding phase.	Max 15AN
keys	List of "key" values indicating specific events in the life of a MyBank Transaction. The possible values for a "key" are: LANDING_URL_CONSUMED: MyBank Login page has been presented. AUTHORISING_USER_AUTHENTICATED: The Payer was successfully authenticated. TRANSACTION_DATA_DISPLAYED: MyBank Authorisation page has been presented.	List of `"LANDING_URL_CONSUMED"`, `"AUTHORISING_USER_AUTHENTICATED"` or `"TRANSACTION_DATA_DISPLAYED"`.
landingAccessMode	Type of client used by the Payer to access MyBank Login page. The possible values are: MOBILE_APP: the client is an App (e.g., Mobile Banking App). DESKTOP_WEBSITE: the client is the desktop-version of a web application (e.g., Online Banking web application). MOBILE_WEBSITE: the client is the mobile-version of a web application (e.g., Online Banking web application). WEBSITE: the client is a web application (e.g., Online Banking web application); it is not possible or it is not relevant to distinguish between a desktop and a mobile version.	`"MOBILE_APP"`, `"DESKTOP_WEBSITE"`, `"MOBILE_WEBSITE", or "WEBSITE"`.
landingUserAgent	Description of the client used by the Payer to access MyBank Login page. In case the client is a web application, this must take the value of the User Agent (e.g., "Mozilla/5.0 (Linux; Android 8.0.0; SM-G960F Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.84 Mobile Safari/537.36", "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.111 Safari/537.36"). In case the client is an App, please send a string describing the Operating System of the device, followed by " App/" and the version of the App.	Max 512UTF8
paymentTransactionID	Identifier of the payment, assigned by the Buyer Bank: it is the SEPA TxId that will be used in the pacs.008 of the payment.	Max 35AN	/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/PmtId/TxId
sctInstExecuted	Flag indicating whether the Payer PSP is honouring the payment via an Instant SCT ("1") or an ordinary SCT ("0").	Boolean ("0","1")
token	Unique identifier of a MyBank transaction assigned by the MyBank Gateway. The Payer PSP must originally extract the value of this attribute from the "landing URL".	Max 35AN (UUID)
transactionErrorInfo	Descriptive message indicating the reason why a MyBank transaction has been set to the `"ERROR"` final status. This is only intended for MyBank's Solution Manager internal use, and not meant to be disclosed to the Payee-side.	Max 512UTF8
transactionSCT01DB.aliasLanguage	Specifies the language (ISO 639-1) of the alias of the Payer PSP selected by the Payer. The Payer PSP is free to use this value to apply localization logic on the Banking Application. This attribute may be absent or empty.	ISO 639-1 language code Example: it, fr, es
transactionSCT01DB.amount	Amount of the transaction in Euro.	Between `0.01` and `999999999.99`	/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/IntrBkSttlmAmt
transactionSCT01DB.endToEndID	The application level reference of the MyBank transaction as assigned by the Payee PSP. This will be included in the SCT underlying the MyBank transaction.	Max 35AN	/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/PmtId/EndToEndId
transactionSCT01DB.initiatingPartyID	An identification code of the Payee or of the Payee PSP (assigned by the Payee PSP or by the Solution Manager).	Max 35AN	/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/Cdtr/Id/OrgId/Othr/Id
transactionSCT01DB.initiatingPartyReturnURL	The unique and per-transaction URL provided by the Merchant that is used to redirect the Buyer back to him after completing the authorisation.	Max 512UTF8
transactionSCT01DB.initiatingPartySubID	An identification code of the Payee (assigned by the Payee PSP). This attribute may be absent or empty.	Max 35AN	/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/UltmtCdtr/Id/OrgId/Othr/Id
transactionSCT01DB.merchantBankBIC	Business Identifier Code (BIC) of the Beneficiary Account of the payment. The SCT underlying the MyBank transaction is sent to this BIC.	8AN or 11AN character ISO code	/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/CdtrAgt/FinInstnId/BIC
transactionSCT01DB.merchantIBAN	International Bank Account Number (IBAN) of the Beneficiary Account of the payment. The SCT underlying the MyBank transaction is sent to this IBAN.	ISO 13616 - MAX 34AN	/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/CdtrAcct/Id/IBAN
transactionSCT01DB.merchantName	The account holder name associated to the merchantIBAN.	Max 70AN	/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/Cdtr/Nm
transactionSCT01DB.merchantTaxNumberClassification	Not relevant for the Payer PSP. For future use.
transactionSCT01DB.merchantTaxNumberID	Not relevant for the Payer PSP. For future use.
transactionSCT01DB.merchantTradingName	The trading name of the Merchant as known by the Buyer.	Max 70UTF8	/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/UltmtCdtr/Nm
transactionSCT01DB.mybankApplicationID	Not relevant for the Payer PSP. For future use.	Fixed value "MBNKCT01".
transactionSCT01DB.orderDescription	A free text field used by the Merchant to describe the goods being ordered by the Buyer, to assist the Buyer to recognise the transaction. This attribute may be absent or empty.	Max 128UTF8
transactionSCT01DB.remittanceInformation	Unstructured remittance information specified by the Payee. If not empty, this MUST be included in the SCT underlying the MyBank transaction, in the "<RmtInf><Ustrd>" element. This attribute may be absent or empty. This attribute will be empty if transactionSCT01DB.remittanceInformationXML is not empty. Note: if the final beneficiary of the MyBank payment is a physical person (e.g., the holder of a gaming account, offered by the Merchant), then this attribute will have the following format:\ `FB/<full name of the final beneficiary>/<other information>` (e.g.: FB/John Doe/Order 123).	Max 140AN	/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/RmtInf/Ustrd
transactionSCT01DB.remittanceInformationXML	Structured remittance information specified by the Payee. If not empty, this SHOULD be included in the SCT underlying the MyBank transaction, in the "<RmtInf><Strd>" element. Please note that the value of this attribute will have the form "<Strd>...</Strd>". This attribute may be absent or empty. This attribute will be empty if transactionSCT01DB.remittanceInformation is not empty.	Max 255AN (including tag delimiters)	/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/RmtInf/Strd
transactionSCT01DB.requestedExecutionDate	Requested execution date for the payment (always set to the current date). In practice, this value may be ignored. If it is used, please take into account that a transaction might be initiated just before midnight and authorised just after midnight: in this case, requestedExecutionDate will obviously be set to "yesterday" with respect to the authorisation day.	YYYY”-“MM”-“DD”Z”
transactionSCT01DB.routingServiceID	Useful to identify the Payee PSP. This information might be useful in case of disputes or in case an investigation is needed for a transaction: If the Payee PSP gets in touch with the Payer PSP, it will typically communicate routingServiceID and transactionID. If the Payer PSP wants to get in touch with the Payee PSP, it should look up "MyBank Bilateral Contact List", finding the line where "Participant ID" matches routingServiceID.	MAX 35AN
transactionSCT01DB.sctInstPreferred	Flag indicating whether the Payee prefers to be paid via an Instant SCT ("1") or via an ordinary SCT ("0").	Boolean ("0","1")
transactionSCT01DB.token	Unique identifier of a MyBank transaction assigned by the MyBank Gateway.	Max 35AN (UUID)
transactionSCT01DB.transactionID	Identifier of a MyBank transaction assigned by the initiating side.	INTEGER Numeric (max 35 digits)
transactionSCT01DB.transactionStatus	MyBank transaction status. The possible values are: PENDING: the initial status of a transaction. It is not a final status. AUTHORISED: the transaction was authorised. AUTHORISINGPARTYABORTED: The Buyer refused to authorise the payment; for example, the Buyer clicked the “cancel” button in the Buyer Bank’s online banking environment or closed the browser window (if detected by the Bank). The Seller will not receive any funds for this transaction. TIMEOUT: The Buyer did not authorise the transaction within the the transactionSCT01DB.transactionValidityEnd. The transaction can no longer be authorised by the Buyer. The Seller will not receive any funds for this transaction. ERROR: An application level issue prevented the authorisation of the transaction. For example the Buyer failed to provide correct SCA during authorisation, the Buyer Bank refused the Buyer’s request for authorisation (block imposed by the Buyer Bank’s beneficiary “black list” procedures), a software issue at the Buyer Bank prevented authorisation. The Seller will not receive any funds for this transaction.	`"PENDING", "AUTHORISED"`, `"AUTHORISINGPARTYABORTED"`, `"ERROR"`, or `"TIMEOUT"`.
transactionSCT01DB.transactionStatusCreatedDate	Not relevant for the Payer PSP. DateTime of assignment of the initial transaction status.	YYYY”-“MM”-“DD”T”hh”:”mm”:”ss[“.”1(n)][“.”1(n)]”Z”
transactionSCT01DB.transactionValidityEnd	End DateTime of validity of the MyBank transaction. When this DateTime is reached, the Payer PSP must consider that the transaction is in "TIMEOUT" status; the Payer is not allowed to authorise the transaction anymore.	YYYY”-“MM”-“DD”T”hh”:”mm”:”ss[“.”1(n)][“.”1(n)]”Z”
transactionSCT01DB.transactionValidityStart	Not relevant for the Payer PSP. Start DateTime of validity of the MyBank transaction.	YYYY”-“MM”-“DD”T”hh”:”mm”:”ss[“.”1(n)][“.”1(n)]”Z”
transactionStatus	Final status of the MyBank transaction as determined by the Payer PSP. The possible values are: AUTHORISED: the transaction was authorised AUTHORISINGPARTYABORTED: The Buyer refused to authorise the payment; for example, the Buyer clicked the “cancel” button in the Buyer Bank’s online banking environment or closed the browser window (if detected by the Bank). The Seller will not receive any funds for this transaction. ERROR: An application level issue prevented the authorisation of the transaction. For example the Buyer failed to provide correct SCA during authorisation, the Buyer Bank refused the Buyer’s request for authorisation (block imposed by the Buyer Bank’s beneficiary “black list” procedures), a software issue at the Buyer Bank prevented authorisation. The Seller will not receive any funds for this transaction.	`"AUTHORISED"`, `"AUTHORISINGPARTYABORTED"`, or `"ERROR"`.
transactionStatusModifiedDate	DateTime of assignment of the final status of the MyBank transaction by the Payer PSP.	YYYY”-“MM”-“DD”T”hh”:”mm”:”ss[“.”1(n)][“.”1(n)]”Z”