Sign in

v1

latestOpenAPI 3.1.02026-07-13385987.3 KB
Enrichment

Enrich and add transactions to the ledger of account holders asynchronously.

Add a batch of transactions to the ledgers of account holders. Return the batch id that has been assigned to this batch. A batch of 24960 transactions should take 5-10mins.

post/v2/transactions/async

Request body

transaction_idstring required

A unique identifier of the transaction

account_holder_idstring nullable

The unique ID of the account holder of the transaction

account_holder_type'consumer' | 'business' | 'unknown'
amountnumber required

The amount of the transaction

entry_type'incoming' | 'outgoing' | 'credit' | 'debit' required

The direction of the transaction (incoming or outgoing)

datestring date required

The date that the transaction was posted. Uses ISO 8601 format (YYYY-MM-DD)

iso_currency_codestring required

The currency of the transaction in ISO 4217 format

descriptionstring required

The description string of the transaction

locationstring nullable

Location where the transaction occurred in

countrystring nullable

The country where the transaction was made in ISO 3166-2 format

mccinteger nullable

The Merchant Category Code of the merchant according to ISO 18245

account_holder_namestring nullable

The name of the account holder

Example request

[
  {
    "account_holder_id": "35b927b6-6fda-40aa-93b8-95b47c2b2cad",
    "amount": 10,
    "country": "US",
    "date": "2022-02-02",
    "description": "SQ* STARBUCKS UNION SQUARE",
    "entry_type": "outgoing",
    "iso_currency_code": "USD",
    "transaction_id": "xbx8YP14g565Xk"
  }
]

Response

Description of created batch

status'started' | 'finished' | 'error' required
created_atstring date-time required
updated_atstring date-time required
idstring required
progressinteger nullable
totalinteger nullable

Example response

{
  "id": "247ee045-3d04-4b3c-872b-a9160b810f33",
  "progress": 88,
  "status": "started",
  "updated_at": "2019-11-30T18:32:28Z"
}