List transactions

GET

transaction

curl --request GET \
  --url https://api.joinslash.com/transaction \
  --header 'X-API-Key: <api-key>'

{
  "items": [
    {
      "id": "<string>",
      "date": "<string>",
      "description": "<string>",
      "memo": "<string>",
      "merchantDescription": "<string>",
      "merchantData": {
        "description": "<string>",
        "categoryCode": "<string>",
        "location": {
          "city": "<string>",
          "state": "<string>",
          "country": "<string>",
          "zip": "<string>"
        }
      },
      "amountCents": 123,
      "status": "pending",
      "detailedStatus": "pending",
      "accountId": "<string>",
      "accountSubtype": "cash",
      "cardId": "<string>",
      "originalCurrency": {
        "code": "<string>",
        "amountCents": 123,
        "conversionRate": 123
      },
      "orderId": "<string>",
      "referenceNumber": "<string>",
      "authorizedAt": "<string>",
      "declineReason": "<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

deprecated

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

Available options:

pending,

posted,

failed

filter:detailed_status

enum<string>

Filter transactions by detailed status

Available options:

pending,

canceled,

failed,

settled,

declined,

refund,

reversed,

returned,

dispute

filter:cardId

string

Filter transactions by cardId

Response

200

application/json

items

object[]

required

items.id

string

required

items.date

string

required

The date in UTC time when the transaction was posted. If the transaction is pending or failed, this is the date the transaction was created.

items.description

string

required

items.amountCents

number

required

The amount of the transaction in cents in USD. If the transaction amount is negative, the transaction is a debit. If the transaction amount is positive, the transaction is a credit.

items.status

enum<string>

required

pending: The transaction is pending and has not been posted to the account yet (the account's posted balance doesn't reflect the transaction yet, but the account's available balance does).
posted: The transaction has been posted to the account and the account's posted balance and available balances both reflect the transaction.
failed: The transaction failed to post to the account and no longer affects the account's available or posted balances.

Available options:

pending,

posted,

failed

items.detailedStatus

enum<string>

required

pending_approval: Used for any transaction type that is pending approval. This does not affect the account's available or posted balances.
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,

pending_approval,

canceled,

failed,

settled,

declined,

refund,

reversed,

returned,

dispute

items.accountId

string

required

The account ID associated with the transaction

items.accountSubtype

enum<string>

required

For charge cards, specifies if the transaction belongs to the cash or credit account. For debit accounts, this field is always cash.

Available options:

cash,

credit

items.memo

string

The memo associated with the transaction for wires and achs

items.merchantDescription

string

deprecated

DEPRECATED. Use merchantData.description instead. For card transactions, the description of the transaction as reported by the merchant. For other transactions, this field is undefined.

items.merchantData

object

For card transactions, contains description of the transaction as reported by the merchant, merchant category code, and location of the merchant or origin of the transaction. For other transactions, this field is undefined.

items.cardId

string

The card ID associated with the transaction. If the transaction is not associated with a card, this field is not sent.

items.originalCurrency

object

The original currency of the transaction. This is only applicable to transactions. If this field is not sent, the original currency is in USD.

items.orderId

string

The order ID, as reported by the merchant, associated with the specific transaction.

items.referenceNumber

string

The reference number provided by Visa for this transaction.

items.authorizedAt

string

The UTC timestamp of when the transaction was authorized. Only exists for card transactions.

items.declineReason

string

The reason for the decline. Only exists for card transactions with detailedStatus = declined.

metadata

object

Response sent when requesting a list of data

Update virtual account Get transaction aggregations

curl --request GET \
  --url https://api.joinslash.com/transaction \
  --header 'X-API-Key: <api-key>'

{
  "items": [
    {
      "id": "<string>",
      "date": "<string>",
      "description": "<string>",
      "memo": "<string>",
      "merchantDescription": "<string>",
      "merchantData": {
        "description": "<string>",
        "categoryCode": "<string>",
        "location": {
          "city": "<string>",
          "state": "<string>",
          "country": "<string>",
          "zip": "<string>"
        }
      },
      "amountCents": 123,
      "status": "pending",
      "detailedStatus": "pending",
      "accountId": "<string>",
      "accountSubtype": "cash",
      "cardId": "<string>",
      "originalCurrency": {
        "code": "<string>",
        "amountCents": 123,
        "conversionRate": 123
      },
      "orderId": "<string>",
      "referenceNumber": "<string>",
      "authorizedAt": "<string>",
      "declineReason": "<string>"
    }
  ],
  "metadata": {
    "nextCursor": "<string>",
    "count": 123
  }
}

Overview

Entities

Legal Entity

Account

Virtual Account

Transaction

Transfer Money

Slash Pay

Card

Card Group

Merchant

Webhooks

List transactions

Authorizations

Query Parameters

Response