Payment Initiation API Specification V1.0 Contents

Total Page:16

File Type:pdf, Size:1020Kb

Payment Initiation API Specification V1.0 Contents Coventry Building Society Payment Initiation API Specification V1.0 Contents Coventry Building Society .................................................................................................................................................... 1 Version control ..................................................................................................................................................................... 4 Overview .............................................................................................................................................................................. 5 Document Overview ........................................................................................................................................................ 5 Design Principles ............................................................................................................................................................. 5 RESTful APIs ............................................................................................................................................................... 5 Idempotency ................................................................................................................................................................ 6 Payment API - Scheme Agnostic ................................................................................................................................ 6 Status Codes ............................................................................................................................................................... 6 Scope ............................................................................................................................................................................... 6 Out of Scope .................................................................................................................................................................... 6 Basics ................................................................................................................................................................................... 7 Steps ........................................................................................................................................................................... 7 Sequence Diagram ...................................................................................................................................................... 9 Actors ............................................................................................................................................................................. 10 Character Encoding ....................................................................................................................................................... 10 Date Formats ................................................................................................................................................................. 10 Resource URI Path Structure ........................................................................................................................................ 10 Payment Limits. ............................................................................................................................................................. 11 Headers ......................................................................................................................................................................... 11 Request Headers ....................................................................................................................................................... 11 Response Headers .................................................................................................................................................... 12 Return & Error Codes .................................................................................................................................................... 12 400 (Bad Request) v/s 404 (Not Found) ................................................................................................................... 13 403 (Forbidden) ......................................................................................................................................................... 13 429 (Too Many Requests) ......................................................................................................................................... 13 Pre-Conditions ............................................................................................................................................................... 14 Pre-conditions for TPPs ............................................................................................................................................ 14 Idempotency .................................................................................................................................................................. 14 Filtering .......................................................................................................................................................................... 14 Pagination ...................................................................................................................................................................... 14 Regulatory Considerations ............................................................................................................................................ 14 PSD2 - Article 48 ....................................................................................................................................................... 15 Endpoints ........................................................................................................................................................................... 15 https://resourcema.coventrybuildingsociety.co.uk/open-banking/v1.0/mandates ......................................................... 15 POST /payments ........................................................................................................................................................... 16 Payment Status ......................................................................................................................................................... 16 GET /payments/{PaymentId} ......................................................................................................................................... 16 Payment Status ......................................................................................................................................................... 16 POST /payment-submissions ........................................................................................................................................ 17 Payment Submission Status ..................................................................................................................................... 17 GET /payment-submissions/{PaymentSubmissionId} ................................................................................................... 18 Payment Submission Status ..................................................................................................................................... 18 POST /open-banking/mandates .................................................................................................................................... 18 Payment Status ......................................................................................................................................................... 18 GET /open-banking/mandates/{PaymentId} ................................................................................................................. 19 Payment Status ......................................................................................................................................................... 19 POST /open-banking/mandate-submissions ................................................................................................................ 19 Payment Submission Status ..................................................................................................................................... 20 GET /open-banking/mandate-submissions/{PaymentSubmissionId} ............................................................................ 20 Payment Submission Status ..................................................................................................................................... 20 Sandbox API Endpoints ..................................................................................................................................................... 21 POST /open-banking-sandbox/v1.0/payments .............................................................................................................. 21 GET /open-banking-sandbox/v1.0/payments/{PaymentId} ........................................................................................... 21 Security & Access Control .................................................................................................................................................. 21 API Scopes ...................................................................................................................................................................
Recommended publications
  • Standards at Transactional and Aggregated Level
    Standards at transactional and aggregated level 7th May 2014 eSupervision Workshop, Rome Overview The value, need and ability to capture transactions in a standard way in repositories as a foundation for regulatory analysis using the example of ISO 20022 The value of and need for connecting the transactional and detailed-level data standards and models (ISO 20022, ACORD, FpML, FIBO, FIX) with regulatory or aggregated data standards (XBRL, SDMX, XML) First, a look at internationally developed data standards for financial services and the ISO 20022 standard International Standards for Financial Services, ISO/TC68 ISO Technical Committee TC68 Financial Services SC2 SC4 SC7 ISO 20022 Security Securities Core Banking Standard ISO 20022 WG5 Registration ISO 20022 Technical LEI Management Standard Standard Group ISO 17442 Technical Registration Support Authority Group Standard Evaluation Groups Standards Managed by ISO/TC68/SC2, Security ISO TC68/SC2 Financial Services, Security Published Standards – ISO 9564 Personal Identification Number (PIN) management and security – ISO 11568 Key management (retail) – ISO 13491 Secure cryptographic devices (retail) – ISO 13492 Key management related data element -- Application and usage of ISO 8583 data elements 53 and 96 – ISO 15782 Certificate management for financial services (PKI) – ISO 16609 Requirements for message authentication using symmetric techniques – ISO 21188 Public key infrastructure management for financial services - Practices and policy framework Technical Reports ISO 13569 Information
    [Show full text]
  • Securetrust Service Description Web Risk Monitoring
    SecureTrust Service Description Web Risk Monitoring Copyright © 2018 Trustwave Holdings, Inc. All rights reserved. 1 SecureTrust WRM Service Description - January 27, 2021 WEB RISK MONITORING (WRM) ................................................................................................................ 3 SERVICE DESCRIPTION ................................................................................................................................. 3 BASE SERVICE FEATURES ............................................................................................................................. 3 WRM Overview ....................................................................................................................................... 3 Content Monitoring ................................................................................................................................. 5 Merchant Intelligence.............................................................................................................................. 5 Malware Monitoring ................................................................................................................................ 7 Custom Monitoring.................................................................................................................................. 8 Transaction Laundering Detection (TLD) ............................................................................................... 8 Merchant MCC Code Matching .............................................................................................................
    [Show full text]
  • Czech Standard for Open Banking (V 3.0)
    Banking Activities Standards Standard ČBA Czech Standard for Open Banking Version 3.0 Public from: 1.4. 2019 Valid from: 1.1. 2020 1 Changes Date Note Author 15.11.2017 Basic document v.01 ČS Petr Michalík 27.7.2018 Document version 1.2 - Correction of typing errors, new error codes, new ČS Petr Michalík chart visualizations, coupled payment type codes in response to initiation of payment (Chapter 4.24.2.1) and general element descriptions added / specified. 9.4.2018 Document v.02.0 -- An extension to initiate Instant Payment has been ČS Petr Michalík added to the standard. Any further processing of such initiated payment is done according to the rules of this scheme. Chapter 3.2.4, 4.24.1 and 4.25 18.5.2018 Added new request header parameters for original TPP identification ČS Petr Michalík 19.9.2018 Extended description of the use of certificates in chaper 1.4.8 ČS Petr Michalík 2.10.2018 New request body element “redirectUrl”. Address in this element ČS Petr Michalík is used by the federated bank authorization to redirect back to the TPP application after authorization is complete. Chapter 3.2.10.1 and example in chapter 5.11.1 2.10.2018 Error response extension for NO_PART error code during ČS Petr Michalík payment initiation. Chapter 3.2.4 and new example in chapter 5.5.6 1.12.2018 Specification the use of the character set for each resource. ČS Petr Michalík Chapter 1.2.5, 3.1.1, 3.2.1, 3.3.1, 3.2.3, 3.2.4 – 11, 3.3.3 21.12.2018 Final public document COBS 2.0 ČS Petr Michalik 3.1.2019 New version document – v.03 ČS Petr Michalík 4.1.2019 Standing order resource for PIS services ČS Petr Michalík Chapters 3.2.12 – 3.2.18 4.1.2019 For each source, information on the implementation obligation has been ČS Petr Michalík added (see resource parameter Mandatory: yes/no) 5.1.2019 Consent management resources (POST and DELETE) ČS Petr Michalík See Chapter 1.6.x 12.1.2019 Common header parameters ČS Petr Michalík See Chapter 1.5 and changes in the header parameters specifications of the all defined resources.
    [Show full text]
  • BNP Paribas PF PSD2 Services
    Central and Eastern Europe region: API Developer Portal – PSD2 services BNP Paribas PF PSD2 Services BNP Paribas PF provides the following open-banking APIs: TPP management Authentication service (oAuth 2.0) Balance check for card-issuing providers (CIS) Account information service (AIS) Payment initiation service (PIS) Standing orders service For SandBox setup and testing, we do recommend to download to use Swagger 2.0 TPP Management TPP Management API can be used for registration of TPP to the Bank. swagger: '2.0' info: title: TPP Management API description: API for managing Third Party Payment Providers version: 1.7.0 host: api.hellobank.cz schemes: - https produces: - application/json basePath: /tpp-management/api/v1 paths: /tpps: post: summary: TPP Registration description: | The TPP Registration Endpoint. consumes: - application/json parameters: - $ref: '#/parameters/x-api-header' - $ref: '#/parameters/x-user-agent-info' - in: body name: profile BNP Paribas PF CEE region – API Documentation required: true schema: $ref: '#/definitions/TPPRegistrationRequest' tags: - tpps responses: '201': description: Created schema: $ref: '#/definitions/RegistrationResponse' '400': description: >- Invalid request. A mandatory field is missing in the request, or it is in an unsuitable / invalid format. schema: $ref: '#/definitions/Errors' '401': description: The client is not unauthorized to execute the request. schema: $ref: '#/definitions/Errors' '403': description: Insufficient authorization to use the required scope. schema: $ref: '#/definitions/Errors' '500': description: Server error. schema: $ref: '#/definitions/Errors' definitions: TPPRegistrationRequest: type: object required: - redirect_uris - scopes properties: applicationType: type: string description: >- Type of application which uses this account (web or native). Will not be used for CZ. This field will be ignored if comming on the request.
    [Show full text]
  • Nextgenpsd2 Framework
    Joint Initiative on a PSD2 Compliant XS2A Interface NextGenPSD2 XS2A Framework Implementation Guidelines Version 1.3.8 30 October 2020 License Notice This Specification has been prepared by the Participants of the Joint Initiative pan-European PSD2-Interface Interoperability* (hereafter: Joint Initiative). This Specification is published by the Berlin Group under the following license conditions: "Creative Commons Attribution-NoDerivatives 4.0 International Public License" This means that the Specification can be copied and redistributed in any medium or format for any purpose, even commercially, and when shared, that appropriate credit must be given, a link to the license must be provided, and indicated if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use. In addition, if you remix, transform, or build upon the Specification, you may not distribute the modified Specification. Implementation of certain elements of this Specification may require licenses under third party intellectual property rights, including without limitation, patent rights. The Berlin Group or any contributor to the Specification is not, and shall not be held responsible in any manner for identifying or failing to identify any or all such third party intellectual property rights. The Specification, including technical data, may be subject to export or import regulations in different countries. Any user of the Specification agrees to comply strictly with all such regulations and acknowledges that it has the responsibility to obtain licenses to export, re-export, or import (parts of) the Specification. * The ‘Joint Initiative pan-European PSD2-Interface Interoperability’ brings together participants of the Berlin Group with additional European banks (ASPSPs), banking associations, payment associations, payment schemes and interbank processors.
    [Show full text]
  • Message Definition Report Document
    Standards E-invoice Electronic Presentment and Presentment Service Standards MX Message Definition Report Document For public consultation and review This document provides details of the messages for E-invoice Electronic Presentment and Presentment Service. 14 June 2019 Message Definition Report Document Table of Contents For public consultation and review E-invoice Electronic Presentment and Presentment Service for Standards MX Table of Contents 1 Message Set Overview ...................................................................................................................................... 3 1.1 List of MessageDefinitions ........................................................................................................................... 3 2 MX DRAFT3reda.066.001.01 EIPPCreditorEnrolmentRequestV01 ................................................ 4 2.1 MessageDefinition Functionality .................................................................................................................. 4 2.2 Structure .......................................................................................................................................................... 5 2.3 Constraints ...................................................................................................................................................... 6 2.4 Message Building Blocks .............................................................................................................................. 7 3 MX DRAFT3reda.070.001.01 EIPPDebtorActivationRequestV01
    [Show full text]
  • Next Generation Standard for UK Retail Payments
    Next Generation Standard for UK Retail Payments Conclusions & Shaping the Way Ahead 30/11/2020 Next Generation Standard for UK Retail Payments Conclusions & Shaping the Way Ahead Contents NEXT GENERATION STANDARD FOR UK RETAIL PAYMENTS 1 FOREWORD – JAMES WHITTLE, DIRECTOR OF STANDARDS AT PAY.UK 4 INTRODUCTION 5 EXECUTIVE SUMMARY 6 STRATEGIC DIRECTION ON STANDARDS 8 WHAT DO THE RESULTS OF THIS CONSULTATION MEAN FOR YOU? 11 NEXT GENERATION ISO 20022 FOR UK RETAIL PAYMENTS 16 SECTION A: RECOMMENDED DIRECTION THAT WE ARE PROPOSING ON THE ADOPTION OF ISO 20022 FOR THE CLEARING AND SETTLEMENT CAPABILITY TO BE ENABLED BY THE NEW PAYMENTS ARCHITECTURE. 16 LEGAL ENTITY IDENTIFIERS (LEIS) 16 STRUCTURED DATA 18 PURPOSE CODES 19 ENHANCED CHARACTERS 21 ENHANCED REMITTANCE DATA 21 UNIQUE END-TO-END TRANSACTION REFERENCE (UETR) 22 SUMMARY OF PROPOSED IMPLEMENTATION OF THE BUILDING BLOCKS 24 LIKE-FOR-LIKE TRANSITION 24 MARKET GUIDANCE 25 DATA TRANSLATION 25 SECTION B: FOUNDATIONAL TECHNICAL DETAILS FOR THE ISO 20022 MESSAGE STANDARD INCLUDING OUR TECHNICAL DESIGN AND ISO 20022 READINESS APPROACH. 26 NPA STANDARDS TECHNICAL DESIGN 26 STANDARDS SOURCE PORTAL 29 READINESS AND VALIDATION APPROACH 30 2 | 30/11/2020 © Pay.UK 2020 Next Generation Standard for UK Retail Payments Conclusions & Shaping the Way Ahead SECTION C: FUTURE DIRECTION ON CONCEPTS THAT REQUIRE A DEGREE OF STANDARDISATION ACROSS THE PAYMENTS ECOSYSTEM. 32 LIQUIDITY INTERFACE STANDARD 32 PAYMENT METADATA STANDARDS 34 STANDARDS TO ENABLE MARKET DIFFERENTIATION 35 PAYMENT AUTHORISATION STANDARD 37 EXCEPTIONS AND INVESTIGATIONS 38 CONCLUDING REMARKS 40 GLOSSARY OF TERMS 41 3 | 30/11/2020 © Pay.UK 2020 Next Generation Standard for UK Retail Payments Conclusions & Shaping the Way Ahead Foreword – James Whittle, Director of Standards at Pay.UK Thank you to everyone that took the time to respond to our Consultation and for your ongoing input and challenge.
    [Show full text]
  • Standards Confirmed
    Standards published New International Standards published between 01 October and 31 October 2017 * Available in English only ** French version of standard previously published in English only Price group TC 4 Rolling bearings ISO 15242-4:2017 Rolling bearings — Measuring methods for vibration — Part 4: Radial cylindrical roller bearings with cylindrical bore and outside surface B TC 5 Ferrous metal pipes and metallic fittings ISO 9349:2017 Ductile iron pipes, fittings, accessories and their joints — Thermal preinsulated products B TC 6 Paper, board and pulps ISO 2528:2017 Sheet materials — Determination of water vapour transmission rate (WVTR) — Gravimetric (dish) method C TC 8 Ships and marine technology ISO 21070:2017 * Ships and marine technology — Marine environment protection — Management and han- dling of shipboard garbage D ISO 7825:2017 * Shipbuilding — Deck machinery — General requirements A ISO 20154:2017 * Ships and marine technology — Guidelines on vibration isolation design methods for ship- board auxiliary machinery B TC 17 Steel ISO 13887:2017 * Steel sheet, cold-reduced, of higher yield strength with improved formability B TC 20 Aircraft and space vehicles ISO 18322:2017 * Space systems — General management requirements for space test centres D TC 22 Road vehicles ISO 12251:2017 * Diesel engines — Clamp mounted CR fuel injectors — Mounting dimensions B ISO/TS 17536-2:2017 * Road vehicles — Aerosol separator performance test for internal combustion engines — Part 2: Laboratory test method D ISO 6487:2015/Amd Road vehicles
    [Show full text]
  • Of Ameican National Standards, Drafts and Technical
    ACCREDITED STANDARDS COMMITTEE X9, INC., FINANCIAL INDUSTRY STANDARDS OF AMEICAN NATIONAL STANDARDS, DRAFTS AND TECHNICAL CATALOG OF FINANCIAL INDUSTRY AMERICAN NATIONAL STANDARDS, DRAFT STANDARDS FOR TRIAL USE, TECHNICAL REPORTS and TECHNICAL GUIDELINES March 2010 ASC X9, Inc. 1212 West Street, Suite 200, Annapolis, Maryland 21401 www.x9.org TABLE OF CONTENTS ASC X9, INC FINANCIAL INDUSTRY STANDARDS TABLE OF CONTENTS PG. 2 HOW TO PURCHASE STANDARDS PG. 5 TERMS AND DEFINITIONS PG. 6 X9’s ELECTRONIC BENEFITS TRANSFER (EBT) SET PG. 7 X9’s SECURITY COLLECTION PG. 7 X9’s IMAGE COLLECTION PG. 7 X9’s MICR DOCUMENT PRINTING COLLECTION PG. 8 X9’s CRYPTOGRAPHIC MESSAGE COLLECTION PG. 9 X9’s ENCRYPTION COLLECTION PG. 9 X9’s CHECK IMAGE COMPLIANCE COLLECTION (Formerly Check 21) PG. 9 X9’s DTSU X9.100-172 SET PG. 10 PAPER CHECK STANDARDS PG. 11-16 X9/TR-100 Organization of Standards for Paper-Based and Image-Based Payments X9/TR-2 Understanding and Designing Checks X9/TR-6 Quality Control of MICR Documents X9/TG-8 Check Security Guideline X9.7 Bank Check Background and Numerical Convenience Amount Field X9.100-10 Paper Specifications for Checks (formerly X9.18) X9.100-111 Specifications for Check Endorsements (formerly X9.53) X9.100-130 Specifications for Universal Interbank Batch/Bundle (formerly X9.64) X9.100-151 Check Correction Strip Specification (formerly X9.40) X9.100-160-1 Placement and Location of Magnetic Ink Printing (MICR) (formerly X9.13) X9.100-160-2 Placement and Location of Magnetic Ink Printing (MICR) Part 2: EPC Field Use (formerly
    [Show full text]
  • Retail Banking Payments Standards Introduction Standards in Retail
    Central Bank of Egypt – Retail Payments Standards Retail Banking Payments Standards Introduction Standards in retail payments are vital for ensuring consistency across all domestic payments systems and compatibility with international norms. The primary basis for standards will be those defined by the International Organization for Standardization (ISO) for the financial services sector. The ISO standards defined by Technical Committee TC68 are specific to financial services and deal more with applications than technical specifications. Over the years ISO has delegated responsibility to different standards committees that act in specialized areas to augment the capacity of the ISO. The Joint Technical Committee (JTC) is one such committee that has been given responsibility for cards. They work in conjunction with the International Electrotechnical Commission (IEC) to develop the card standards. They develop standards for all cards including those used in the financial industry and others such as health care, transportation and others. In addition, other standards have developed around security. Important standards for security as regards payment cards are set by the Payment Card Industry (PCI) Security Standards Council (SSC). These standards aim to reduce the potential for card fraud, hacking and various other security vulnerabilities and threats. Compliance with the aforementioned standards will help to build the basis for interoperability across systems in Egypt. This is a key goal of this process. Each of the recommended standards will be briefly defined below. It is recommended that compliance with these be discussed and communicated to all stakeholders in the Egyptian payments community. Standards related to the financial services industry are evolving all the time.
    [Show full text]
  • Interchange Fee Regulation on the Application Of
    Study on the application of the Interchange Fee Regulation Final Report Prepared by Competition EUROPEAN COMMISSION Directorate-General for Competition E-mail: [email protected] European Commission B-1049 Brussels [Cataloguenumber] Study on the application of the Interchange Fee Regulation Final report Europe Direct is a service to help you find answers to your questions about the European Union. Freephone number (*): 00 800 6 7 8 9 10 11 (*) The information given is free, as are most calls (though some operators, phone boxes or hotels may charge you). LEGAL NOTICE The information and views set out in this report are those of the author(s) and do not necessarily reflect the official opinion of the Commission. The Commission does not guarantee the accuracy of the data included in this study. Neither the Commission nor any person acting on the Commission’s behalf may be held responsible for the use which may be made of the information contained therein. More information on the European Union is available on the Internet (http://www.europa.eu). Luxembourg: Publications Office of the European Union, 2020 Catalogue number: KD- 01-20-161-EN-N ISBN 978-92-76-17165-2 doi: 10.2763/137970 © European Union, 2020 Reproduction is authorised provided the source is acknowledged. The reproduction of the artistic material contained therein is prohibited. Authors: Ernst & Young Team Members: • Dr. Ferdinand Pavel (Germany, EY) • Andreas Kornowski (Germany, EY) • Dr. Lars Knuth (Germany, EY) • Chris Rücker (Germany, EY)– • Maria Bernstein (Germany,
    [Show full text]
  • BCL CDDP6 Workshop #2 Presentation
    CDDP6 Workshop #2 10 March 2021, virtual WebEx event Section Infrastructures & Systèmes de Paiements (ISP): Pierre Thissen, Myriam Becker, Pavel Dvořák Section Oversight (OS): Eva Bonte WebEx rules & Session format . Rules: . All participants are muted on entry, but might unmute themselves during the meeting . Please keep your microphone muted if you do not speak . Ask questions in the chat (with everyone) please . Private chat is disabled, messages are visible to everyone . Participants are allowed to turn on the video . The host (BCL) will share the screen . Session format . Workshops are not recorded. Slides and follow-up will be distributed tomorrow . BCL presents some examples – please challenge BCL on your specificities - questions in the chat please . All outstanding points will be followed up by BCL (with the ECB) 2 Feedback Please give us anonymous feedback (click on the link OR scan the QR code) https://epsilon.escb.eu/limesurvey3/917524?lang=en 3 BCL manual on payment statistics – new format From static PDF -> Excel file with hyperlinks . Watch 7 min explanatory video (with subtitles) . https://youtu.be/EwSCSCG31QM 4 BCL manual on payment statistics – sheet Modifications . Reminder: the BCL manual on payment statistics is not yet intended for production . However, list of all changes since the first published version is listed on the sheet “Modifications” 5 BCL manual on payment statistics – sheet Correspondence . Sheet “Correspondence” added, showing mapping between CDDP5 tables and CDDP6 tables 6 Agenda . Payment card transactions . Stock of payment cards . Stock of payment terminals 7 Agenda 8 V1.50 Card transactions with cards issued by resident PSPs V1.50-F Card transactions with cards issued by resident PSPs (fraud) 9 V1.50 Card transactions with cards issued by resident PSPs Changes in yellow Also added: country of the acquirer Removed: Acceptance mode 10 Examples .
    [Show full text]