Plaid-Kotlin

Kotlin bindings for Plaid

Fully asynchronous - uses Ktor Apache under the hood

Official API Documentation https://plaid.com/docs

Installation

repositories {
    mavenCentral()
}

dependencies {
    implementation("tech.alexib:plaid-kotlin:0.0.22")
}

Or to use a snapshot build

repositories{
    //...
    maven("https://jitpack.io")
}

dependencies{
    implementation("com.github.ruffCode:plaid-kotlin:-SNAPSHOT")
}

Configuration

   val plaidApiConfiguration = PlaidApiConfiguration(
        ClientId(plaidConfig.clientId),
        Secret(plaidConfig.secret),
        baseUrl = BaseUrl.Sandbox, //defaults to sandbox
        plaidVersion = PlaidVersion("2020-09-14") //defaults to latest
    )
    
    val plaidClient = PlaidClient(plaidApiConfiguration)

Basic Usage

suspend fun getItem(): Item {

    val request: SandboxPublicTokenCreateRequest =
        SandboxPublicTokenCreateRequest(
            institutionId = "ins_109511",
            initialProducts = listOf(Products.TRANSACTIONS)
        )

    val createResponse: SandboxPublicTokenCreateResponse =
        plaidClient.sandboxPublicTokenCreate(request)

    val itemPublicTokenExchangeRequest =
        ItemPublicTokenExchangeRequest(publicToken = createResponse.publicToken)

    val response: ItemPublicTokenExchangeResponse = plaidClient
        .itemPublicTokenExchange(itemPublicTokenExchangeRequest)

    val itemGetRequest = ItemGetRequest(accessToken = response.accessToken)

    val itemGetResponse: ItemGetResponse = plaidClient
        .itemGet(itemGetRequest)

    return itemGetResponse.item
}
 

TODO

• Publish to MavenCentral
• Documentation
• Tests & CodeCov
• Automate deploy

📝 License

Copyright © 2021 - Alexi Bre

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.