Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Field descriptions for a claim case

Claim cases help the claim agents resolve payment claim requests that they receive from the bank's customers or third-party banks.

When a claim request is submitted, it creates a claim case. Some of the fields on the case form are populated from the request from which the claim is created.

After the case is assigned, a claim agent fills out the fields on the case when dealing with the next steps. The next steps could include investigating the case, requesting a refund from a bank or customer, and completing the refund.

Details tab fields for a claim case

The Details tab on the form provides case-related information.

FieldDescription
NumberSystem-generated unique number for the case.- Internal: Comes from a customer of the bank. - External: Comes from a third-party bank
Claim type

Type of claim case. - Internal: Request came from a customer of the bank. - External: Request came from a third-party bank.

The claim type determines which flow to trigger and the form view to show.

Refund typeOption to indicate from where to get the refund for the claim.- Internal: Refund is made by the bank internally such as by a customer or the bank itself. - External: Refund comes from a third-party bank.
Error typeType of error indicating if it was due to the customer or bank. Usually, this field determines the best course for resolving the claim.
Error categoryError category for the claim. This list contains the industry-standard error categories that are based on the selected error type.
Error subcategoryError subcategory for the claim. This list contains the industry-standard error subcategories that are based on the selected error category.
StateState of the case.
Assignment groupUser group that can work on the case. If the case is not assigned to a user yet, any member of the this group can work on the case.
Assigned toUser assigned to the case.
Payment inquiryReference number of the payment inquiry case and indicates that the claim was created from that inquiry. This field appears only when the Claim type field is set to Internal and is auto-populated when the claim is created from an inquiry.
Requested treatmentRequested treatment for the claim either from the internal claims team or a third-party bank. This list contains the industry-standard treatments.
Actual treatmentActual treatment for the claim either from the internal claims team or a third-party bank.
Short descriptionBrief description of the case. This field is auto-populated from the selected request type. However, you can modify this description.
DescriptionDetailed description of the case.
Claim Details section
Claim bankBank that is associated to the claim. The list of financial institutions that appears in this field depends on the following:- Claim type – Internal or External. - Banks that are listed in the Financial Institution \[sn\_bom\_financial\_institution\] table.
External claim IDUnique ID for the claim provided by the third-party bank. This field appears only when the Claim type field is set to External.
Claim customerConsumer who opened the claim. This field appears only when the Claim type field is set to Internal. The field doesn't appear when a business customer is selected in the Claim account field.
Claim accountBusiness customer who opened the claim. This field appears only when the Claim type field is set to Internal. The field doesn't appear when a consumer is selected in the Claim customer field.
Claim contactContact of the business customer who opened the claim. This field appears only when the Claim type field is set to Internal. The field doesn't appear when a consumer is selected in the Claim customer field.
Claim financial accountDeposit account that the claim customer used. This field appears only when the Claim type field is set to Internal.
Claim transaction

Financial (Deposit) transaction that is used for the claim. This field appears only when the Claim type field is set to Internal.You can associate multiple transactions with a claim. These transactions also get listed in the Claim Transactions tab of the claim where you can view additional information about them.

For any changes in transactions, both the Claim Transaction field and the Claim Transactions tab are updated.

Transaction IDUnique identifier for the payment transaction that is to be shared with third-party banks.
Total amountTotal amount of the payment that is associated with the claim. Select the currency in which the payment was made.The Claim Transaction field sets the total amount based on the amount field in the transaction. If there are multiple transactions associated with the claim, amount of all are added to set the total amount.
Payment processorMethod of how the payment was made. The payment processor is region-specific.
Payment dateDate when the payment was made.
Recurring paymentOption to indicate if the payment was part of a recurring payment schedule.
International paymentOption to indicate if the payment was international.
Refund Details section
Refund bankBank that is associated to the refund. The list of financial institutions that appear in this field depends on the following:- Claim type – Internal or External. - Banks that are listed in the Financial Institution \[sn\_bom\_financial\_institution\] table.
Tracking IDUnique ID for the claim that is provided by the third-party bank. This field appears only when the Claim type field is set to External.
OutcomeRefund outcome for the claim. This field is auto-updated from the debit approval case when the Refund type field is set to Internal.
Refund amountTotal amount that is refunded based on the outcome of the refund. This field is auto-updated from the debit approval case when the Refund type field is set to Internal.Select the currency in which the refund is made.
Outcome notesAdditional notes about the refund outcome. This field is auto-updated from the debit approval case when the Refund type field is set to Internal.
Comments & Activities section
Additional commentsAgent's comments about the case progress.

Refund fields that are specific to claims with the Internal refund type

For claims with an internal refund type, the claim agent creates a debit approval case to request a refund internally from a bank or customer and fills out these fields.

Note: These fields appear only when the Refund type field is set to Internal.

FieldDescription
Refund Details section
Debit customerCustomer who refunds the claim, if the agent determines that the refund should come from a customer.
Debit financial accountDeposit account of the debit customer that is used for the refund. Note: This account might not be the same that received the money from the receiving transaction.
Debit accountBusiness customer who refunds the claim. This field doesn't appear when a consumer is selected in the Debit customer field.
Debit contactContact of the business customer who refunds the claim. This field doesn't appear when a consumer is selected in the Debit customer field.
Receiving transaction

Financial (deposit) transaction that the customer received and is used for the refund.You can associate multiple receiving transactions with a claim. These transactions also get listed in the Receiving Transactions tab of the claim where you can view additional information about them.

For any changes in transactions, both the Receiving Transaction field and the Receiving Transactions tab are updated.

Debit approvalDebit approval case number that is created to request the refund internally from a bank or customer. This field is auto-populated when you create a debit approval case for the claim. For more information, see Create a debit approval case for an internal refund.

Parent Topic:Financial Services Payment Operations reference