Headers
Bearer token for authentication
Path Parameters
The unique identifier of the transaction to update
Body
Response
Transaction updated successfully
curl --request PATCH \
--url https://api.wellapp.ai/v1/transactions/{id} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"type": "transaction",
"attributes": {
"status": "completed",
"executed_at": "2024-01-15T14:35:00Z",
"booking_date": "2024-01-15",
"value_date": "2024-01-15",
"settlement_amount": {
"currency": "USD",
"amount": 1355.25
},
"foreign_exchange": {
"currency_rate": "1.0842",
"currency_rate_source": "ECB",
"currency_rate_at": "2024-01-15T14:35:00Z"
},
"remittance_information": {
"unstructured": "Salary payment January 2024 - Updated",
"structured_reference": "RF18539007547034",
"reference_type": "SCOR"
},
"fees": [
{
"type": "transfer_fee",
"amount": 2.5,
"currency": "EUR"
},
{
"type": "exchange_fee",
"amount": 7.5,
"currency": "EUR"
}
]
},
"relationships": {
"documents": {
"data": [
{
"type": "invoice",
"id": "550e8400-e29b-41d4-a716-446655440004"
},
{
"type": "document",
"id": "550e8400-e29b-41d4-a716-446655440020"
}
]
}
}
}'{
"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:35:00Z",
"booking_date": "2024-01-15",
"value_date": "2024-01-15",
"instructed_amount": {
"currency": "EUR",
"amount": 1250
},
"settlement_amount": {
"currency": "USD",
"amount": 1355.25
},
"foreign_exchange": {
"currency_rate": "1.0842",
"currency_pair": "EURUSD",
"currency_rate_source": "ECB",
"currency_rate_at": "2024-01-15T14:35:00Z"
},
"transaction_type": "transfer",
"status": "completed",
"category_purpose": "CBFF",
"purpose_code": "SALA",
"remittance_information": {
"unstructured": "Salary payment January 2024 - Updated",
"structured_reference": "RF18539007547034",
"reference_type": "SCOR"
},
"fees": [
{
"type": "transfer_fee",
"amount": 2.5,
"currency": "EUR"
},
{
"type": "exchange_fee",
"amount": 7.5,
"currency": "EUR"
}
],
"created_at": "2024-01-15T14:30:00Z",
"updated_at": "2024-01-15T14:40: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"
}
},
"documents": {
"data": [
{
"type": "invoice",
"id": "550e8400-e29b-41d4-a716-446655440004"
},
{
"type": "document",
"id": "550e8400-e29b-41d4-a716-446655440020"
}
]
},
"created_by": {
"data": {
"type": "people",
"id": "550e8400-e29b-41d4-a716-446655440005"
}
},
"workspaces": {
"data": [
{
"type": "workspace",
"id": "550e8400-e29b-41d4-a716-446655440006"
}
]
}
}
},
"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 outgoing payments"
}
},
{
"type": "payment_means",
"id": "550e8400-e29b-41d4-a716-446655440001",
"attributes": {
"type": "account_details",
"status": "active",
"nickname": "Employee Salary Account",
"description": "Dedicated account for receiving 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",
"full_name": "John Doe",
"job_title": "Software Engineer"
}
},
{
"type": "invoice",
"id": "550e8400-e29b-41d4-a716-446655440004",
"attributes": {
"invoice_number": "INV-2024-0115",
"amount": 1250,
"currency": "EUR",
"status": "paid"
}
},
{
"type": "document",
"id": "550e8400-e29b-41d4-a716-446655440020",
"attributes": {
"name": "Payment Receipt",
"filename": "receipt-2024-0115.pdf",
"content_type": "application/pdf"
}
}
]
}Update a financial transaction record with comprehensive payment details, foreign exchange information, remittance data, fees, and relationship associations. This endpoint supports:
Partial updates: All fields are optional - only provide the fields you want to update.
Status management: Update transaction status from pending to completed, failed, or cancelled.
Relationship updates: Modify debtor/creditor payment means, entities, documents, and workspace associations.
Financial adjustments: Update amounts, foreign exchange rates, fees, and remittance information.
Audit trail: Automatically updates the updated_at timestamp while preserving creation history.
Data integrity: Validates business rules and maintains consistency across related entities.
curl --request PATCH \
--url https://api.wellapp.ai/v1/transactions/{id} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"type": "transaction",
"attributes": {
"status": "completed",
"executed_at": "2024-01-15T14:35:00Z",
"booking_date": "2024-01-15",
"value_date": "2024-01-15",
"settlement_amount": {
"currency": "USD",
"amount": 1355.25
},
"foreign_exchange": {
"currency_rate": "1.0842",
"currency_rate_source": "ECB",
"currency_rate_at": "2024-01-15T14:35:00Z"
},
"remittance_information": {
"unstructured": "Salary payment January 2024 - Updated",
"structured_reference": "RF18539007547034",
"reference_type": "SCOR"
},
"fees": [
{
"type": "transfer_fee",
"amount": 2.5,
"currency": "EUR"
},
{
"type": "exchange_fee",
"amount": 7.5,
"currency": "EUR"
}
]
},
"relationships": {
"documents": {
"data": [
{
"type": "invoice",
"id": "550e8400-e29b-41d4-a716-446655440004"
},
{
"type": "document",
"id": "550e8400-e29b-41d4-a716-446655440020"
}
]
}
}
}'{
"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:35:00Z",
"booking_date": "2024-01-15",
"value_date": "2024-01-15",
"instructed_amount": {
"currency": "EUR",
"amount": 1250
},
"settlement_amount": {
"currency": "USD",
"amount": 1355.25
},
"foreign_exchange": {
"currency_rate": "1.0842",
"currency_pair": "EURUSD",
"currency_rate_source": "ECB",
"currency_rate_at": "2024-01-15T14:35:00Z"
},
"transaction_type": "transfer",
"status": "completed",
"category_purpose": "CBFF",
"purpose_code": "SALA",
"remittance_information": {
"unstructured": "Salary payment January 2024 - Updated",
"structured_reference": "RF18539007547034",
"reference_type": "SCOR"
},
"fees": [
{
"type": "transfer_fee",
"amount": 2.5,
"currency": "EUR"
},
{
"type": "exchange_fee",
"amount": 7.5,
"currency": "EUR"
}
],
"created_at": "2024-01-15T14:30:00Z",
"updated_at": "2024-01-15T14:40: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"
}
},
"documents": {
"data": [
{
"type": "invoice",
"id": "550e8400-e29b-41d4-a716-446655440004"
},
{
"type": "document",
"id": "550e8400-e29b-41d4-a716-446655440020"
}
]
},
"created_by": {
"data": {
"type": "people",
"id": "550e8400-e29b-41d4-a716-446655440005"
}
},
"workspaces": {
"data": [
{
"type": "workspace",
"id": "550e8400-e29b-41d4-a716-446655440006"
}
]
}
}
},
"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 outgoing payments"
}
},
{
"type": "payment_means",
"id": "550e8400-e29b-41d4-a716-446655440001",
"attributes": {
"type": "account_details",
"status": "active",
"nickname": "Employee Salary Account",
"description": "Dedicated account for receiving 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",
"full_name": "John Doe",
"job_title": "Software Engineer"
}
},
{
"type": "invoice",
"id": "550e8400-e29b-41d4-a716-446655440004",
"attributes": {
"invoice_number": "INV-2024-0115",
"amount": 1250,
"currency": "EUR",
"status": "paid"
}
},
{
"type": "document",
"id": "550e8400-e29b-41d4-a716-446655440020",
"attributes": {
"name": "Payment Receipt",
"filename": "receipt-2024-0115.pdf",
"content_type": "application/pdf"
}
}
]
}Bearer token for authentication
The unique identifier of the transaction to update
Show child attributes
Transaction updated successfully
Show child attributes