https://github.com/codeurzebs/campay-android-sdk
Official android sdk for CamPay payment platform
https://github.com/codeurzebs/campay-android-sdk
Last synced: 9 months ago
JSON representation
Official android sdk for CamPay payment platform
- Host: GitHub
- URL: https://github.com/codeurzebs/campay-android-sdk
- Owner: codeurzebs
- Created: 2023-10-06T17:46:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-06T17:49:21.000Z (over 2 years ago)
- Last Synced: 2025-02-18T01:40:17.356Z (about 1 year ago)
- Language: Java
- Size: 1.14 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [CamPay](https://www.campay.net/) Android SDK
[](https://jitpack.io/#CamPay/android-sdk)
[](https://sonarcloud.io/dashboard?id=CamPay_android-sdk)
[](https://sonarcloud.io/dashboard?id=CamPay_android-sdk)
[](https://sonarcloud.io/dashboard?id=CamPay_android-sdk)
[](https://sonarcloud.io/dashboard?id=CamPay_android-sdk)
[](https://sonarcloud.io/dashboard?id=CamPay_android-sdk)
[](https://sonarcloud.io/dashboard?id=CamPay_android-sdk)
[](https://sonarcloud.io/dashboard?id=CamPay_android-sdk)
[](https://sonarcloud.io/dashboard?id=CamPay_android-sdk)
[](https://sonarcloud.io/dashboard?id=CamPay_android-sdk)
[](https://sonarcloud.io/dashboard?id=CamPay_android-sdk)
## Summary
- [Getting Started](#getting-started)
- [Running the samples](#running-the-samples)
- [Deployment](#deployment)
- [Built With](#built-with)
## Getting Started
These instructions will get you started with the CamPay SDK for development and testing purposes. See deployment
for notes on how to deploy the project on a live system.
### Prerequisites
What things you need to install the software and how to install them
- An account on [CamPay](https://www.campay.net/) platform
- An application on the [CamPay platform](https://demo.campay.net/en/users/signup/).
- Credentials for connecting to the CamPay platform
### Installing
A step by step series of examples that tell you how to get a development
env running
- Check out the available versions on [Jitpack](https://jitpack.io/#CamPay/android-sdk/)
- Add the JitPack repository to your build file
```groovy
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
- Add the dependency
```groovy
implementation 'com.github.CamPay.android-sdk:android-sdk:latest.release'
// Peer dependency
implementation 'io.reactivex.rxjava3:rxjava:3.0.0'
```
- Add the internet permission to your application
```xml
```
## Running the samples
To view an extensive list of samples, clone this project and run the app module.
- Initialize the library with credentials.
```kotlin
CamPay.init(
"",
"",
CamPay.Environment.DEV // environment
)
```
- Get an instance of the library from anywhere in your application and run the various operations.
```kotlin
val camPay = CamPay.getInstance()
camPay.collect(
CollectionRequest.CollectionRequestBuilder
.aCollectionRequest()
.withAmount("amount")
.withFrom("237XXXXXXXXX")
.withDescription("some reason")
.withExternalReference(UUID.randomUUID().toString())
.withCurrency("XAF")
.build()
).delay(1, TimeUnit.MINUTES) // delay for a minute before checking the transaction status
.switchMap { collectResponse ->
println(collectResponse)
return@switchMap camPay.transactionStatus(collectResponse.reference) // check the transaction status
}.subscribe { transactionStatusResponse ->
println(transactionStatusResponse)
}
```
- Get application balance.
```kotlin
val camPay = CamPay.getInstance()
camPay.applicationBalance()
.subscribe { applicationBalanceResponse ->
println(applicationBalanceResponse)
}
```
- Place a withdrawal request
> Please enable API withdrawal under app settings before trying this request
```kotlin
val camPay = CamPay.getInstance()
camPay.withdraw(
WithdrawRequest.WithdrawRequestBuilder
.aWithdrawRequest()
.withTo("237XXXXXXXXX")
.withExternalReference(UUID.randomUUID().toString())
.withDescription("some reason")
.withAmount("100")
.build()
)
.subscribe { withdrawalResponse ->
println(withdrawalResponse)
}
```
## Deployment
Add additional notes about how to deploy this on a live system
Change the environment of the library introduction to PROD
```kotlin
CamPay.init(
"",
"",
CamPay.Environment.PROD // environment
)
```
## Built With
- [Retrofit](https://github.com/square/retrofit/) - A type-safe HTTP client for Android and Java.
- [RxJava3](https://github.com/ReactiveX/RxJava/tree/3.x) - Reactive Extensions for the JVM