Card Transaction

The card transaction resource.

Base/cardTransaction

GET/cardTransaction

List card transactions

Retrieve a paginated list of card transactions. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/cardTransaction

curl --request GET \
  --url '<your-host>/cardTransaction?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "cardTransactionId": "xyz789",
    "type": "string",
    "status": "string",
    "integration": "string",
    "cardAccountId": "xyz789",
    "transactionDate": "2026-01-01"
  }
]

GET/cardTransaction

Retrieve a card transaction

Fetch a single card transaction by filtering on `id`.

Query parameters

idstring

Match on the card transaction's `id`, e.g. `eq.{id}`.

GET/cardTransaction

curl --request GET \
  --url '<your-host>/cardTransaction?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "cardTransactionId": "xyz789",
  "type": "string",
  "status": "string",
  "integration": "string",
  "cardAccountId": "xyz789",
  "transactionDate": "2026-01-01"
}

POST/cardTransaction

Create a card transaction

Create a new card transaction.

Body parameters

cardTransactionIdstringrequired

typecardTransactionTyperequired

statuscardTransactionStatusrequired

integrationstringrequired

cardAccountIdstringrequired

References account.id

offsetAccountIdstring

References account.id

supplierIdstring

merchantNamestring

cardHolderNamestring

cardLast4string

memostring

transactionDatedaterequired

postingDatedate

currencyCodestringrequired

References currencyCode.code

exchangeRatenumberrequired

amountnumberrequired

journalIdstring

References journal.id

postedAttimestamp

postedBystring

References user.id

voidedAttimestamp

voidedBystring

References user.id

customFieldsobject

POST/cardTransaction

curl --request POST \
  --url <your-host>/cardTransaction \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"cardTransactionId":"xyz789","type":"string","status":"string","integration":"string","cardAccountId":"xyz789","transactionDate":"2026-01-01","currencyCode":"string","exchangeRate":0,"amount":0}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "cardTransactionId": "xyz789",
  "type": "string",
  "status": "string",
  "integration": "string",
  "cardAccountId": "xyz789",
  "transactionDate": "2026-01-01"
}

PATCH/cardTransaction

Update a card transaction

Update an existing card transaction, matched on `id`.

Body parameters

cardTransactionIdstringrequired

typecardTransactionTyperequired

statuscardTransactionStatusrequired

integrationstringrequired

cardAccountIdstringrequired

References account.id

offsetAccountIdstring

References account.id

supplierIdstring

merchantNamestring

cardHolderNamestring

cardLast4string

memostring

transactionDatedaterequired

postingDatedate

currencyCodestringrequired

References currencyCode.code

exchangeRatenumberrequired

amountnumberrequired

journalIdstring

References journal.id

postedAttimestamp

postedBystring

References user.id

voidedAttimestamp

voidedBystring

References user.id

customFieldsobject

PATCH/cardTransaction

curl --request PATCH \
  --url '<your-host>/cardTransaction?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"cardTransactionId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "cardTransactionId": "xyz789",
  "type": "string",
  "status": "string",
  "integration": "string",
  "cardAccountId": "xyz789",
  "transactionDate": "2026-01-01"
}

DELETE/cardTransaction

Delete a card transaction

Delete a card transaction, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the card transaction to delete, e.g. `eq.{id}`.

DELETE/cardTransaction

curl --request DELETE \
  --url '<your-host>/cardTransaction?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content