{"id":20290649,"url":"https://github.com/gocardless/gocardless-pro-android-sdk","last_synced_at":"2026-05-08T21:31:32.812Z","repository":{"id":222340308,"uuid":"756805442","full_name":"gocardless/gocardless-pro-android-sdk","owner":"gocardless","description":"GoCardless Pro Android SDK","archived":false,"fork":false,"pushed_at":"2025-05-08T09:57:18.000Z","size":219,"stargazers_count":0,"open_issues_count":0,"forks_count":4,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-05-08T10:47:03.747Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gocardless.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-02-13T10:47:05.000Z","updated_at":"2025-05-08T09:57:15.000Z","dependencies_parsed_at":"2024-04-02T17:26:53.224Z","dependency_job_id":"bbcc0482-027d-4dee-8261-489f75f06b91","html_url":"https://github.com/gocardless/gocardless-pro-android-sdk","commit_stats":null,"previous_names":["gocardless/gocardless-pro-android-sdk"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/gocardless/gocardless-pro-android-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fgocardless-pro-android-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fgocardless-pro-android-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fgocardless-pro-android-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fgocardless-pro-android-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gocardless","download_url":"https://codeload.github.com/gocardless/gocardless-pro-android-sdk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fgocardless-pro-android-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32798247,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T08:22:46.396Z","status":"ssl_error","status_checked_at":"2026-05-08T08:22:45.650Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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-14T15:08:37.070Z","updated_at":"2026-05-08T21:31:32.795Z","avatar_url":"https://github.com/gocardless.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GoCardless SDK Example App\n\nThe GoCardless Android SDK is a tool that enables developers to integrate GoCardless payments into their Android applications. \nTo help developers get started, a sample app has been created that demonstrates how to use the SDK. \nThe app provides a clear and practical example of how to implement GoCardless payments within an Android app.\n\n## Getting started\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.gocardless\u003c/groupId\u003e\n    \u003cartifactId\u003egocardlesssdk\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.1\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nWith Gradle:\n\n```\nimplementation 'com.gocardless:gocardlesssdk:1.0.0'\n```\n\n## Initializing the client\n\nThe client is initialised with an access token, and is configured to use GoCardless' live environment by default:\n\n```kotlin\nimport com.gocardless.gocardlesssdk.GoCardlessSDK\nimport com.gocardless.gocardlesssdk.network.Environment\n\nGoCardlessSDK.initSDK(\n    \"YOUR_ACCESS_TOKEN\",\n    Environment.Live\n)\n```\n\n## Supported Services\nCurrently we support the following services and their functions\n\n### Billing Request\n- `createBillingRequest`: Creates a Billing Request, enabling you to collect all types of GoCardless payments\n- `collectCustomerDetails`: If the billing request has a pending collect_customer_details action, this endpoint can be used to collect the details in order to complete it.\n- `collectBankAccount`: If the billing request has a pending collect_bank_account action, this endpoint can be used to collect the details in order to complete it.\n- `confirmPayerDetails`: This is needed when you have a mandate request. As a scheme compliance rule we are required to allow the payer to crosscheck the details entered by them and confirm it.\n- `fulfil`: If a billing request is ready to be fulfilled, call this endpoint to cause it to fulfil, executing the payment.\n- `cancel`: Immediately cancels a billing request, causing all billing request flows to expire.\n- `notify`: Notifies the customer linked to the billing request, asking them to authorise it.\n- `getBillingRequest`: Fetches a billing request\n- `listBillingRequests`: Returns a cursor-paginated list of your billing requests.\n\n### Billing Request Flow\n- `createBillingRequestFlow`: Creates a new billing request flow.\n\n### Payment\n- `createPaymentRequest`: Creates a new payment object.\n- ``\n\n## Examples\n\nNote: To be able to make any request, you must initialise the SDK.\n\n### Fetching List of Billing Requests\n\nEnsure that all requests are made within the correct `Scope` before launching.\n\n```kotlin\nviewModelScope.launch {\n    val response = GoCardlessSDK.billingRequestService.listBillingRequests()\n}\n```\n\nThe response can be of two types: `ApiSuccess` or `ApiError`.\n\n- `ApiSuccess.value` Contains the result of the operation.\n- `ApiError.error` Contains details of the encountered error.\n\n```kotlin\nwhen(response) {\n    is ApiSuccess -\u003e {\n        _uiState.value = MainUiState.Success(response.value)\n    }\n    is ApiError -\u003e {\n        _uiState.value = MainUiState.Error(\"Couldn't fetch\")\n    }\n}\n```\n\n\n### Handling Errors\n\nWhenever the API encounters an issue, it returns a `GoCardlessError` or its derivatives to provide more context about the error. Below are the types of errors you may encounter:\n\n- `AuthenticationError`: Indicates an issue with authentication.\n- `GoCardlessInternalError`: Denotes an internal error within the GoCardless system.\n- `InvalidApiUsageError`: Occurs when the API is used incorrectly.\n- `InvalidStateError`: Indicates an invalid state in the system.\n- `MalformedResponseError`: Denotes an issue with the response received from the API.\n- `PermissionError`: Occurs when the user does not have the necessary permissions.\n- `RateLimitError`: Indicates that the rate limit for API requests has been exceeded.\n- `ValidationFailedError`: Denotes a validation failure, usually with user input.\n\n\n## Compatibility\n### Language: Kotlin\nOur SDK is built using Kotlin, a modern programming language for Android development.\n\n### Target SDK: 34 (Android 14) - Latest\nOur SDK is optimized for the latest Android features, providing compatibility up to SDK version 34.\n\n### Minimum SDK: 28 (Android 9)\nOur SDK supports a wide range of devices, ensuring compatibility with Android 9 (API level 28) and higher. We have achieved a coverage of 95% on devices with this minimum SDK version.\n\n### Libraries\nOur SDK utilizes the following libraries to enhance its functionality:\n\n- OkHttp: A robust HTTP client for Android, used for making network requests efficiently.\n- Retrofit: A type-safe HTTP client for Android and Java, simplifying the process of consuming RESTful APIs.\n\n### Threading: Coroutines\nWe leverage coroutines for handling asynchronous operations within our SDK. This enables smoother and more intuitive concurrency management, making your app's development process more efficient.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgocardless%2Fgocardless-pro-android-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgocardless%2Fgocardless-pro-android-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgocardless%2Fgocardless-pro-android-sdk/lists"}