Headers
Bearer token for authentication
Body
application/json
Response
Transaction created successfully
curl --request POST \
--url https://api.wellapp.ai/v1/transactions \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"type": "transaction",
"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"
},
{
"type": "exchange_fee",
"amount": 5,
"currency": "EUR"
}
]
},
"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"
}
]
},
"created_by": {
"data": {
"type": "people",
"id": "550e8400-e29b-41d4-a716-446655440005"
}
},
"workspaces": {
"data": [
{
"type": "workspace",
"id": "550e8400-e29b-41d4-a716-446655440006"
}
]
}
}
}'{
"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"
},
{
"type": "exchange_fee",
"amount": 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"
}
},
"documents": {
"data": [
{
"type": "invoice",
"id": "550e8400-e29b-41d4-a716-446655440004"
}
]
},
"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": "Debtor Business Account",
"description": "Primary SEPA account for outgoing payments"
}
},
{
"type": "payment_means",
"id": "550e8400-e29b-41d4-a716-446655440001",
"attributes": {
"type": "account_details",
"status": "active",
"nickname": "Creditor Salary Account",
"description": "Employee salary receiving account"
}
},
{
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440002",
"attributes": {
"name": "Acme Corporation",
"description": "Leading technology solutions provider (debtor)"
}
},
{
"type": "people",
"id": "550e8400-e29b-41d4-a716-446655440003",
"attributes": {
"first_name": "John",
"last_name": "Doe",
"job_title": "Software Engineer"
}
},
{
"type": "invoice",
"id": "550e8400-e29b-41d4-a716-446655440004",
"attributes": {
"invoice_number": "INV-2024-0115",
"amount": 1250,
"currency": "EUR"
}
},
{
"type": "people",
"id": "550e8400-e29b-41d4-a716-446655440005",
"attributes": {
"first_name": "Marie",
"last_name": "Martin",
"job_title": "Finance Manager"
}
},
{
"type": "workspace",
"id": "550e8400-e29b-41d4-a716-446655440006",
"attributes": {
"name": "Finance Operations",
"description": "Financial operations and treasury management"
}
}
]
}Create a new financial transaction record with comprehensive payment details, foreign exchange information, remittance data, fees, and relationship associations.
curl --request POST \
--url https://api.wellapp.ai/v1/transactions \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"type": "transaction",
"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"
},
{
"type": "exchange_fee",
"amount": 5,
"currency": "EUR"
}
]
},
"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"
}
]
},
"created_by": {
"data": {
"type": "people",
"id": "550e8400-e29b-41d4-a716-446655440005"
}
},
"workspaces": {
"data": [
{
"type": "workspace",
"id": "550e8400-e29b-41d4-a716-446655440006"
}
]
}
}
}'{
"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"
},
{
"type": "exchange_fee",
"amount": 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"
}
},
"documents": {
"data": [
{
"type": "invoice",
"id": "550e8400-e29b-41d4-a716-446655440004"
}
]
},
"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": "Debtor Business Account",
"description": "Primary SEPA account for outgoing payments"
}
},
{
"type": "payment_means",
"id": "550e8400-e29b-41d4-a716-446655440001",
"attributes": {
"type": "account_details",
"status": "active",
"nickname": "Creditor Salary Account",
"description": "Employee salary receiving account"
}
},
{
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440002",
"attributes": {
"name": "Acme Corporation",
"description": "Leading technology solutions provider (debtor)"
}
},
{
"type": "people",
"id": "550e8400-e29b-41d4-a716-446655440003",
"attributes": {
"first_name": "John",
"last_name": "Doe",
"job_title": "Software Engineer"
}
},
{
"type": "invoice",
"id": "550e8400-e29b-41d4-a716-446655440004",
"attributes": {
"invoice_number": "INV-2024-0115",
"amount": 1250,
"currency": "EUR"
}
},
{
"type": "people",
"id": "550e8400-e29b-41d4-a716-446655440005",
"attributes": {
"first_name": "Marie",
"last_name": "Martin",
"job_title": "Finance Manager"
}
},
{
"type": "workspace",
"id": "550e8400-e29b-41d4-a716-446655440006",
"attributes": {
"name": "Finance Operations",
"description": "Financial operations and treasury management"
}
}
]
}Bearer token for authentication
Show child attributes
Transaction created successfully
Show child attributes