Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
webhook-event

Swift receive credit

Triggered every time a SWIFT message is received and a credit is deposited into a balance account.

If you also subscribe to balances#credit or transfers#state-change on the same profile or application, you may experience some duplication of webhook events. You should make allowances for this to handle it in your implementation.

  • Event type: swift-in#credit
  • Profile level subscriptions: Supported
  • Application level subscriptions: Supported

Events may not be delivered in the order they occurred. Use data.occurred_at to reconcile the order. See the Event ordering guide for details.

See the Webhooks guide for setup instructions, signature verification, and best practices.

postWebhookswift-in#credit

Headers

X-Signature-SHA256string

RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the Wise public key to ensure the request is authentic and has not been tampered with.

X-Delivery-Idstring uuid

Unique identifier for this webhook delivery attempt.

X-Test-Notificationboolean

Present with the value true if this is a test notification sent to verify your callback URL during subscription setup.

Payload

OR
OR
OR

Example payload

{
  "schema_version": "4.2.0",
  "subscription_id": "01234567-89ab-cdef-0123-456789abcdef",
  "event_type": "swift-in#credit",
  "sent_at": "2023-08-21T12:34:58.123Z",
  "data": {
    "action": {
      "type": "credit",
      "id": 12345,
      "profile_id": 222,
      "account_id": 333
    },
    "resource": {
      "id": "55555",
      "uetr": "f875814b-7d44-4d1b-a499-123456789abcde",
      "reference": "/RFB/BET072",
      "recipient": {
        "name": "JOHN SMITH",
        "address": {
          "address_lines": [
            "6 Evergreen Ave",
            "Brussels"
          ],
          "street_name": "Evergreen Ave",
          "building_number": "6",
          "town_name": "BRUSSELS",
          "postal_code": "1000",
          "country_code": "BE"
        },
        "account": "BE1234567891234",
        "bank_details": {
          "bic": "EXMPBEBB",
          "name": "EXAMPLE BANK BELGIUM",
          "address": {
            "address_lines": [
              "1 Rue de l'Exemple",
              "Brussels"
            ],
            "street_name": "Rue de l'Exemple",
            "building_number": "1",
            "town_name": "BRUSSELS",
            "postal_code": "1000",
            "country_code": "BE"
          }
        }
      },
      "sender": {
        "name": "GEORGE SMITH",
        "address": {
          "address_lines": [
            "10 Evergreen Street",
            "Brussels"
          ],
          "street_name": "Evergreen Street",
          "building_number": "10",
          "town_name": "BRUSSELS",
          "postal_code": "1000",
          "country_code": "BE"
        },
        "account": "EE947700771111111111",
        "bank_details": {
          "bic": "TESTDEFF",
          "name": "TEST BANK AG",
          "address": {
            "address_lines": [
              "10 Musterstrasse",
              "Frankfurt"
            ],
            "street_name": "Musterstrasse",
            "building_number": "99",
            "town_name": "FRANKFURT",
            "postal_code": "60311",
            "country_code": "DE"
          }
        }
      },
      "exchange_rate": 0.8,
      "instructed_amount": {
        "value": 1000,
        "currency": "USD"
      },
      "settled_amount": {
        "value": 786.54,
        "currency": "GBP"
      },
      "fee": {
        "wise": [
          {
            "type": "conversion",
            "value": 2.76,
            "currency": "GBP"
          }
        ],
        "correspondent": [
          {
            "value": 4.5,
            "currency": "USD"
          }
        ]
      },
      "transaction_time": "2023-08-21T12:34:56.456Z",
      "previous_instructing_agents": [
        {
          "bic": "SAMPUS33",
          "name": "SAMPLE BANK USA",
          "address": {
            "address_lines": [
              "100 Fictional Avenue",
              "NEW YORK"
            ],
            "street_name": "Fictional Avenue",
            "building_number": "100",
            "town_name": "NEW YORK",
            "postal_code": "10001",
            "country_sub_division": "NY",
            "country_code": "US"
          }
        }
      ],
      "incoming_transfer_type": "CUSTOMER_CREDIT_TRANSFER"
    },
    "occurred_at": "2023-08-21T12:34:56.789Z"
  }
}

Response

Return any 2xx status to acknowledge receipt of the event.

statusstring

Example response

{
  "status": "ok"
}