otc file upload payments - xml - mexicootc xml v3 published: february 2017 1 introduction this...
TRANSCRIPT
Published: February 2017 1
User Guide
OTC Payments XML v3 - Mexico
February 2017
OTC XML v3
Published: February 2017 i
Disclaimer
This document is issued by HSBC Bank plc (‘HSBC’). HSBC Bank Plc is authorised by the Prudential
Regulation Authority and regulated by the Financial Conduct Authority and the Prudential Regulation
Authority (Registration Number 114216). This document is for information purposes only and does not
constitute or form any part of (i) any invitation or inducement to engage in investment activity, or (ii) any
offer, solicitation or invitation by HSBC or any of the HSBC Group for the sale or purchase of any products,
services and/or any investments.
HSBC provides this document to the recipient on an ‘as is’ basis and except as provided herein, does not
warrant that the contents of this document is accurate, sufficient or relevant for the recipient’s purposes.
HSBC may have obtained information in this document from sources including from third party suppliers,
it believes to be reliable but which have not been independently verified. In relation to information on
products and/or services supplied by a third party supplier, the recipient should obtain further information
on these products and/or services directly from the supplier.
Please note that this document may contain hypertext links to websites operated by other members of the
HSBC group and third parties respectively. In relation to hypertext links to websites operated by members
of the HSBC group, please read the terms and conditions of the linked website. In relation to hypertext
links to websites operated by third parties, please note that: (1) the recipient should read the terms and
conditions of the website; and (2) HSBC does not have any control whatsoever over these websites and
shall not be liable for the recipient’s use of them.
HSBC will use its reasonable endeavours to ensure that the contents of this document are current at the
date of its first publication. HSBC gives no undertaking and is under no obligation to provide the recipient
with access to any additional information or to update all or any part of the contents of this document or
to correct any inaccuracies in it which may become apparent.
HSBC is not responsible for providing the recipient with any legal, tax or other advice regarding the
contents of this document and the recipient should make its own arrangements in respect of this
accordingly. This document has not been prepared to address the specific requirements or objectives of
any particular client. The recipient is solely responsible for making its own independent appraisal of an
investigation into the products, services and other content referred to in this document.
This document should be kept confidential and shall be used for internal business purposes only by the
recipient to whom it is provided and its officers, employees and agents. This document should be read in
its entirety and shall not be photocopied, reproduced, distributed or disclosed in whole or in part to any
other person without the prior written consent of the relevant HSBC Group member. This document is
proprietary to HSBC and the recipient agrees on request to return or, if requested, to destroy this
document and all other materials received relating to the information contained herein.
Except in the case of fraudulent misrepresentation and/or breach of these terms, no liability is accepted
whatsoever by HSBC and the HSBC Group for any direct, indirect or consequential loss arising from the
use of this document.
Please contact your local HSBC representative for further information on the availability of products and/or
services discussed herein in your region.
© Copyright. HSBC Bank plc 2017 ALL RIGHTS RESERVED.
OTC XML v3
Published: February 2017 ii
Contents
Disclaimer.................................................................................................................. i
Introduction..............................................................................................................1
Report Entitlements.................................................................................................................... 1
Upload a file ............................................................................................................................... 2
File specifications of the XML v3............................................................................3
Mapping ..................................................................................................................................... 3
File Example OTC next day ....................................................................................................... 5
File Example OTC same day ..................................................................................................... 6
File Errors.................................................................................................................7
Appendix ..................................................................................................................8
Table of Valid Characters........................................................................................................... 8
Status......................................................................................................................................... 8
OTC XML v3
Published: February 2017 1
Introduction
This message Implementation Guideline (MIG) is prepared by HSBC for data being submitted through
HSBCnet File upload.
The purpose of this document is to provide guidance for the creation of a XML Version 3 for OTC Payments
for Mexico Ordering Accounts.
Payment Disbursement (OTC Payment) is an instruction with a reference that you can provide to a
beneficiary and it can be payable at any branch of HSBC in Mexico. The reference can be uploaded and
paid with same day value or with a forward value date, regardless if the beneficiaries have a bank account
in HSBC or not.
The beneficiaries can choose the payment option that best suits their needs:
In cash (up to the maximum allowed for cashier's check)
Credited to an HSBC account
With cashier check if the payee does not have an account with HSBC and the amount is greater
than the maximum allowed for bearer checks
Automated Payment Dispersion files can be sent using Same Day or Next Day instruction type, depending
on the product feature contracted locally. The payments can be settled at México HSBC branches according
to OTC feature contracted:
Online. Payments available half an hour after the file submission or,
Next business working day. Payments available next working day.
Each payment must be linked to a unique reference that cannot be duplicated for one year after having
been paid, expired or cancelled.
The status of the payments can be modified, by using a new file. The status that you can send are: 01 –
New, 03 – Cancelled, 04 – Stand by, 05 – Reactivation.
Open hours
The open hour’s service for OTC Same day Payments is 08:00am to 17:30hrs (Mexico Central time GMT -
6:00) from Monday to Friday in working days.
The open hour’s service for OTC Next day Payments is 08:00am to 18:000hrs (Mexico Central time GMT -
6:00) from Monday to Friday in working days.
Report Entitlements
System Administrators are required to grant entitlements to Users who will received the OTC Reports,
which are available in the Report and File download entitlement screen.
HSBC will deliver XML response files.
MX-HBMI-OTC EOD REJECTIONS REPORT: Rejection status update, this come for OTC same day and
next day
MX-HBMI-OTC EOD STATUS REPORT: next day payment status update for both type of payments (same
day or next day)
OTC XML v3
Published: February 2017 2
MX-HBMI-OTC ONLINE RESPONSE: this come only for OTC same day files, one hour after file has been
sent
Reports and file download entitlement screen
Upload a file
To upload your file, select the file, format and authorisation level:
File Types: ACH Credits
File Format: XML
Authorisation Level: File level details or File level summary
File upload
OTC XML v3
Published: February 2017 3
File specifications of the XML v3
This section describes the requirements for managing a payment instruction (creation, cancelation,
reactivation or suspension) which is settled when the beneficiary visits an HSBC Mexico branch to collect
the payment instruction in either cash, cashier check or by transferring the amount to an HSBC account.
Mapping
XML Data TagField Format
XML (MaxLength)
Instruction field RemarksMandatory’M’/Optional ‘O’
GroupHeader <GrpHdr>
Message ID <MsgId> Char(35) File NameThis will be unique in a period of 90days
M
Creationdatetime <CreDtTm> Char(19)Date and Timeof Creation File
Cannot be more than 5 days for thepastyyyy-mm-ddThh:mm:ss
M
NumberOfTransactions<NbOfTxs>
Char(15)Number oftransactions
M
InitiationParty
<InitgPty><Id>
<OrgId><Othr>
<Id>
Char(11)Customer ABCID
M
PaymentInformation <PmtInf>
PaymentInformationIdentification
<PmtInfId> Char(35)ID of thePaymentInformation
M
PaymentMethod <PmtMtd> Char(3)PaymentMethod
Fill with ‘CHK’ M
PaymentTypeInformation<PmtTpInf><SvcLvl>
<Cd>- Folio
For Same Day instructions thefollowing fix value must be used:“SDVA”For Next Day instructions thestructure must be eliminate
M/O
LocalInstrument<LclInstrm>
<Prtry>Char(4)
Identifier forXML V3
XML v3 OTC instructions must havea fixed 'CASH' value in theproprietary code field.
M
RequestedExecutionDate <ReqdExctnDt> N(10) Value date
Valid format: YYYY-MM-DD.This date must be the current datefor same day instructions or onefuture date for next day instructions.
M
DebtorName<Dbtr><Nm>
Char(35)Name of theOrderingaccount
M
Address
<Dbtr><PstlAdr><StrtNm><BldgNb><PstCd>
<TwnNm>
- Address M
Country<Dbtr>
<PstlAdr><Ctry>
Char(2)Country of theOrderingAccount
Always be ‘MX’ M
DebtorId
<Dbtr><Id>
<OrgId><Othr><Id>
-ServiceNumber
DAP key – number must be >0 M
OTC XML v3
Published: February 2017 4
DebtorAccount
<DbtrAcct><Id>
<Othr><Id>
Char(10)MX OrderingAccountNumber
M
DebtorAgent<DbtrAgt>
<FinInstnId><BIC>
-Local bankcode or BICcode
BIC Code as BIMEMXMM M
Country
<DbtrAgt><FinInstnId>
<PstlAdr><Ctry>
Char(2)Country of theOrderingAccount
Always be ‘MX’ M
CreditTransferTransactionInformation <CdtTrfTxInf>
InstructionId<PmtId><InstrId>
Char(30)InstructionIdentification
O
EndToEndIdentification <PmtId><EndToEndId>
Char(30) Reference
Unique reference for Instruction in aperiod of a year. The validcharacters are numbers and capitalletters without ‘Ñ’ and accents.
M
InstructedAmount <Amt><InstdAmt>
N(18)Currency /Paymentamount
Only MXN currency is allowed
Payment amount, last two digits aredecimals and decimal point in thirdfrom right. Must be between 1.00MXN to 9,999,999,999,999.99
M
ChequeInstructionChequeMaturityDate
<ChqInstr><ChqMtrtyDt>
N(10) Expiration date
Valid format: YYYY-MM-DD.The Maturity Date must be greaterthan the Requested Execution Dateand not greater than 1 year
M
CreditorName<Cdtr><Nm>
Char(70)BeneficiaryName
Payment Beneficiary name. Thevalid characters are numbers andcapital letters without ‘Ñ’ andaccents
M
CreditorAccount
<CdtrAcct><Id>
<Othr><Id>
N(10)Beneficiaryaccount
"0000000000" M
InstructionForDebtorAgent <InstrForDbtrAgt> Char(35) Status
Status‘01’ – New‘03’ – Cancelled‘04’ – Suspended / On Hold‘05’ – Reactivation
M
OTC XML v3
Published: February 2017 5
File Example OTC next day
OTC XML v3
Published: February 2017 6
File Example OTC same day
OTC XML v3
Published: February 2017 7
File Errors
If your file is presented with any of the following error messages this means your file is rejected and the
whole file has to be re-summited.
ErrorCode
Error Description Description
CFR FILE FILED WITH SYNTATICAL ERROR Please verify file format, spaces, etc
05 DUPLICATE FILE There is another same file uploaded before
07 INVALID RECORD COUNT Check if value equal to total number of instruction in the file
06 FILE CREATION DATE OLDER THAN 5 DAYSCheck if this date is less than current date
05 CREDIT ACCOUNT MISSINGBeneficiary account was not presented or it was filled with spaces
10 VALUE DATE BEFORE CURRENT DATEValue date is before current date, more than 5 days
86 DUPLICATED CUSTOMER REFERENCEThe Customer Reference is already used in a past file
UX BENEFICIARY NAME IS MANDATORYPlease enter the Beneficiary Name
04 UNKNOWN SENDERThe ABC ID has invalid format or is incorrect
OTC XML v3
Published: February 2017 8
Appendix
Table of Valid Characters
Valid characters
0 A K U
1 B L V
2 C M W
3 D N X
4 E O Y
5 F P Z
6 G Q
7 H R
8 I S
9 J T
Status
The Acknowledgment Report (pain.001.001.03) will contains 3.19 TransactionStatus <TxSts>(XML V3) as
‘ACCP’ (AcceptedCustomerProfile) for accepted transaction and ‘RJCT’(Rejected) for rejected transaction.
Successful instructions ‘ACCP’ sent in the MX-HBMI-OTC EOD STATUS REPORT
Example:
<TxSts>ACCP</TxSts>- <StsRsnInf>
<AddtlInf>NEW</AddtlInf>
</StsRsnInf>
Descripción del Estatus
<StsRsnInf>
<AddtInf>
NEW
PAID
CANCELLED
STAND BY
REACTIVATION
REACTIVATED AND PAID
EXPIRED AND UNPAID
THE SCATTERER CANCELED THE PAYMENT IN TRANSIT OR AVAILABLE
THE SCATTERER CANCELED THE SUSPENDED PAYMENT
THE SCATTERER CANCELED THE PAYMENT REACTIVATED
THE SCATTERER REACTIVATED THE SUSPENDED PAYMENT
OTC XML v3
Published: February 2017 9
Rejections ‘RJCT’ sent in the MX-HBMI-OTC EOD REJECTIONS REPORT
Example
<TxSts>RJCT</TxSts>- <StsRsnInf>
- <Rsn>
<Cd>NARR</Cd>
</Rsn>
<AddtlInf>INVALID STATUS CHANGE</AddtlInf>
</StsRsnInf>
Descripción del Estatus
<StsRsnInf>
<AddtInf>
REJECTED IT FAILED TO COMPLY WITH THE FORMAT
REJECTED THE REFERENCE ALREADY EXISTS IN THE DB.
REJECTED THE REFERENCE ALREADY EXISTS AND WAS LIQUIDATED
REJECTED THE REFERENCE ALREADY EXISTS AND WAS CANCELED
REJECTED THE REFERENCE ALREADY EXISTS AND IS SUSPENDED
REJECTED THE REFERENCE ALREADY EXISTS AND IS REACTIVATED
REJECTED THE REFERENCE ALREADY EXISTS AND IS LIQUIDATED
REJECTED THE MODEL ALREADY EXISTS AND LAPSED IT
REJECTED IT FAILED TO COMPLY WITH THE FORMAT
THE INSTRUCTION TO CANCEL WAS ALREADY PAID
THE INSTRUCTION TO CANCEL WAS ALREADY EXPIRED
REJECTED IT FAILED TO COMPLY WITH THE FORMAT
THE INSTRUCTION TO SUSPEND WAS ALREADY PAID
THE INSTRUCTION TO SUSPEND WAS ALREADY CANCELED
THE INSTRUCTION TO SUSPEND WAS ALREADY SUSPENDED
THE INSTRUCTION TO SUSPEND WAS ALREADY PAID
THE INSTRUCTION TO SUSPEND WAS ALREADY EXPIRED
REJECTED FAILED TO COMPLY WITH THE FORMAT
THE INSTRUCTION TO REACTIVATE WAS ALREADY ACTIVE
THE INSTRUCTION TO REACTIVATE WAS ALREADY PAID
THE INSTRUCTION TO REACTIVATE WAS ALREADY CANCELED
THE INSTRUCTION TO REACTIVATE WAS ALREADY REACTIVATED
THE INSTRUCTION TO REACTIVATE WAS ALREADY EXPIRE
OTC XML v3
Published: February 2017 10
Status sent in the MX-HBMI-OTC ONLINE RESPONSE
Desciprión del Estatus
<StsRsnInf>
<AddtInf>
ACTION SUCCESSFULLY CARRIED
RECORDED SUCCESSFULLY
ACCOUNT NOT FOUND
INVALID ACCOUNT
WITHOUT REFERENCE
INVALID STATUS CHANGE
INSTRUCTION ALREADY EXISTS
INVALID AMOUNT
INVALID EXPIRATION DATE
ACCOUNT IS NOT GLOBAL FOR SERVICE
ACCOUNT NO REAL
INVALID SERVICE NUMBER
NO CHANGE TO BE MADE
INVALID ACCOUNT STATUS
OTC XML v3
Issued by HSBC Bank plc
© HSBC Bank plc 2017. All rights reserved