Skip to content
/
Card upgrade to physical...

Weavr Webhook (v2)

For Verification, create a base64 hash using HmacSHA256 using Published-Timestamp header as message and your API key as secret. The result should match the Signature header.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://weavr.io
Languages
Servers
Mock server
https://api.weavr.io/_mock/products/webhooks/openapi
https://api.weavr.io/""

Corporates

Webhooks

Consumers

Webhooks

Managed Cards

Webhooks

Card expiry and renewalWebhook

Request

Notification that a card is about to expire, a card Expired or a Card was renewed.

Headers
call-refstring

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

published-timestampinteger(int64)required

The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

signature-v2stringrequired

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the call-ref + payload + published-timestamp using your API key.

signaturestringDeprecatedrequired

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the published-timestamp using your API key.

Bodyapplication/jsonrequired
idobject(InstrumentId)required

The id of the managed card on which the event occurred.

id.​idstring(Id)^[0-9]+$required
id.​typestring(InstrumentType)required
Enum"managed_cards""managed_accounts"
eventTypestring(ManagedCardsExpiryAndRenewalEventType)required

The type of event.

Enum"CARD_ABOUT_TO_EXPIRE""CARD_EXPIRED""CARD_RENEWED"
stateobject(ManagedInstrumentState)required

The state of the instrument.

state.​statestring(InstrumentState)required

The state of the instrument indicating what it can and cannot do as follows:

  • ACTIVE: The instrument is in an active state and can be used in transactions.
  • BLOCKED: The instrument is temporarily blocked and cannot be used. Any funds on the instrument are also frozen. The blockedReason provides more information as to why it was blocked.
  • DESTROYED: The instrument has been permanently destroyed. The destroyReason provides more information as to why it was destroyed.
  • NOT_ENABLED: The instrument is not enabled for use, since the linked user has not completed all necessary verification steps.
Enum"ACTIVE""BLOCKED""DESTROYED""NOT_ENABLED"
state.​blockedReasonstring(BlockedReason)

The reason why the instrument has been blocked:

  • USER: The root, or an authorised user, of the identity owning the instrument has temporarily blocked the instrument.
  • SYSTEM: The platform or an administrator of the platform has temporarily blocked the instrument.
  • LOST: The instrument has been blocked because it was marked as lost.
Enum"USER""SYSTEM""LOST"
state.​destroyedReasonstring(DestroyedReason)

The reason why the instrument has been destroyed:

  • SYSTEM: The platform or an administrator of the platform has destroyed the instrument.
  • USER: The root, or an authorised user, of the identity owning the instrument has destroyed the instrument.
  • LOST: The instrument was automatically destroyed as it was marked as lost.
  • STOLEN: The instrument was automatically destroyed as it was marked as stolen.
  • EXPIRED: The instrument was automatically destroyed as it expired.
  • COMPROMISED: The instrument was automatically destroyed as it was marked as compromised.
Enum"SYSTEM""USER""LOST""STOLEN""EXPIRED""COMPROMISED"
cardTypestring(CardType)required
Enum"VIRTUAL""PHYSICAL"
expiryMmyystring

The end date of this card, in MMYY format.

renewalTypestring(CardRenewalType)required

Indicates how the card will be handled once it is close to expiring.

  • RENEW: The card will be automatically renewed, keeping the same card number but with a new expiry date and CVV.
  • NO_RENEW: Once the expiry date is reached, the card is destroyed.
Enum"RENEW""NO_RENEW"
renewalTimestampstring^[0-9]+$

The timestamp when the card will be renewed, expressed in Epoch timestamp using millisecond precision.

application/json
{
  "id": {
    "id": "string",
    "type": "managed_cards"
  },
  "eventType": "CARD_ABOUT_TO_EXPIRE",
  "state": {
    "state": "ACTIVE",
    "blockedReason": "USER",
    "destroyedReason": "SYSTEM"
  },
  "cardType": "VIRTUAL",
  "expiryMmyy": "string",
  "renewalType": "RENEW",
  "renewalTimestamp": "string"
}

Responses

Success - No Content

Card upgrade to physical detailsWebhook

Request

Notification that there has been an update in the card upgrade to physical process

Headers
call-refstring

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

published-timestampinteger(int64)required

The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

signature-v2stringrequired

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the call-ref + payload + published-timestamp using your API key.

signaturestringDeprecatedrequired

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the published-timestamp using your API key.

Bodyapplication/jsonrequired
idobject(InstrumentId)required

The id of the managed card on which the event occurred.

id.​idstring(Id)^[0-9]+$required
id.​typestring(InstrumentType)required
Enum"managed_cards""managed_accounts"
physicalCardDetailsobject(PhysicalCardDetails)required
physicalCardDetails.​bulkDeliveryboolean(BulkCardDelivery)

Bulk delivery is available for deliveryMethods REGISTERED_MAIL or COURIER. All cards marked as bulk and ordered within the fulfilment centre’s dispatch window will be sent in bulk. Delivery address must be identical for all orders. contactNumber in the deliveryAddress object is mandatory when bulk is selected. Maximum number of cards delivered in a single box/packet is REGISTERED_MAIL = 90, COURIER = 200.

physicalCardDetails.​productReferencestring

The unique reference indicating the configuration of the physical card. Example the card design.

physicalCardDetails.​carrierTypestring
physicalCardDetails.​pendingActivationbooleanrequired

Indicates if the physical card is activated for physical usage such as with physical terminals.

physicalCardDetails.​pinBlockedboolean

Indicates if the physical card is blocked due to providing incorrect PINs.

physicalCardDetails.​manufacturingStatestring(ManufacturingState)

Information on the manufacturing of the physical card, as follows:

  • REQUESTED: The upgrade of the card to physical has been requested.
  • SENT_FOR_FULFILLMENT - The card has been sent for printing.
  • DISPATCHED: The card has been manufactured and dispatched. You may receive a second DISPATCHED event when the manufacturer provides a tracking code.
  • DELIVERED: The card has been received and activated by the recipient.
Enum"REQUESTED""SENT_FOR_FULFILLMENT""DISPATCHED""DELIVERED"
physicalCardDetails.​deliveryAddressobject(DeliveryAddress)

The delivery address where the physical card is delivered.

physicalCardDetails.​deliveryMethodstring(DeliveryMethod)

The delivery methods supported for delivering printed physical cards. If not specified, the STANDARD_DELIVERY method will be used.

Enum"STANDARD_DELIVERY""REGISTERED_MAIL""COURIER""FIRST_CLASS_MAIL"
physicalCardDetails.​deliveryTrackingCodestring(DeliveryTrackingCode)

The delivery tracking code for tracking the physical card's delivery status. This may not always be available on the first dispatched event, and so you will receive an additional dispatched notification with the delivery tracking code populated as soon as it is available.

physicalCardDetails.​deliveryTrackingMethodstring(DeliveryTrackingMethod)

The delivery tracking method for tracking the physical card's delivery status.

physicalCardDetails.​deliveryTrackingUrlstring(DeliveryTrackingUrl)

The delivery tracking URL for tracking the physical card's delivery status.

physicalCardDetails.​replacementobjectDeprecated

Indicates if the physical card is replaced by another card.

physicalCardDetails.​nameOnCardLine2string<= 27 charactersDeprecated^[a-zA-Z0-9ßÀÁÂÃÄÅǍÆÇÈÉÊËÌÍÎÏÒÓÔÕÖØŠÙÚÛÜŸÝĄĆČ...

Line 2 of the 'name on card' field. For Physical cards, this field will be printed on the card. The maximum characters allowed will depend on the design chosen and will be provided to you by Weavr when setting up your plastic cards. This field is deprecated

upgradedTimestampstring^[0-9]+$required

Epoch timestamp using millisecond precision.

application/json
{
  "id": {
    "id": "string",
    "type": "managed_cards"
  },
  "physicalCardDetails": {
    "bulkDelivery": true,
    "productReference": "string",
    "carrierType": "string",
    "pendingActivation": true,
    "pinBlocked": true,
    "manufacturingState": "REQUESTED",
    "replacement": { … },
    "deliveryAddress": { … },
    "deliveryMethod": "STANDARD_DELIVERY",
    "deliveryTrackingCode": "string",
    "deliveryTrackingMethod": "string",
    "deliveryTrackingUrl": "string",
    "nameOnCardLine2": "string"
  },
  "upgradedTimestamp": "string"
}

Responses

Success - No Content

Card replacementWebhook

Request

Notification that a card replacement has been requested or processed.

Headers
call-refstring

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

published-timestampinteger(int64)required

The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

signature-v2stringrequired

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the call-ref + payload + published-timestamp using your API key.

signaturestringDeprecatedrequired

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the published-timestamp using your API key.

Bodyapplication/jsonrequired
eventTypestring(ManagedCardsReplacementEventType)required

The type of replacement event that occurred.

Enum"VIRTUAL_REPLACEMENT""PHYSICAL_REPLACEMENT"
idobject(InstrumentId)required

The id of the managed card on which the event occurred.

id.​idstring(Id)^[0-9]+$required
id.​typestring(InstrumentType)required
Enum"managed_cards""managed_accounts"
replacementIdobject(InstrumentId)

The id of the replacement card.

replacementReasonstring(ReplacementType)required
Enum"DAMAGED""LOST_STOLEN""RENEW""COMPROMISED"
replacementTimestampstring^[0-9]+$required

Epoch timestamp using millisecond precision.

userIdstring(UserId)^[0-9]+$

The id of the user linked to the managed card that was replaced.

application/json
{
  "eventType": "VIRTUAL_REPLACEMENT",
  "id": {
    "id": "string",
    "type": "managed_cards"
  },
  "replacementId": {
    "id": "string",
    "type": "managed_cards"
  },
  "replacementReason": "DAMAGED",
  "replacementTimestamp": "string",
  "userId": "string"
}

Responses

Success - No Content

Managed Accounts

Webhooks

Linked Accounts

Webhooks

Transfers

Webhooks

Send

Webhooks

Outgoing Wire Transfers

Webhooks

Manual Transactions

Webhooks

Fees

Webhooks

Login

Webhooks

Stepup

Webhooks

Authentication Factors

Webhooks

Beneficiaries

Webhooks

Bulk Operations

Webhooks

Auth Users

Webhooks