Skip to main content
GET
/
v1
/
transactions
List transactions
curl --request GET \
  --url https://api.wellapp.ai/v1/transactions \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "type": "transaction",
      "id": "550e8400-e29b-41d4-a716-446655440010",
      "attributes": {
        "scheme": "sepa",
        "external_ids": {
          "transaction_id": "TXN_SEPA_20240115_001",
          "payment_request_id": "PAY_REQ_001",
          "end_to_end_id": "E2E_20240115_ACME_001"
        },
        "requested_execution_date": "2024-01-15",
        "executed_at": "2024-01-15T14:30:00Z",
        "booking_date": "2024-01-15",
        "value_date": "2024-01-15",
        "instructed_amount": {
          "currency": "EUR",
          "amount": 1250
        },
        "settlement_amount": {
          "currency": "USD",
          "amount": 1350.75
        },
        "foreign_exchange": {
          "currency_rate": "1.0806",
          "currency_pair": "EURUSD",
          "currency_rate_source": "ECB",
          "currency_rate_at": "2024-01-15T14:00:00Z"
        },
        "transaction_type": "transfer",
        "status": "completed",
        "category_purpose": "CBFF",
        "purpose_code": "SALA",
        "remittance_information": {
          "unstructured": "Salary payment January 2024",
          "structured_reference": "RF18539007547034",
          "reference_type": "SCOR"
        },
        "fees": [
          {
            "type": "transfer_fee",
            "amount": 2.5,
            "currency": "EUR"
          }
        ],
        "created_at": "2024-01-15T14:30:00Z",
        "updated_at": "2024-01-15T14:30:00Z"
      },
      "relationships": {
        "debtor_payment_means": {
          "data": {
            "type": "payment_means",
            "id": "550e8400-e29b-41d4-a716-446655440000"
          }
        },
        "creditor_payment_means": {
          "data": {
            "type": "payment_means",
            "id": "550e8400-e29b-41d4-a716-446655440001"
          }
        },
        "debtor": {
          "data": {
            "type": "company",
            "id": "550e8400-e29b-41d4-a716-446655440002"
          }
        },
        "creditor": {
          "data": {
            "type": "people",
            "id": "550e8400-e29b-41d4-a716-446655440003"
          }
        },
        "workspaces": {
          "data": [
            {
              "type": "workspace",
              "id": "550e8400-e29b-41d4-a716-446655440006"
            }
          ]
        }
      }
    },
    {
      "type": "transaction",
      "id": "550e8400-e29b-41d4-a716-446655440011",
      "attributes": {
        "scheme": "swift",
        "external_ids": {
          "transaction_id": "TXN_SWIFT_20240116_002",
          "payment_request_id": "PAY_REQ_002"
        },
        "requested_execution_date": "2024-01-16",
        "executed_at": "2024-01-16T09:15:00Z",
        "booking_date": "2024-01-16",
        "value_date": "2024-01-16",
        "instructed_amount": {
          "currency": "USD",
          "amount": 5000
        },
        "transaction_type": "payment",
        "status": "completed",
        "category_purpose": "CBFF",
        "purpose_code": "SUPP",
        "remittance_information": {
          "unstructured": "Invoice payment #INV-2024-001"
        },
        "fees": [
          {
            "type": "transfer_fee",
            "amount": 25,
            "currency": "USD"
          }
        ],
        "created_at": "2024-01-16T09:15:00Z",
        "updated_at": "2024-01-16T09:15:00Z"
      },
      "relationships": {
        "debtor_payment_means": {
          "data": {
            "type": "payment_means",
            "id": "550e8400-e29b-41d4-a716-446655440007"
          }
        },
        "creditor_payment_means": {
          "data": {
            "type": "payment_means",
            "id": "550e8400-e29b-41d4-a716-446655440008"
          }
        },
        "debtor": {
          "data": {
            "type": "company",
            "id": "550e8400-e29b-41d4-a716-446655440002"
          }
        },
        "creditor": {
          "data": {
            "type": "company",
            "id": "550e8400-e29b-41d4-a716-446655440009"
          }
        },
        "documents": {
          "data": [
            {
              "type": "invoice",
              "id": "550e8400-e29b-41d4-a716-446655440012"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "per_page": 25,
      "total_pages": 5,
      "total_count": 125,
      "has_next_page": true,
      "has_previous_page": false
    },
    "filters_applied": {
      "status": "completed",
      "scheme": "sepa",
      "date_range": {
        "executed_at_from": "2024-01-01T00:00:00Z",
        "executed_at_to": "2024-01-31T23:59:59Z"
      }
    },
    "sort": "-executed_at"
  },
  "included": [
    {
      "type": "payment_means",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "attributes": {
        "type": "account_details",
        "status": "active",
        "nickname": "Business Primary Account",
        "description": "Main SEPA account for business operations"
      }
    },
    {
      "type": "payment_means",
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "attributes": {
        "type": "account_details",
        "status": "active",
        "nickname": "Employee Salary Account",
        "description": "Dedicated account for salary payments"
      }
    },
    {
      "type": "company",
      "id": "550e8400-e29b-41d4-a716-446655440002",
      "attributes": {
        "name": "Acme Corporation",
        "description": "Leading technology solutions provider"
      }
    },
    {
      "type": "people",
      "id": "550e8400-e29b-41d4-a716-446655440003",
      "attributes": {
        "first_name": "John",
        "last_name": "Doe",
        "job_title": "Software Engineer"
      }
    }
  ]
}

Headers

​
Authorization
string
required

Bearer token for authentication

Query Parameters

​
include
string

Comma-separated list of related resources to include. Available options: debtor_payment_means, creditor_payment_means, debtor, creditor, documents, created_by, workspaces

​
created_at_from
string<date-time>

Filter transactions created from this date (ISO 8601 format)

​
created_at_to
string<date-time>

Filter transactions created until this date (ISO 8601 format)

​
updated_at_from
string<date-time>

Filter transactions updated from this date (ISO 8601 format)

​
updated_at_to
string<date-time>

Filter transactions updated until this date (ISO 8601 format)

​
executed_at_from
string<date-time>

Filter transactions executed from this date (ISO 8601 format)

​
executed_at_to
string<date-time>

Filter transactions executed until this date (ISO 8601 format)

​
booking_date_from
string<date>

Filter transactions booked from this date (YYYY-MM-DD format)

​
booking_date_to
string<date>

Filter transactions booked until this date (YYYY-MM-DD format)

​
value_date_from
string<date>

Filter transactions with value date from this date (YYYY-MM-DD format)

​
value_date_to
string<date>

Filter transactions with value date until this date (YYYY-MM-DD format)

​
scheme
enum<string>

Filter by payment scheme

Available options:
sepa,
swift,
ach,
faster_payments,
instant_credit_transfer
​
transaction_type
enum<string>

Filter by transaction type

Available options:
payment,
transfer,
deposit,
withdrawal,
card_payment,
direct_debit,
refund,
fee,
interest,
other
​
status
enum<string>

Filter by transaction status

Available options:
pending,
completed,
failed,
cancelled,
rejected
​
currency
string

Filter by instructed amount currency (ISO 4217 currency code)

​
amount_from
number

Filter transactions with instructed amount greater than or equal to this value

Required range: x >= 0
​
amount_to
number

Filter transactions with instructed amount less than or equal to this value

Required range: x >= 0
​
external_transaction_id
string

Filter by external transaction identifier from payment provider

​
payment_request_id
string

Filter by payment request identifier

​
end_to_end_id
string

Filter by end-to-end reference for tracing the transaction

​
debtor_payment_means_id
string<uuid>

Filter by debtor payment means ID

​
creditor_payment_means_id
string<uuid>

Filter by creditor payment means ID

​
debtor_id
string<uuid>

Filter by debtor entity ID (company or person)

​
creditor_id
string<uuid>

Filter by creditor entity ID (company or person)

​
workspace_id
string<uuid>

Filter by workspace ID

​
created_by_id
string<uuid>

Filter by user who created the transaction

​
sort
enum<string>

Sort by field. Use '-' prefix for descending order (e.g., '-executed_at' for most recent first)

Available options:
created_at,
-created_at,
updated_at,
-updated_at,
executed_at,
-executed_at,
booking_date,
-booking_date,
value_date,
-value_date
​
limit
integer
default:25

Number of results to return per page

Required range: 1 <= x <= 100
​
page
integer
default:1

Page number for pagination

Required range: x >= 1

Response

Transactions retrieved successfully

​
data
object[]
​
meta
object
​
included
object[]
  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
⌘I