Skip to content

Swift receive credit
Webhook

Request

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.

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.

Example:t7FMhk3OARMgwqz0LJXO...
X-Delivery-Idstring, (uuid)

Unique identifier for this webhook delivery attempt.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890
X-Test-Notificationboolean

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

Example:true
Bodyapplication/json
schema_versionstring

Version of the event schema. Determined by the schema_version on your webhook subscription.

Value:"4.0.0"
Example:"4.0.0"
Discriminator
subscription_idstring, (uuid)

ID of the webhook subscription that triggered this event.

Example:"01234567-89ab-cdef-0123-456789abcdef"
event_typestring

Event type identifier

Example:"swift-in#credit"
sent_atstring, (date-time)

Timestamp when the event was sent.

Example:"2023-08-21T12:34:58.123Z"
dataobject
Payload
{
  "schema_version": "4.0.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": { … },
      "sender": { … },
      "exchange_rate": 0.8,
      "instructed_amount": { … },
      "settled_amount": { … },
      "fee": { … },
      "transaction_time": "2023-08-21T12:34:56.456Z",
      "previous_instructing_agents": [ … ]
    },
    "occurred_at": "2023-08-21T12:34:56.789Z"
  }
}

Responses

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

Bodyapplication/json
statusstring
Example:"ok"
Response
{
  "status": "ok"
}