Skip to main content
GET
/
transaction
cURL
curl --request GET \
  --url https://api.joinslash.com/transaction \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "date": "<string>",
      "description": "<string>",
      "amountCents": 123,
      "status": "pending",
      "detailedStatus": "pending",
      "accountId": "<unknown>",
      "accountSubtype": "cash",
      "memo": "<string>",
      "merchantDescription": "<string>",
      "merchantData": {
        "description": "<string>",
        "categoryCode": "<string>",
        "location": {
          "city": "<string>",
          "state": "<string>",
          "country": "<string>",
          "zip": "<string>"
        }
      },
      "virtualAccountId": "<string>",
      "cardId": "<string>",
      "originalCurrency": {
        "code": "<string>",
        "amountCents": 123,
        "conversionRate": 123
      },
      "orderId": "<string>",
      "referenceNumber": "<string>",
      "authorizedAt": "<string>",
      "declineReason": "<string>",
      "approvalReason": "<string>",
      "providerAuthorizationId": "<string>",
      "wireInfo": {
        "typeCode": "<string>",
        "subtypeCode": "<string>",
        "omad": "<string>",
        "imad": "<string>",
        "senderReference": "<string>",
        "businessFunctionCode": "<string>",
        "counterpartyBank": "<string>"
      },
      "achInfo": {
        "receiverId": "<string>",
        "companyId": "<string>",
        "companyDiscretionaryData": "<string>",
        "traceNumber": "<string>",
        "entryClassCode": "<string>",
        "paymentRelatedInfo": "<string>",
        "counterpartyBank": "<string>",
        "companyEntryDescription": "<string>"
      },
      "rtpInfo": {
        "counterpartyBank": "<string>",
        "endToEndId": "<string>",
        "routingNumber": "<string>",
        "originatorName": "<string>",
        "description": "<string>"
      },
      "feeInfo": {
        "relatedTransaction": {
          "id": "<string>",
          "amount": 123
        }
      },
      "cryptoInfo": {
        "txHash": "<string>",
        "senderAddress": "<string>"
      }
    }
  ],
  "metadata": {
    "nextCursor": "<string>",
    "count": 123
  }
}

Authorizations

​
X-API-Key
string
header
required

Authentication from public API requests

Query Parameters

​
cursor
string

A cursor string to fetch the next page of results

​
accountId
string

Use filter:accountId to filter by account ID

​
filter:legalEntityId
string

Pass in a legal entity ID to filter transactions by accounts under a specific legal entity.

​
filter:accountId
string

Pass in an account ID to filter transactions by account ID. This will return all transactions that match the account ID passed in.

​
filter:virtualAccountId
string

Pass in a virtual account ID to filter transactions by virtual account ID. This will return all transactions that match the virtual account ID passed in.

​
filter:from_date
string

Pass in a unix timestamp in milliseconds to filter transactions by date. This will return all transactions that occurred on or after the date passed in.

​
filter:to_date
string

Pass in a unix timestamp in milliseconds to filter transactions by date. This will return all transactions that occurred on or before the date passed in.

​
filter:from_authorized_at
string

Pass in a unix timestamp in milliseconds to filter transactions by authorization time. This will return all transactions that are authorized on or after the date passed in.

​
filter:to_authorized_at
string

Pass in a unix timestamp in milliseconds to filter transactions by authorization time. This will return all transactions that are authorized on or before the date passed in.

​
filter:status
enum<string>

Filter transactions by status pending - The transaction is pending and has not been posted to the account yet (the balance doesn't reflect the transaction yet). posted - The transaction has been posted to the account and the balance reflects the transaction. failed - The transaction failed to post to the account

Available options:
pending,
posted,
failed
​
filter:detailed_status
enum<string>

Filter transactions by detailed status

  • pending: Used for any transaction type that has not posted to the account yet, but is affecting the account's available balance.
  • canceled: Used for any transaction that was canceled.
  • failed: Used for any transaction that failed to post to the account.
  • settled: Used for any transaction that has posted to the account, except for card refunds, which use the refund status, and ACH returns, which use the returned status.
  • declined: Used for card transactions that were declined.
  • refund: Used for card transactions that were refunded, increasing the account's available and posted balances.
  • reversed: Used for card transactions that were authorized, but reversed by the merchant.
  • returned: Used for ACH returns. In the case of an ACH return, there are two possibilities: (1) if the ACH settled and then returned, then there will be one transaction with status settled for the ACH settling, and one transaction with status returned for the ACH return. Both of these are posted transactions. (2) if the ACH returned before settling, then there will only be one transaction with status canceled.
  • dispute: Used for disputed card transactions.
Available options:
pending,
canceled,
failed,
settled,
declined,
refund,
reversed,
returned,
dispute
​
filter:cardId
string

Filter transactions by cardId

​
filter:providerAuthorizationId
string

Filter transactions by provider authorization ID

Response

OK

​
items
Transaction · object[]
required
​
metadata
PaginationResponse · object

Response sent when requesting a list of data