Cash-In Processing Failure

This event notifies when a cash-in message fails to process, ensuring the client is informed of the failure.

Type: object
Domain: banking-webhooks
Event: cashin-failure
Version: 1

client_request_id required

Title: Client request ID
Description: The ID associated with the client request
Type: string
Example:
12345

external_id required

Title: External ID
Description: The external ID associated with the transaction
Type: string
Example:
67890

provider required

Title: Provider
Description: Provider's name
Type: string
Example:
ProviderName

amount required

Title: Amount
Description: Transaction amount
Type: number
Example:
100.5

error_message required

Title: Error Message
Description: Detailed error message
Type: string
Example:
detailed error message

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Cash-In Processing Failure",
    "description": "This event notifies when a cash-in message fails to process, ensuring the client is informed of the failure.",
    "required": [
        "client_request_id",
        "external_id",
        "provider",
        "amount",
        "error_message"
    ],
    "properties": {
        "client_request_id": {
            "title": "Client request ID",
            "type": "string",
            "description": "The ID associated with the client request",
            "examples": [
                "12345"
            ]
        },
        "external_id": {
            "title": "External ID",
            "type": "string",
            "description": "The external ID associated with the transaction",
            "examples": [
                "67890"
            ]
        },
        "provider": {
            "title": "Provider",
            "type": "string",
            "description": "Provider's name",
            "examples": [
                "ProviderName"
            ]
        },
        "amount": {
            "title": "Amount",
            "type": "number",
            "description": "Transaction amount",
            "examples": [
                100.5
            ]
        },
        "error_message": {
            "title": "Error Message",
            "type": "string",
            "description": "Detailed error message",
            "examples": [
                "detailed error message"
            ]
        }
    }
}

{
    "client_request_id": "12345",
    "external_id": "67890",
    "provider": "ProviderName",
    "amount": 100.5,
    "error_message": "detailed error message"
}