Main Resources
Atomic Resources
System
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"
}
}
]
}Get Transaction
Retrieve a list of financial transaction records with advanced filtering, sorting, and include capabilities.
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
Bearer token for authentication
Query Parameters
Comma-separated list of related resources to include. Available options: debtor_payment_means, creditor_payment_means, debtor, creditor, documents, created_by, workspaces
Filter transactions created from this date (ISO 8601 format)
Filter transactions created until this date (ISO 8601 format)
Filter transactions updated from this date (ISO 8601 format)
Filter transactions updated until this date (ISO 8601 format)
Filter transactions executed from this date (ISO 8601 format)
Filter transactions executed until this date (ISO 8601 format)
Filter transactions booked from this date (YYYY-MM-DD format)
Filter transactions booked until this date (YYYY-MM-DD format)
Filter transactions with value date from this date (YYYY-MM-DD format)
Filter transactions with value date until this date (YYYY-MM-DD format)
Filter by payment scheme
sepa, swift, ach, faster_payments, instant_credit_transfer Filter by transaction type
payment, transfer, deposit, withdrawal, card_payment, direct_debit, refund, fee, interest, other Filter by transaction status
pending, completed, failed, cancelled, rejected Filter by instructed amount currency (ISO 4217 currency code)
Filter transactions with instructed amount greater than or equal to this value
x >= 0Filter transactions with instructed amount less than or equal to this value
x >= 0Filter by external transaction identifier from payment provider
Filter by payment request identifier
Filter by end-to-end reference for tracing the transaction
Filter by debtor payment means ID
Filter by creditor payment means ID
Filter by debtor entity ID (company or person)
Filter by creditor entity ID (company or person)
Filter by workspace ID
Filter by user who created the transaction
Sort by field. Use '-' prefix for descending order (e.g., '-executed_at' for most recent first)
created_at, -created_at, updated_at, -updated_at, executed_at, -executed_at, booking_date, -booking_date, value_date, -value_date Number of results to return per page
1 <= x <= 100Page number for pagination
x >= 1Response
Transactions retrieved successfully
Show child attributes
Show child attributes
"transaction"UUID of the transaction
Show child attributes
Show child attributes
Payment scheme used for the transaction
sepa, swift, ach, faster_payments, instant_credit_transfer Show child attributes
Show child attributes
Date when transaction execution was requested
Timestamp when transaction was executed
Date when transaction was booked
Value date of the transaction
Show child attributes
Show child attributes
Exchange rate applied
Currency pair (e.g., EURUSD)
Source of the exchange rate
Timestamp when exchange rate was applied
Type of transaction. See transaction types documentation for complete list.
payment, transfer, deposit, withdrawal, card_payment, direct_debit, refund, fee, interest, other Current status of the transaction
pending, completed, failed, cancelled, rejected ISO 20022 category purpose code
ISO 20022 purpose code
Show child attributes
Show child attributes
Unstructured remittance information
Structured creditor reference
Type of structured reference. See remittance reference types for details.
SCOR, RADM, RPIN, FXDR, DISP, PUOR, SCNR Show child attributes
Show child attributes
Type of fee. See banking transaction fees for details.
transfer_fee, exchange_fee, processing_fee, commission Fee amount
x >= 0ISO 4217 currency code
Timestamp when transaction was created
Timestamp when transaction was last updated
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"payment_means"UUID of the debtor payment means (source)
Show child attributes
Show child attributes
Type of payment means. See payment means types for details.
card_details, account_details, wallet_details, cash_details, check_details, crypto_details, other Payment scheme or network. See scheme types for details.
SEPA, SWIFT, ACH, FASTER_PAYMENTS, VISA, MASTERCARD, AMEX, PAYPAL, APPLEPAY, GOOGLEPAY, STRIPE, LOCAL, OTHER Current status of the payment means. See payment means status for details.
active, inactive, pending_verification, suspended, expired, blocked Bank account details for account_details type
Show child attributes
Show child attributes
International Bank Account Number
Bank Identifier Code (SWIFT)
Local account number (alternative to IBAN)
Bank routing number (US ACH)
Currency code (ISO 4217)
Additional bank information
Show child attributes
Show child attributes
Name of the bank
Bank code or identifier
Bank branch name
Bank branch code
Credit/debit card details for card_details type
Show child attributes
Show child attributes
Masked Primary Account Number (PCI DSS compliant)
Card brand
visa, mastercard, amex, discover, diners, jcb, unionpay, other Type of card
credit, debit, prepaid, charge Card expiry month
Card expiry year
Name as printed on card
Digital wallet details for wallet_details type
Show child attributes
Show child attributes
Digital wallet provider
paypal, applepay, googlepay, stripe, square, venmo, cashapp, other Wallet identifier (email, phone, etc.)
Type of wallet account
personal, business, merchant Compliance and verification status
Show child attributes
Show child attributes
Know Your Customer verification status
pending, in_progress, completed, failed, not_required Anti-Money Laundering check status
pending, in_progress, cleared, flagged, not_required Sanctions screening status
pending, passed, failed, not_required Last compliance check timestamp
System metadata
User-friendly name for the payment means
Additional description of the payment means
Tags for categorization
Creation timestamp
Last update timestamp
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"payment_means"UUID of the creditor payment means (destination)
Show child attributes
Show child attributes
Type of payment means. See payment means types for details.
card_details, account_details, wallet_details, cash_details, check_details, crypto_details, other Payment scheme or network. See scheme types for details.
SEPA, SWIFT, ACH, FASTER_PAYMENTS, VISA, MASTERCARD, AMEX, PAYPAL, APPLEPAY, GOOGLEPAY, STRIPE, LOCAL, OTHER Current status of the payment means. See payment means status for details.
active, inactive, pending_verification, suspended, expired, blocked Bank account details for account_details type
Show child attributes
Show child attributes
International Bank Account Number
Bank Identifier Code (SWIFT)
Local account number (alternative to IBAN)
Bank routing number (US ACH)
Currency code (ISO 4217)
Additional bank information
Show child attributes
Show child attributes
Name of the bank
Bank code or identifier
Bank branch name
Bank branch code
Credit/debit card details for card_details type
Show child attributes
Show child attributes
Masked Primary Account Number (PCI DSS compliant)
Card brand
visa, mastercard, amex, discover, diners, jcb, unionpay, other Type of card
credit, debit, prepaid, charge Card expiry month
Card expiry year
Name as printed on card
Digital wallet details for wallet_details type
Show child attributes
Show child attributes
Digital wallet provider
paypal, applepay, googlepay, stripe, square, venmo, cashapp, other Wallet identifier (email, phone, etc.)
Type of wallet account
personal, business, merchant Compliance and verification status
Show child attributes
Show child attributes
Know Your Customer verification status
pending, in_progress, completed, failed, not_required Anti-Money Laundering check status
pending, in_progress, cleared, flagged, not_required Sanctions screening status
pending, passed, failed, not_required Last compliance check timestamp
System metadata
User-friendly name for the payment means
Additional description of the payment means
Tags for categorization
Creation timestamp
Last update timestamp
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
"company"Show child attributes
Show child attributes
The domain url from the website or email address of the company. Used as unique identifier in some cases.
500Show child attributes
Show child attributes
Legal entity structure type.
Official company registration number.
Name of the official registration body.
Country of the registry authority. (string (ISO 3166-1 alpha-2))
UUID of the workspace associated with this company
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
"company"Show child attributes
Show child attributes
The domain url from the website or email address of the company. Used as unique identifier in some cases.
500Show child attributes
Show child attributes
Legal entity structure type.
Official company registration number.
Name of the official registration body.
Country of the registry authority. (string (ISO 3166-1 alpha-2))
UUID of the workspace associated with this company
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Type of document
document, invoice UUID of the document (receipts, confirmations, invoices)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"people"UUID of the user who created the transaction record
Show child attributes
Show child attributes
The person's first name
The person's last name
The person's full name (typically first_name + last_name)
Timestamp when the person was created
Timestamp when the person was last updated
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"workspace"UUID of the workspace associated with this transaction
Show child attributes
Show child attributes
Workspace name
Workspace description
external workspace id
Color of the avatar
Timestamp when the workspace was created
Timestamp when the workspace was last updated
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Current page number
Number of items per page
Total number of pages
Total number of transactions
Whether there is a next page
Whether there is a previous page
Summary of filters applied to the query
Sort order applied
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
"payment_means"Show child attributes
Show child attributes
Type of payment means. See payment means types for details.
card_details, account_details, wallet_details, cash_details, check_details, crypto_details, other Current status of the payment means. See payment means status for details.
active, inactive, pending_verification, suspended, expired, blocked User-friendly name for the payment means
Additional description of the payment means