Weavr Webhook (2.14.10)

Download OpenAPI specification:Download

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.

Corporates

Corporate activation

Notification that a corporate identity has been activated.

header Parameters
call-ref
string

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-timestamp
required
integer <int32>

The timestamp when this event was published

signature
required
string

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

Request Body schema: application/json
actionDoneBy
required
string
Enum: "ADMIN" "INNOVATOR"
emailAddress
required
string

Responses

Request samples

Content type
application/json
{
  • "actionDoneBy": "ADMIN",
  • "emailAddress": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Corporate deactivation

Notification that a corporate identity has been deactivated.

header Parameters
call-ref
string

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-timestamp
required
integer <int32>

The timestamp when this event was published

signature
required
string

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

Request Body schema: application/json
actionDoneBy
required
string
Enum: "ADMIN" "INNOVATOR"
emailAddress
required
string
reasonCode
required
string
Enum: "ACCOUNT_REVIEW" "ACCOUNT_SECURITY" "TEMPORARY" "ACCOUNT_CLOSURE" "ACCOUNT_ABANDONED"

Responses

Request samples

Content type
application/json
{
  • "actionDoneBy": "ADMIN",
  • "emailAddress": "string",
  • "reasonCode": "ACCOUNT_REVIEW"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Corporate beneficiary status update

Notification that the verification status of a corporate beneficiary has been updated.

header Parameters
call-ref
string

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-timestamp
required
integer <int32>

The timestamp when this event was published

signature
required
string

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

Request Body schema: application/json
event
Array of strings (BeneficiaryEventType)

The event that triggered this webhook notification. The event is structured to describe the parameter that has triggered the event followed by the action that occurred.

Items Enum: "STATUS_UPDATED" "BENEFICIARY_TYPE_UPDATED" "FIRST_NAME_UPDATED" "MIDDLE_NAME_UPDATED" "LAST_NAME_UPDATED" "EMAIL_UPDATED"
eventDetails
Array of strings (FailureReason)

A reason, if any, describing why this event has occurred.

Items Enum: "DOCUMENTS_UNSATISFACTORY" "SUPPLIED_DATA_AND_DOCUMENTS_MISMATCH" "LANGUAGE_IN_DOCUMENTS_UNSUPPORTED" "SELFIE_UNSATISFACTORY" "SELFIE_AND_DOCUMENTS_MISMATCH" "CORPORATE_DETAILS_UNSATISFACTORY" "BENEFICIARY_DETAILS_UNSATISFACTORY" "REPRESENTATIVE_DETAILS_UNSATISFACTORY" "OTHER" "ROOT_USER_UNMATCHED_TO_DIRECTOR_OR_REPRESENTATIVE"
object

Additional information related to the event triggering this notification.

rejectionComment
string

Reason shown to the user in case of temporary rejection.

Responses

Request samples

Content type
application/json
{
  • "event": [
    ],
  • "eventDetails": [
    ],
  • "additionalInformation": {
    },
  • "rejectionComment": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Corporate KYB status update

Notification that the KYB status of a corporate identity has been updated.

header Parameters
call-ref
string

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-timestamp
required
integer <int32>

The timestamp when this event was published

signature
required
string

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

Request Body schema: application/json
corporateId
integer <int64>

Id of the corporate.

corporateEmail
string

Email of the corporate.

status
string

Status of the corporate.

Enum: "NOT_STARTED" "INITIATED" "PENDING_REVIEW" "APPROVED" "REJECTED"
details
Array of strings (FailureReason)

Action which my be required to re-process kyb in case of temporary rejections.

Items Enum: "DOCUMENTS_UNSATISFACTORY" "SUPPLIED_DATA_AND_DOCUMENTS_MISMATCH" "LANGUAGE_IN_DOCUMENTS_UNSUPPORTED" "SELFIE_UNSATISFACTORY" "SELFIE_AND_DOCUMENTS_MISMATCH" "CORPORATE_DETAILS_UNSATISFACTORY" "BENEFICIARY_DETAILS_UNSATISFACTORY" "REPRESENTATIVE_DETAILS_UNSATISFACTORY" "OTHER" "ROOT_USER_UNMATCHED_TO_DIRECTOR_OR_REPRESENTATIVE"
rejectionComment
string

Reason shown to the user in case of temporary rejection.

Responses

Request samples

Content type
application/json
{
  • "corporateId": 0,
  • "corporateEmail": "string",
  • "status": "NOT_STARTED",
  • "details": [
    ],
  • "rejectionComment": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Consumers

Consumer activation

Notification that a consumer identity has been activated.

header Parameters
call-ref
string

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-timestamp
required
integer <int32>

The timestamp when this event was published

signature
required
string

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

Request Body schema: application/json
actionDoneBy
required
string
Enum: "ADMIN" "INNOVATOR"
emailAddress
required
string

Responses

Request samples

Content type
application/json
{
  • "actionDoneBy": "ADMIN",
  • "emailAddress": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Consumer deactivation

Notification that a consumer identity has been deactivated.

header Parameters
call-ref
string

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-timestamp
required
integer <int32>

The timestamp when this event was published

signature
required
string

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

Request Body schema: application/json
actionDoneBy
required
string
Enum: "ADMIN" "INNOVATOR"
emailAddress
required
string
reasonCode
required
string
Enum: "ACCOUNT_REVIEW" "ACCOUNT_SECURITY" "TEMPORARY" "ACCOUNT_CLOSURE" "ACCOUNT_ABANDONED"

Responses

Request samples

Content type
application/json
{
  • "actionDoneBy": "ADMIN",
  • "emailAddress": "string",
  • "reasonCode": "ACCOUNT_REVIEW"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Consumer KYC status update

Notification that the KYC status of a consumer identity has been updated.

header Parameters
call-ref
string

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-timestamp
required
integer <int32>

The timestamp when this event was published

signature
required
string

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

Request Body schema: application/json
consumerId
integer <int64>
consumerEmail
string
status
string (KyiStatus)
Enum: "NOT_STARTED" "INITIATED" "PENDING_REVIEW" "APPROVED" "REJECTED"
details
Array of strings (RejectionReason)

Action which my be required to re-process kyc in case of temporary rejections.

Items Enum: "DOCUMENTS_UNSATISFACTORY" "SUPPLIED_DATA_AND_DOCUMENTS_MISMATCH" "LANGUAGE_IN_DOCUMENTS_UNSUPPORTED" "SELFIE_UNSATISFACTORY" "SELFIE_AND_DOCUMENTS_MISMATCH" "OTHER"
rejectionComment
string

Reason shown to the user in case of temporary rejection.

Responses

Request samples

Content type
application/json
{
  • "consumerId": 0,
  • "consumerEmail": "string",
  • "status": "NOT_STARTED",
  • "details": [
    ],
  • "rejectionComment": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Managed Accounts

Account deposit

Notification that a deposit (incoming bank transfer) has been performed on a managed account.

header Parameters
call-ref
string

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-timestamp
required
integer <int32>

The timestamp when this event was published

signature
required
string

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

Request Body schema: application/json
required
object

The id of the managed account where a deposit has been performed.

transactionId
required
integer <int64>

The id of the transaction, for reference.

required
object

A message representing a monetary amount in a particular currency.

transactionTimestamp
required
integer <int64>

The timestamp of the transaction, using epoch timestamp with millisecond precision.

emailAddress
string

The email address of the user who effected the deposit.

required
object
senderName
string
state
string (ManagedAccountsDepositEventDepositState)
Enum: "PENDING" "COMPLETED"

Responses

Request samples

Content type
application/json
{
  • "id": {
    },
  • "transactionId": 0,
  • "transactionAmount": {
    },
  • "transactionTimestamp": 0,
  • "emailAddress": "string",
  • "owner": {
    },
  • "senderName": "string",
  • "state": "PENDING"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Account update

Notification that the status of a managed account has been updated.

header Parameters
call-ref
string

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-timestamp
required
integer <int32>

The timestamp when this event was published

signature
required
string

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

Request Body schema: application/json
required
object
publishedTimestamp
required
integer <int64>

Epoch timestamp using millisecond precision.

type
required
string
Enum: "CREATED" "UPDATED" "REQUESTED" "REJECTED"

Responses

Request samples

Content type
application/json
{
  • "account": {
    },
  • "publishedTimestamp": 0,
  • "type": "CREATED"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Managed Cards

Card authorisation

Notification that a card authorisation attempt has been performed on a managed card. This is sent irrespective of the authorisation outcome - the approved field indicates whether the authorisation has been approved or denied.

header Parameters
call-ref
string

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-timestamp
required
integer <int32>

The timestamp when this event was published

signature
required
string

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

Request Body schema: application/json
required
object

The id of the managed card on which an authorisation has been performed.

transactionId
required
integer <int64>

The id of the transaction, for reference.

required
object

A message representing a monetary amount in a particular currency.

transactionTimestamp
required
integer <int64>

The timestamp of the transaction, using epoch timestamp with millisecond precision.

required
object

A message representing a monetary amount in a particular currency.

merchantName
required
string

The name of the merchant where the authorisation has been made.

merchantCategoryCode
string

The merchant category code.

merchantId
string

The merchant ID.

approved
boolean

Indicates whether the authorisation has been approved or denied.

object
Deprecated

A message representing a monetary amount in a particular currency.

declineReason
string

An indication of why the authorisation was declined

Enum: "PHYSICAL_NOT_ACTIVATED" "INSUFFICIENT_BALANCE" "CVV_CHECKS_FAILED" "CVV_RETRIES_EXCEEDED" "CARD_STATUS_NOT_ALLOWED" "PIN_CHECKS_FAILED" "PIN_RETRIES_EXCEEDED" "CARD_EXPIRY_CHECKS_FAILED" "AVS_CHECKS_FAILED" "ATM_WITHDRAWAL_LIMIT_EXCEEDED" "SCA_REQUIRED" "AUTH_RULE_CHECKS_FAILED" "TRANSACTION_NOT_PERMITTED" "TIMEOUT"
authRuleFailedReason
string

If the authorisation was declined due to auth rule checks, this indicates the auth rule that was violated.

Enum: "MERCHANT_CATEGORY_NOT_IN_ALLOWED_LIST" "MERCHANT_CATEGORY_BLOCKED" "MERCHANT_ID_NOT_IN_ALLOWED_LIST" "MERCHANT_ID_BLOCKED" "ATM_NOT_ALLOWED" "CONTACTLESS_NOT_ALLOWED" "ECOMMERCE_NOT_ALLOWED" "CASHBACK_NOT_ALLOWED" "CREDIT_AUTHORISATIONS_NOT_ALLOWED" "SPEND_LIMIT_EXCEEDED"
authorisationType
required
string

The type of authorisation that was processed.

Enum: "AUTHORISED" "DECLINED" "ONLINE_REVERSE" "EXPIRED" "MANUAL_CLOSE" "AUTHORISED_CREDIT" "CANCELLED"
relatedAuthorisationId
integer <int64>

The related authorisation id which this authorisation is performing further updates on.

required
object
cardholderPresent
string

Optional detail indicating if the card holder was present when the authorisation occurred.

Enum: "PRESENT" "NOT_PRESENT" "PRESENCE_UNKNOWN"
cardPresent
boolean

Optional detail indicating if the card was present when the authorisation occurred.

object (ManagedCardModeDetails)
authCode
string [ 1 .. 6 ] characters

The authorisation code associated with this authorisation.

Responses

Request samples

Content type
application/json
{
  • "id": {
    },
  • "transactionId": 0,
  • "transactionAmount": {
    },
  • "transactionTimestamp": 0,
  • "sourceAmount": {
    },
  • "merchantName": "string",
  • "merchantCategoryCode": "string",
  • "merchantId": "string",
  • "approved": true,
  • "availableBalance": {
    },
  • "declineReason": "PHYSICAL_NOT_ACTIVATED",
  • "authRuleFailedReason": "MERCHANT_CATEGORY_NOT_IN_ALLOWED_LIST",
  • "authorisationType": "AUTHORISED",
  • "relatedAuthorisationId": 0,
  • "owner": {
    },
  • "cardholderPresent": "PRESENT",
  • "cardPresent": true,
  • "details": {
    },
  • "authCode": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Card settlement

Notification that a card settlement has been processed on a managed card.

header Parameters
call-ref
string

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-timestamp
required
integer <int32>

The timestamp when this event was published

signature
required
string

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

Request Body schema: application/json
required
object

The id of the managed card on which a settlement has been performed.

transactionId
required
integer <int64>

The id of the transaction, for reference.

settlementType
required
string

The type of settlement that was processed.

Enum: "SALE_PURCHASE" "CASH_WITHDRAWAL" "SALE_WITH_CASHBACK" "MAIL_OR_TELEPHONE_ORDER" "PURCHASE_REFUND_REVERSAL" "ORIGINAL_CREDIT_TRANSACTION_REVERSAL" "CASH_WITHDRAWAL_REVERSAL" "PURCHASE_REFUND" "PURCHASE_REVERSAL" "ORIGINAL_CREDIT_TRANSACTION" "FIRST_CHARGEBACK" "FIRST_CHARGEBACK_REVERSAL" "FIRST_REPRESENTMENT" "FIRST_REPRESENTMENT_REVERSAL" "SECOND_CHARGEBACK" "SECOND_CHARGEBACK_REVERSAL" "SECOND_REPRESENTMENT" "ARBITRATION_CHARGEBACK" "BALANCE_INQUIRY"
required
object

A message representing a monetary amount in a particular currency.

transactionTimestamp
required
integer <int64>

The timestamp of the transaction, using epoch timestamp with millisecond precision.

required
object

A message representing a monetary amount in a particular currency.

merchantName
string

The name of the merchant where the authorisation has been made.

merchantCategoryCode
string

The merchant category code.

merchantId
string

The merchant ID.

object (ManagedCardModeDetails)
object
Deprecated

A message representing a monetary amount in a particular currency.

relatedAuthorisationId
integer <int64>

The related authorisation id which this settlement is clearing.

relatedSettlementId
integer <int64>

The related settlement id.

required
object
required
object

A message representing a monetary amount in a particular currency.

authCode
string [ 1 .. 6 ] characters

The authorisation code associated with this settlement.

state
required
string

The state of the settlement.

Enum: "PENDING" "COMPLETED"

Responses

Request samples

Content type
application/json
{
  • "id": {
    },
  • "transactionId": 0,
  • "settlementType": "SALE_PURCHASE",
  • "transactionAmount": {
    },
  • "transactionTimestamp": 0,
  • "sourceAmount": {
    },
  • "merchantName": "string",
  • "merchantCategoryCode": "string",
  • "merchantId": "string",
  • "details": {
    },
  • "availableBalance": {
    },
  • "relatedAuthorisationId": 0,
  • "relatedSettlementId": 0,
  • "owner": {
    },
  • "feeAmount": {
    },
  • "authCode": "string",
  • "state": "PENDING"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Card adjustment

Notification that a balance adjustment has been processed on a managed card.

header Parameters
call-ref
string

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-timestamp
required
integer <int32>

The timestamp when this event was published

signature
required
string

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

Request Body schema: application/json
required
object

The id of the managed card on which a settlement has been performed.

transactionId
required
integer <int64>

The id of the transaction, for reference.

adjustmentType
required
string

The type of adjustment that was processed.

Enum: "DEFAULT_ADJUSTMENT" "LOST_STOLEN_REPLACEMENT_BALANCE_TRANSFER"
required
object

A message representing a monetary amount in a particular currency.

transactionTimestamp
required
integer <int64>

The timestamp of the transaction, using epoch timestamp with millisecond precision.

object

A message representing a monetary amount in a particular currency.

required
object

Responses

Request samples

Content type
application/json
{
  • "id": {
    },
  • "transactionId": 0,
  • "adjustmentType": "DEFAULT_ADJUSTMENT",
  • "adjustmentAmount": {
    },
  • "transactionTimestamp": 0,
  • "availableBalance": {
    },
  • "owner": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Transfers

Transfer transaction

Notification that a Transfer transaction has been processed.

header Parameters
call-ref
string

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-timestamp
required
integer <int32>

The timestamp when this event was published

signature
required
string

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

Request Body schema: application/json
eventType
required
string
Enum: "PENDING" "COMPLETED" "FAILED"
required
object
publishedTimestamp
required
integer <int64>

Epoch timestamp using millisecond precision.

Responses

Request samples

Content type
application/json
{
  • "eventType": "PENDING",
  • "transfer": {
    },
  • "publishedTimestamp": 0
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Send

Send transaction

Notification that a Send transaction has been processed.

header Parameters
call-ref
string

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-timestamp
required
integer <int32>

The timestamp when this event was published

signature
required
string

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

Request Body schema: application/json
eventType
required
string
Enum: "PENDING" "COMPLETED" "FAILED"
required
object
publishedTimestamp
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "eventType": "PENDING",
  • "send": {
    },
  • "publishedTimestamp": 0
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Outgoing Wire Transfers

outgoing_wire_transfers_watch

header Parameters
call-ref
string

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-timestamp
required
integer <int32>

The timestamp when this event was published

signature
required
string

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

Request Body schema: application/json
required
object
publishedTimestamp
required
integer <int64>

Epoch timestamp using millisecond precision.

eventType
required
string
Enum: "PENDING_CHALLENGE" "SUBMITTED" "APPROVED" "REJECTED" "FAILED" "COMPLETED"

Responses

Request samples

Content type
application/json
{
  • "transfer": {
    },
  • "publishedTimestamp": 0,
  • "eventType": "PENDING_CHALLENGE"
}

Response samples

Content type
application/json
{
  • "message": "string"
}