CBS Account and Transaction API Specification - v1

Coventry Building Society Account and Transaction API Specification V1.1

Confidential

1

Contents

Coventry Building Society..........................................................................................................................................................0 Account and Transaction API Specification V1.1 ......................................................................................................................0 Version control ...........................................................................................................................................................................5 Release Note .............................................................................................................................................................................5 Overview ....................................................................................................................................................................................5

Document Overview ...............................................................................................................................................................5 Design Principles ...................................................................................................................................................................6

RESTful APIs......................................................................................................................................................................6 Standards ...........................................................................................................................................................................6 Idempotency .......................................................................................................................................................................6 Scope .....................................................................................................................................................................................6 Basics ........................................................................................................................................................................................7 Overview ................................................................................................................................................................................7 Steps ...................................................................................................................................................................................7 Sequence Diagram .............................................................................................................................................................9 Actors .................................................................................................................................................................................. 10 Character Encoding ............................................................................................................................................................ 11 Date Formats....................................................................................................................................................................... 11 Resource URI Path Structure.............................................................................................................................................. 11 Headers ............................................................................................................................................................................... 12 Request Headers............................................................................................................................................................. 12 Response Headers .......................................................................................................................................................... 13 Return & Error Codes.......................................................................................................................................................... 14 400 (Bad Request) v/s 404 (Not Found) ......................................................................................................................... 15 403 (Forbidden) ............................................................................................................................................................... 15 429 (Too Many Requests) ............................................................................................................................................... 16 Pre-Conditions..................................................................................................................................................................... 16 Pre-conditions for TPPs................................................................................................................................................... 16 Idempotency........................................................................................................................................................................ 16 Filtering................................................................................................................................................................................ 16 Pagination ........................................................................................................................................................................... 17 All available Endpoints ........................................................................................................................................................ 17 POST /account-requests ..................................................................................................................................................... 18 Account Request Status .................................................................................................................................................. 18

GET /account-requests/{AccountRequestId} ...................................................................................................................... 18 Account Request Status .................................................................................................................................................. 18

DELETE /account-requests/{AccountRequestId}................................................................................................................ 19 GET /accounts..................................................................................................................................................................... 19 GET Resources for a Specific Account............................................................................................................................... 19

GET /accounts/{AccountId} ............................................................................................................................................. 19 GET /accounts/{AccountId}/balances .............................................................................................................................. 19 GET /accounts/{AccountId}/beneficiaries ........................................................................................................................ 19 GET /accounts/{AccountId}/direct-debits......................................................................................................................... 19 GET /accounts/{AccountId}/standing-orders ................................................................................................................... 19 GET /accounts/{AccountId}/transactions ......................................................................................................................... 19 GET /accounts/{AccountId}/product ................................................................................................................................ 19 Sandbox API Endpoints ...................................................................................................................................................... 20 POST /open-banking-sandbox/v1.0/account-requests ................................................................................................... 20 GET /open-banking-sandbox/v1.0/account-requests/{AccountRequestId} ..................................................................... 20 GET /open-banking-sandbox/v1.0/account/{AccountId}/balances .................................................................................. 20 GET /open-banking-sandbox/v1.0/accounts ................................................................................................................... 20 GET /open-banking-sandbox/v1.0/accounts/{AccountId}................................................................................................ 20 GET /open-banking-sandbox/v1.0/accounts/{AccountId}/product .................................................................................. 20 GET /open-banking-sandbox/v1.0/accounts/{AccountId}/direct-debits........................................................................... 20 GET /open-banking-sandbox/v1.0/accounts/{AccountId}/standing-orders ..................................................................... 20 GET /open-banking-sandbox/v1.0/accounts/{AccountId}/transactions ........................................................................... 20 GET /open-banking-sandbox/v1.0/accounts/{AccountId}/beneficiaries .......................................................................... 20 Security & Access Control ...................................................................................................................................................... 21 API Scopes.......................................................................................................................................................................... 21 Grants Types....................................................................................................................................................................... 21 Consent Authorisation ......................................................................................................................................................... 21 Consent Elements ........................................................................................................................................................... 21 Account Request Status .................................................................................................................................................. 24 Error Condition ................................................................................................................................................................ 24 Consent Revocation ........................................................................................................................................................ 24 Handling Expired Access Tokens.................................................................................................................................... 25 Risk Scoring Information ..................................................................................................................................................... 25 Swagger Specification ............................................................................................................................................................ 25 Data Model.............................................................................................................................................................................. 26

High Level Payload Structure.............................................................................................................................................. 26 Request Structure............................................................................................................................................................ 26 Response Structure ......................................................................................................................................................... 27

Data Payload - Consent Object........................................................................................................................................... 29 Account Requests - Request........................................................................................................................................... 29 Account Requests - Response ........................................................................................................................................ 30

Data Payload - Resources .................................................................................................................................................. 31 Accounts .......................................................................................................................................................................... 31 Balances .......................................................................................................................................................................... 32 Beneficiaries .................................................................................................................................................................... 33 Direct Debits .................................................................................................................................................................... 34 Product ............................................................................................................................................................................ 35 Standing Orders .............................................................................................................................................................. 36 Transactions .................................................................................................................................................................... 40

Data Payload - Enumerations ............................................................................................................................................. 42 TransactionEntryCode ..................................................................................................................................................... 42 CreditDebitCode .............................................................................................................................................................. 42 BalanceTypeCode ........................................................................................................................................................... 43 ExternalAccountIdentification2Code ............................................................................................................................... 43 ExternalDirectDebitStatus1Code..................................................................................................................................... 43 ExternalPermissions1Code ............................................................................................................................................. 44 ExternalProductType1Code ............................................................................................................................................ 44 ExternalRequestStatus1Code ......................................................................................................................................... 44

Usage Examples..................................................................................................................................................................... 45 All Permissions Granted...................................................................................................................................................... 45 Setup Account Request ................................................................................................................................................... 45 Status - AwaitingAuthorisation ........................................................................................................................................ 46 Status - Authorised .......................................................................................................................................................... 47 Accounts - Bulk................................................................................................................................................................ 48 Accounts - Specific Account ............................................................................................................................................ 49 Balances - Specific Account ............................................................................................................................................ 50 Beneficiaries - Specific Account ...................................................................................................................................... 51 Direct Debits - Specific Account ...................................................................................................................................... 52 Product - Specific Account .............................................................................................................................................. 53 Standing Orders - Specific Account ................................................................................................................................ 54

Transactions - Specific Account ...................................................................................................................................... 55 Delete Account Request .................................................................................................................................................. 56 Limited Permissions Granted .............................................................................................................................................. 56 Setup Account Request ................................................................................................................................................... 57 Accounts - Bulk................................................................................................................................................................ 58 Balances - Specific Account ............................................................................................................................................ 59 Transactions - Specific Account ...................................................................................................................................... 59 Pagination ........................................................................................................................................................................... 60 Alternate and Error Flows ................................................................................................................................................... 62 Missing or Expired Access Token ................................................................................................................................... 62 Incomplete or Malformed Request Payload .................................................................................................................... 63 Missing or Invalid Access Token Scope .......................................................................................................................... 64 Failed Authorisation Consent .......................................................................................................................................... 64

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download