Skip to content
Sections

Bank callbacks

Ingest a verified Salt Edge bank-feed event

POST/financial-bank-provider-webhooks/salt-edge

Verifies the v6 callback signature, exact URL and raw body, callback version, timestamp, connection identity, and replay evidence before activating or degrading the connection and queuing incremental sync.

Authentication

signature: <SIGNATURE>

Salt Edge RSA SHA-256 callback signature over the exact callback URL and raw request body.

signature-key-version: <SIGNATURE_KEY_VERSION>

Certified Salt Edge callback public-key version used for strict signature verification and rotation control.

Connection guide

Parameters

signatureHeader · Required

Salt Edge RSA SHA-256 callback signature over the exact callback URL and raw request body.

string
Full definition
{
  "type": "string",
  "example": "example"
}
signature-key-versionHeader · Required

Certified Salt Edge callback public-key version used for strict signature verification and rotation control.

string
Full definition
{
  "type": "string",
  "example": "example"
}
Signature-Key-VersionHeader · Required

Salt Edge callback public-key version; Finance accepts the certified v6 key.

string
Full definition
{
  "type": "string",
  "example": "example"
}
SignatureHeader · Required

Salt Edge AIS RSA SHA-256 callback signature over callback URL and raw body.

string
Full definition
{
  "type": "string",
  "example": "example"
}

Request body

Required

Exact Salt Edge v6 JSON callback body verified with its RSA signature.

application/json

object
Full definition
{
  "type": "object",
  "additionalProperties": {
    "$ref": "#/components/schemas/JsonValue"
  },
  "example": {
    "exampleKey": "example"
  }
}

Responses

200The verified callback was accepted or recognized as an exact replay.
FinancialBankWebhookResultDto
Full definition
{
  "$ref": "#/components/schemas/FinancialBankWebhookResultDto"
}
Example response · 200 · application/json
{
  "accepted": true,
  "replay": true
}

Schemas

JsonValue

Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.

Full definition
{
  "oneOf": [
    {
      "type": "string",
      "nullable": true,
      "example": "example"
    },
    {
      "type": "number",
      "example": 0
    },
    {
      "type": "boolean",
      "example": true
    },
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "description": "Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.",
  "example": "example"
}
FinancialBankWebhookResultDto

Source-owned Finance PRO representation of financial bank webhook result.

acceptedRequired

True after the signed provider callback passes environment, timestamp, body, and replay validation.

boolean
Full definition
{
  "type": "boolean",
  "description": "True after the signed provider callback passes environment, timestamp, body, and replay validation.",
  "example": true
}
replayRequired

True when the callback matches an already accepted immutable receipt and causes no duplicate processing.

boolean
Full definition
{
  "type": "boolean",
  "description": "True when the callback matches an already accepted immutable receipt and causes no duplicate processing.",
  "example": true
}
Full definition
{
  "type": "object",
  "properties": {
    "accepted": {
      "type": "boolean",
      "description": "True after the signed provider callback passes environment, timestamp, body, and replay validation.",
      "example": true
    },
    "replay": {
      "type": "boolean",
      "description": "True when the callback matches an already accepted immutable receipt and causes no duplicate processing.",
      "example": true
    }
  },
  "required": [
    "accepted",
    "replay"
  ],
  "description": "Source-owned Finance PRO representation of financial bank webhook result.",
  "example": {
    "accepted": true,
    "replay": true
  }
}

Hallify uses essential cookies and optional analytics.

Essential cookies keep sign-in, locale, and theme preferences working. Analytics is off until you choose to allow it.