Skip to main content

API Reference (1.0.0)

Billers

Billers endpoints support querying all billers, looking up a biller by its id, and searching for billers by name. Additionally, the billers endpoints allows you to automatically find suggested billers for your users based on transaction history.

Get Biller

Get a biller.

Authorizations:
path Parameters
origin_id
required
string (Origin Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "domain": "string",
  • "login_url": "string",
  • "url": "string",
  • "categories": [
    ],
  • "billpay_url": "string",
  • "logo_url": "string"
}

Search Billers

Get a biller.

Request Body schema: application/json
q
string (Q)
Default: ""
offset
integer (Offset) >= 0
Default: 0
limit
integer (Limit) [ 0 .. 50 ]
Default: 20
(string or null) or (Array of strings or null) (Filter)
facetsDistribution
Array of strings or null (Facetsdistribution)
attributesToRetrieve
Array of strings (Attributestoretrieve)
Default: ["*"]
attributesToCrop
Array of strings or null (Attributestocrop)
cropLength
integer (Croplength) >= 0
Default: 200
attributesToHighlight
Array of strings or null (Attributestohighlight)
matches
boolean (Matches)
Default: false
sort
Array of strings or null (Sort)

Responses

Request samples

Content type
application/json
{
  • "q": "Chase",
  • "offset": 0,
  • "limit": 1,
  • "attributesToRetrieve": [
    ],
  • "cropLength": 200,
  • "matches": false
}

Response samples

Content type
application/json
{
  • "nbHits": 0,
  • "exhaustiveNbHits": true,
  • "query": "string",
  • "limit": 0,
  • "offset": 0,
  • "processingTimeMs": 0,
  • "hits": [ ]
}

Transactions

Transaction objects are used for identifying suggested billers for a user without the need for manual input by the user. You can add transactions from any underlying data source or aggregator. The origin_id of the transaction is the primary key you use to uniquely identify this transaction in your application. It is not required, but it is recommended that you provide this value. In most cases, this information will be provided to you by the underlying source of the transaction data (e.g. Plaid). After a transaction is added the Blip API attempts to identify the merchant from the transaction description. Where a merchant is identified it will be returned when retrieving a transaction.

Get Transactions

Get list of transactions.

Authorizations:
query Parameters
batch_id
string or null (Batch Id) (batch_)([a-zA-Z0-9]{21})
limit
integer (Limit) [0 .. 1000]
Default: 500
skip
integer (Skip) [-1 .. 0]
Default: 0

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Transactions

Add a new batch of transactions.

Authorizations:
Request Body schema: application/json
Array ([ 1 .. 1000 ] items)
name
required
string (Name)
amount
required
number (Amount)

Account inflows (credits) should be positive and account outflows (debits) should be negative. For transactions sourced from Plaid, make sure to flip the amount sign for all transactions.

date
required
string <date> (Date)
account_id
string or null (Account Id)
origin_id
required
string (Origin Id)
user_id
required
string (User Id)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "batch_id": "string",
  • "count": 0,
  • "complete": false
}

Get Transactions Status

Get the status of the transactions.

Authorizations:
query Parameters
batch_id
string or null (Batch Id) (batch_)([a-zA-Z0-9]{21})

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Transactions Results

Get transaction results.

Authorizations:
query Parameters
batch_id
string or null (Batch Id) (batch_)([a-zA-Z0-9]{21})
user_id
string or null (User Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Transaction

Update an transaction.

Authorizations:
path Parameters
origin_id
required
string (Origin Id)
Request Body schema: application/json
name
string or null (Name)
amount
number or null (Amount)
date
null or null (Date)
account_id
string or null (Account Id)
origin_id
required
string (Origin Id)
user_id
string or null (User Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "amount": 0,
  • "date": null,
  • "account_id": "string",
  • "origin_id": "string",
  • "user_id": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "amount": 0,
  • "date": "2019-08-24",
  • "account_id": "string",
  • "origin_id": "string",
  • "user_id": "string",
  • "id": "string",
  • "batch_id": "string"
}

Remove Transaction

Remove a transaction.

Authorizations:
path Parameters
origin_id
required
string (Origin Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "amount": 0,
  • "date": "2019-08-24",
  • "account_id": "string",
  • "origin_id": "string",
  • "user_id": "string",
  • "id": "string",
  • "batch_id": "string"
}