Save Transaction

When to use it: Use this webhook to register a new incoming payment/transaction into a merchant account.

webhookType: SAVE_TRANSACTION

When working with transactions, it is essential to use a common identifier to link multiple transactions associated with a single expense. To achieve this, ensure that the orderId field within the SAVE_TRANSACTION webhook contains the same unique value for all related transactions, such as reserve transactions, accepted transactions, and others.

For a proper categorisation of the transactions, make sure you are identifying the different fields, by looking at the Mapping and Enums documentation, paying special attention to the logic affecting the fields Pay type and Transaction type .

Transaction title

Transaction title is used to identify the key description or label associated with a transaction. It is displayed on the transaction list to help users quickly understand the nature of the transaction. By default, the transaction title is populated with specific data based on Pay Type. The following rules apply:

Card Transaction: the title is populated with the merchant field.
Inbound Transactions: the title is populated with the sourceAccount name.
Outbound Transactions: the title is populated with the destinationAccount name.
Manual Transactions: the title is populated with the merchant field.

model

{
    "id": "uuid",
    "user": "string",
    "company": "string",
    "customer": "string",
    "clientType": "BUSINESS | CONSUMER",
    "type": "EXPENSE | PAYMENT | PURCHASE | TAX | INBOUND",
    "description": "string",
    "status": "FAILED | PENDING | ACCEPTED | CANCELLED",
    "currency": "string",
    "baseCurrency": "string",
    "total": "number (double)",
    "baseTotal": "number (double)",
    "transactionNumber": "string",
    "categoryCode": "string",
    "merchant": "string",
    "merchantId": "string",
    "address": "string",
    "payType": "CARD | INBOUND_BANK_TRANSFER | OUTBOUND_BANK_TRANSFER | OUTBOUND_BANK_TRANSFER_DIRECT_DEBIT",
    "payMethod": {
        "label": "TSB_CARD | OTHERS"
    },
    "date": "string (date)",
    "sourceAccount": {
        "id": "uuid",
        "type": "AUD | CHF | CAD | SEK | GOLDBLOC | USD | NOK | WHISKY | JPY | NZD | GOLD | GBP | EUR | CZK | DKK | HUF | PLN | RON | ILS | RUB | BHD | SAR | BGN | KES | SGD | KWD | ZAR | CNY | MYR | HRK | MXN | THB | TRY | OMR | UGX | HKD | PHP | AED | INR | QAR | IDR | POINTS",
        "name": "string",
        "iban": "string",
        "bicSwift": "string",
        "ukAccountNumber": "string",
        "ukSortCode": "string",
        "accountNumber": "string",
        "routingNumber": "string",
        "caRoutingNumber": "string",
        "address": "string",
        "address2": "string",
        "city": "string",
        "postalCode": "string",
        "countryCode": "string"
    },
    "lines": [
        {
            "id": "string",
            "categoryCode": "string",
            "total": "number (double)",
            "baseTotal": "number (double)"
        }
    ],
    "balance": "number (double)",
    "country": "string",
    "corePaymentType": 
        "payment-type-Global-SWIFT",
        "payment-type-UK-BACS",
        "payment-type-EU-SEPA-Target2",
        "payment-type-UK-Chaps",
        "payment-type-EU-SEPA-Step2",
        "payment-type-virtual-debit-card-debit",
        "payment-type-inter-ledger",
        "payment-type-UK-FasterPayments",
        "payment-type-fx",
        "payment-type-card",
        "payment-type-card-reserve",
        "payment-type-EU-SEPA-Instant",
        "payment-type-AU-NPP",
        "payment-type-EU-Target2",
        "payment-type-AU-DE",
        "payment-type-US-ACH",
        "payment-type-SG-FAST",
        "payment-type-US-Wires",
        "SPEI",
        "AUS-PAY-NET",
        "EFT",
        "NCS",
        "CERTIS",
        "STRAKSCLEARING-Instant",
        "INTRADAGCLEARING",
        "CHATS",
        "GIRO_ZRT",
        "IMPS",
        "NEFT",
        "SKN",
        "IBG",
        "NORWEGIAN-INTERBANK-CLEARING-SYSTEM",
        "PESONET",
        "ELIXIR",
        "TRANSFOND_SENT_ACH",
        "FAST",
        "INTERNAL-TRANSFER",
        "RIX",
        "FEDACH",
        "FEDWIRE",
        "CHIPS",
        "SEPA",
        "TARGET2",
        "DIRECT_DEBIT_OUTBOUND",
    "bankName": "string",
    "bankLogo": "string",
    "bankDescription": "string",
    "failureReason": "string",
    "finalTxNumber": "string",
    "cardId": "string",
    "orderId": "string",
    "executionDate": "string"
}

example:

{
    "id": "c14a080d-7bd3-4bab-8e2f-1d71a0123e5f",
    "user": "John Doe",
    "company": "ABC Inc.",
    "customer": "Jane Smith",
    "clientType": "BUSINESS",
    "type": "EXPENSE",
    "description": "Office supplies",
    "status": "ACCEPTED",
    "currency": "USD",
    "baseCurrency": "USD",
    "total": 250.75,
    "baseTotal": 250.75,
    "transactionNumber": "TXN123456",
    "categoryCode": "OFFICE",
    "merchant": "Office Depot",
    "merchantId": "",
    "address": "123 Main St",
    "payType": "OUTBOUND_BANK_TRANSFER",
    "payMethod": {
        "label": "OTHERS"
    },
    "date": "2024-06-27",
    "sourceAccount": {
        "id": "60d7f7a3f163b41f94f89c24",
        "type": "USD",
        "name": "Primary Account",
        "iban": "GB29NWBK60161331926819",
        "bicSwift": "NWBKGB2L",
        "ukAccountNumber": "41495926",
        "ukSortCode": "601613",
        "accountNumber": "1234567890",
        "routingNumber": "021000021",
        "caRoutingNumber": "123456789",
        "address": "456 Elm St",
        "address2": "",
        "city": "London",
        "postalCode": "SW1A 1AA",
        "countryCode": "GB"
    },
    "lines": [
        {
            "id": "line1",
            "categoryCode": "OFFICE",
            "total": 150.50,
            "baseTotal": 150.50
        },
        {
            "id": "line2",
            "categoryCode": "SUPPLIES",
            "total": 100.25,
            "baseTotal": 100.25
        }
    ],
    "balance": 5000.25,
    "country": "UK",
    "corePaymentType": "payment-type-UK-BACS",
    "bankName": "New Bank",
    "bankLogo": "https://example.com/bank-logo.png",
    "bankDescription": "A new bank for the future",
    "failureReason": "",
    "finalTxNumber": "FINAL123",
    "cardId": "",
    "orderId": "ORDER987654",
    "executionDate": "2024-06-28"
}