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 ...................................................................................................................................................................