{"id":18521657,"url":"https://github.com/transferwise/openbanking-client","last_synced_at":"2025-04-09T09:33:23.594Z","repository":{"id":36981117,"uuid":"318541280","full_name":"transferwise/openbanking-client","owner":"transferwise","description":"Java client for using the UK Open Banking API ","archived":true,"fork":false,"pushed_at":"2024-07-15T10:57:26.000Z","size":683,"stargazers_count":15,"open_issues_count":9,"forks_count":15,"subscribers_count":68,"default_branch":"master","last_synced_at":"2025-03-03T04:44:54.592Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/transferwise.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-12-04T14:29:54.000Z","updated_at":"2025-01-09T07:15:06.000Z","dependencies_parsed_at":"2023-02-19T06:15:26.225Z","dependency_job_id":"2be0966e-7720-4223-9def-3a5edcce6d5e","html_url":"https://github.com/transferwise/openbanking-client","commit_stats":null,"previous_names":[],"tags_count":58,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transferwise%2Fopenbanking-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transferwise%2Fopenbanking-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transferwise%2Fopenbanking-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transferwise%2Fopenbanking-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/transferwise","download_url":"https://codeload.github.com/transferwise/openbanking-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248012864,"owners_count":21033254,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T17:26:57.866Z","updated_at":"2025-04-09T09:33:22.384Z","avatar_url":"https://github.com/transferwise.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# openbanking-client\n\n![Apache 2](https://img.shields.io/hexpm/l/plug.svg)\n![Java 1.8](https://img.shields.io/badge/Java-11-blue.svg)\n\nJava client for using the Open Banking API, exposed by an ASPSP, as a TPP. The library supports a subset of the full \nAPI:  \n\n- Support for version 3.2 [dynamic client registration](https://openbankinguk.github.io/dcr-docs-pub/v3.2/dynamic-client-registration.html)\n- Support for version 3.1.6 [single immediate domestic payments](https://openbankinguk.github.io/read-write-api-site3/v3.1.6/profiles/payment-initiation-api-profile.html)\n- Support for version 3.1.9 [variable recurring payments API](https://openbankinguk.github.io/read-write-api-site3/v3.1.9/profiles/vrp-profile.html)\n- Support for the following OAuth client authentication methods\n    - Mutual TLS\n    - Private key JWT\n    - Client secret basic\n    - Client secret post\n\n## Example Usage\n\n### Client Registration\n\n```java\n//\n// Step 1 - configure the RegistrationClient instance to use for the ASPSP\n//\n\nTppConfiguration tppConfiguration = TppConfiguration.builder()\n    // set the properties acording to your organisation\n    .build();\n// configure the SSL context of the instance according to your setup, including a KeyManager to support mutual TLS on\n// conections to ASPSP and a TrustManager to support connections to ASPSPs using OB issued certificates\nRestTemplate restTemplate = new RestTemplate();\n\n// an example implementation might look up the values to supply from a KeyStore\nKeySupplier signingKeySupplier = new ExampleKeySupplier();\nJsonConverter jsonConverter = new JacksonJsonConverter();\nJwtClaimsSigner jwtClaimsSigner = new JwtClaimsSigner(signingKeySupplier, jsonConverter);\n\nRegistrationClient registrationClient = new RestRegistrationClient(jwtClaimsSigner, restTemplate);\n\nRegistrationRequestService registrationRequestService = new RegistrationRequestService(keySupplier, tppConfiguration);\n\n// supplies the details of the ASPSP implementation required to make the API calls\nAspspDetails aspspDetails = new ExampleAspspDetails();\n\n// \n// Step 2 - register with the ASPSP\n// \n\nClientRegistrationRequest clientRegistrationRequest = registrationRequestService.generateRegistrationRequest(\n        softwareStatement, \n        aspspDetails);\n\nClientRegistrationResponse clientRegistrationResponse = registrationClient.registerClient(clientRegistrationRequest, \n        aspspDetails);\n```\n\n### V3 Payments\n\n```java\n//\n// Step 1 - configure the V3 PaymentClient instance to use for the ASPSP\n//\n\nTppConfiguration tppConfiguration = TppConfiguration.builder()\n    // set the properties acording to your organisation\n    .build();\n// configure the SSL context of the instance according to your setup, including a KeyManager to support mutual TLS on\n// conections to ASPSP and a TrustManager to support connections to ASPSPs using OB issued certificates\nRestTemplate restTemplate = new RestTemplate();\n\nClientAuthentication tlsClientAuthentication = new TlsAuthentication();\nOAuthClient restOAuthClient = new RestOAuthClient(tlsClientAuthentication, restTemplate);\n\n// an example implementation might use the EndToEndIdentification of the request as the idempotency key \nIdempotencyKeyGenerator idempotencyKeyGenerator = new ExampleIdempotencyKeyGenerator();\n\n// an example implementation might look up the values to supply from a KeyStore\nKeySupplier signingKeySupplier = new ExampleKeySupplier();\nJsonConverter jsonConverter = new JacksonJsonConverter();\nJwtClaimsSigner jwtClaimsSigner = new JwtClaimsSigner(signingKeySupplier, jsonConverter);\n\nPaymentClient paymentClient = new RestPaymentClient(restTemplate,\n    jsonConverter,\n    restOAuthClient,\n    idempotencyKeyGenerator,\n    jwtClaimsSigner);\n\n// supplies the details of the ASPSP implementation required to make the API calls\nAspspDetails aspspDetails = new ExampleAspspDetails();\n\n// \n// Step 2 - initiate the payment\n// \n\n// set the properties according to the payment attempt\nOBWriteDomesticConsent4 paymentConsentRequest = new OBWriteDomesticConsent4();\nOBWriteDomesticConsentResponse5 paymentConsentResponse = paymentClient.createDomesticPaymentConsent(\n    paymentConsentRequest, \n    aspspDetails);\n\n// \n// Step 3 - redirect the user to the ASPSP authorisation site to authorise the payment \n// \n// on authorisation success, an authorization code is received from the ASPSP\n// note, when building the ASPSP authorisation URL, the JwtClaimsSigner can be used to generate the request parameter\n//  \n\n//\n// Step 4 - submit the payment for execution\n//\n\n//\n// Step 4a (optional) - check for sufficient funds on the source account \n//\n\nOBWriteFundsConfirmationResponse1 fundsConfirmationResponse = paymentClient.getFundsConfirmation(consentId, \n    authorizationCode, \n    aspspDetails);\n\n// set the properties according to the payment attempt\nOBWriteDomestic2 paymentRequest = new OBWriteDomestic2();\nOBWriteDomesticResponse5 paymentResponse = paymentClient.createDomesticPayment(paymentRequest, \n    authorizationCode, \n    aspspDetails);\n```\n## How to contribute\n\n1. Prepare a PR for review (all commits must be signed)\n2. We receive a notification and review your PR\n3. We merge approved PR and release a new version\n\n### How to configure GPG signing\n\n1. [Generate a GPG key](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key)\n2. [Upload your GPG public key to your GitHub account](https://docs.github.com/en/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key)\n3. [Configure Git to use your GPG key](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key)\n\n## License\n\nCopyright 2019 TransferWise Ltd.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftransferwise%2Fopenbanking-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftransferwise%2Fopenbanking-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftransferwise%2Fopenbanking-client/lists"}