Event Name
debitRequest.debitFailed
Domain
holdings
Description

Indicates the settlement service request to debit account is failure

Properties
{
    "requestStatus": {
        "type": "array",
        "description": "The current status of the request. The possible values includes New, send to printer, cancelled and processed.",
        "items": {
            "id": "urn:jsonschema:RequestStatus",
            "properties": {
                "numberOfRequestSucceeded": {
                    "type": "string",
                    "description": "Indicates the number of transaction requests that are succeeded"
                },
                "numberOfRequestFailed": {
                    "type": "string",
                    "description": "Indicates the number of transaction requests that are failed"
                },
                "numberOfRequestSuspended": {
                    "type": "string",
                    "description": "Indicates the number of transaction requests that are suspended due to a validation error or warning"
                },
                "numberOfRequestSubmittedForRetry": {
                    "type": "string",
                    "description": "Indicates the number of transaction requests that are submitted for retry because of shortfall on the account balance"
                },
                "requestType": {
                    "type": "string",
                    "description": "Contains the value as INTERNAL/EXTERNAL type of record"
                },
                "responseDetails": {
                    "type": "array",
                    "description": "Contains the response details for the executed payment request",
                    "items": {
                        "id": "urn:jsonschema:ResponseDetails",
                        "properties": {
                            "accountId": {
                                "type": "string",
                                "description": "Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"
                            },
                            "transactionAmount": {
                                "type": "string",
                                "description": "Contains the transaction amount. This is based on the currency, either local or foreign currency"
                            },
                            "transactionCurrency": {
                                "type": "string",
                                "description": "Indicates the currency of the transaction. For example GBP, USD etc."
                            },
                            "transactionReference": {
                                "type": "string",
                                "description": "Contains the identifier for the transaction in the core system"
                            },
                            "companyId": {
                                "type": "string",
                                "description": "Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."
                            },
                            "creditDebitIndicator": {
                                "type": "string",
                                "description": "Identifies the type of transaction i.e. DEBIT or CREDIT"
                            },
                            "warnings": {
                                "type": "array",
                                "description": "Contains warning errors if any.",
                                "items": {
                                    "id": "urn:jsonschema:Warnings",
                                    "properties": {
                                        "warning": {
                                            "type": "string",
                                            "description": "Contains warning errors if any."
                                        }
                                    }
                                }
                            },
                            "errorMessages": {
                                "type": "array",
                                "description": "Contains the description of the error.",
                                "items": {
                                    "id": "urn:jsonschema:ErrorMessages",
                                    "properties": {
                                        "errorMessage": {
                                            "type": "string",
                                            "description": "Contains the description of the error."
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "callBackDetails": {
        "type": "array",
        "description": "Contains the call back information based on which the payment needs to be executed in requestor system",
        "items": {
            "id": "urn:jsonschema:CallBackDetails",
            "properties": {
                "callBackActivity": {
                    "type": "string",
                    "description": "Contains the name of the activity to be executed in the requestor system after payment is executed"
                },
                "callBackSystemId": {
                    "type": "string",
                    "description": "Identifier of the requestor system to which response to the payment request has to be routed"
                },
                "callBackCompanyId": {
                    "type": "string",
                    "description": "Identifier of the requestor company to which response to the payment request has to be routed"
                },
                "callBackAmount": {
                    "type": "string",
                    "description": "Indicates the amount which needs to be posted in the requestor system"
                },
                "callBackAccountId": {
                    "type": "string",
                    "description": "Identifier of the requestor account to which response to the payment request has to be routed"
                },
                "paymentValueDate": {
                    "type": "string",
                    "description": "Indicates the date on which the payment is to be executed."
                },
                "creditDebitIndicator": {
                    "type": "string",
                    "description": "Identifies the type of transaction i.e. DEBIT or CREDIT"
                }
            }
        }
    },
    "sourceSystem": {
        "type": "string",
        "description": "Specifies an alternative short name to refer the current backend system"
    }
}