Transactions

Transactions are the objects that represent the movement of value between accounts. These transactions can be debits, credits, or other types of financial transactions. You will generally retrieve transaction IDs as reported by an account in the transactions array.

The expression of certain values on this page may be different depending on what core or digital banking system is underlying the financial institution that you are working with.

Properties

Name
transactionId
Type
string
Description
The unique transaction id that is associated with the transaction.
Name
accountId
Type
string
Description
The account id that the transaction is being sent from.
Name
internalAccountType
Type
['CHECKING', 'SAVINGS', 'LOAN']
Description
The internal account type that the transaction is associated with.
Name
amount
Type
number
Description
The amount of value that is being transferred in the transaction.
Name
date
Type
string<date>
Description
The date that the transaction was written onto the ledger. May differ from when the transaction was actually executed.
Name
currency
Type
string
Description
The currency that the transaction is denominated in. In ISO 4217 format. This will usually be USD as written onto the ledger, but FX transactions may have different currencies depending on .
Name
originalTransactionDescription
Type
string
Description
The original description of the transaction as it was received from the core banking system. This is usually a mess and needs some cleaning from some kind of external transaction enrichment system. If the financial institution that you are integrating with has a transaction enrichment system, those additional fields will be added in the additionalMetadata field.
Name
settlementType
Type
['CREDIT', 'DEBIT']
Description
The type of settlement that the transaction is associated with. This will have a number of effects, including how the transaction is reported in the general ledger within the integrated digital banking or core banking system. Additionally, this will effect how the amount is reported in the account balance.
Name
additionalMetadata
Type
object
Description
Any additional metadata that is associated with the transaction.

GET/{environment}/transaction/{transactionId}

Retrieve A Transaction

This endpoint allows you to retrieve a transaction by its unique transaction id. This is useful for querying the additional details of a transaction that has been executed by a core or digital banking system.

Request

GET

/sandbox/transaction/RWVRsglrCuigZkijJBe7YWYnbFzUH7Mq

curl -G https://api.sonderlabs.io/sandbox/transaction/RWVRsglrCuigZkijJBe7YWYnbFzUH7Mq \
  -H "Authorization: Bearer {token}"

Response

{
  "data": {
    "accountId": "uvE3CCnqRAXU1WtZel3igMMWJeQjcZ3V",
    "transactionId": "RWVRsglrCuigZkijJBe7YWYnbFzUH7Mq",
    "internalAccountType": "CHECKING",
    "amount": 100.00,
    "currency": "USD",
    "date": "2021-01-01T00:00:00Z",
    "originalTransactionDescription": "SONDERLABS DIRECT DEPOSIT",
    "settlementType": "CREDIT",
    "additionalMetadata": {
      "category": "PAYROLL",
    }
  },
  "success": true,
  "error": null,
  "requestId": "FXGDtT1qy9S2iEbsXQEcXE9Hwjurwi5U",
  "log_ref_id": "FXGDtT1qy9S2iEbsXQEcXE9Hwjurwi5U"
}

Documentor note: one way to tell that this transaction is fabricated is because it comes from Sonder Labs! None of the team currently takes a regular salary!