Skip to content
iSmartPayDevelopers
Esc
↑↓navigate↵open⌘Jpreview

wallet.unfrozen

Sent when a freeze on one of your wallets is lifted. Another freeze may still be in place, so read status before sending money from it. Needs wallets.read to appear in the events list. Answer with any 2xx within 10 seconds. Anything else, a timeout or a redirect is retried up to 6 times over about a day. Events can arrive out of order, so compare statuses rather than trusting arrival order.

POSTwallet.unfrozenWebhook
Header parameters
Webhook-Idstringrequired

The event id. The same event can arrive more than once; use this to ignore repeats.

Webhook-Timestampstringrequired

Unix seconds when this attempt was signed. Reject a delivery older than 5 minutes.

Webhook-Signaturestringrequired

v1, then a comma, then the base64 HMAC-SHA256 of "{Webhook-Id}.{Webhook-Timestamp}.{raw body}" keyed with your endpoint's signing secret. Compare in constant time.

Request body
requiredapplication/json
idstringrequired

The event id, the same as the Webhook-Id header.

typestringrequired
createdAtstring<date-time>required

When the change happened.

dataWalletFreezerequired

The wallet that was unfrozen.

Show properties
walletIdstring<uuid>required

The wallet's id.

typestringrequired

The wallet's type, as on a sub-account.

Allowed:primarysub_accountoperationalpersonal
labelstringrequired
referencestring

The reference you gave the wallet. Left out for wallets made without one.

statusstringrequired

The wallet's status after the change. After wallet.unfrozen it is frozen while another freeze is still in place.

Allowed:activefrozen
frozenBystringrequired

Who froze the wallet, or who lifted the freeze for wallet.unfrozen: your business, or iSmartPay. iSmartPay's reason is never sent.

Allowed:ownerstaff
Responses
2XX

Received. Any 2xx stops retries.

Payload
{
  "id": "string",
  "type": "wallet.unfrozen",
  "createdAt": "2019-08-24T14:15:22Z",
  "data": {
    "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
    "type": "primary",
    "label": "string",
    "reference": "string",
    "status": "active",
    "frozenBy": "owner"
  }
}
Response
Received. Any 2xx stops retries.