Weavr
Powered by Redocly

Payment runs

Notification that the Payment Run and payment statuses have been updated.

Payment Run UpdateWebhook

Notification that the status of a Payment Run has been updated.

Request
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 <int64>

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

signature
required
string

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

signature-v2
required
string

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the call-ref header, the request body, and the published-timestamp header, all concatenated without spaces, and signed using your API key.

Request Body schema: application/json
required

Payment run event triggered when the status changes

type
string
Value: "paymentRunWatch"
object (PaymentRun)
Responses
200

Return a 200 status to indicate that the data was received successfully

Request samples
application/json
{
  • "type": "paymentRunWatch",
  • "payload": {
    }
}

Payment UpdateWebhook

Notification that the status of a payment in the Payment Run has been updated.

Request
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 <int64>

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

signature
required
string

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

signature-v2
required
string

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the call-ref header, the request body, and the published-timestamp header, all concatenated without spaces, and signed using your API key.

Request Body schema: application/json
required

Event triggered when the status of a payment run payment changes

type
string
Value: "paymentRunPaymentWatch"
object (Payment)
Responses
200

Return a 200 status to indicate that the data was received successfully

Request samples
application/json
{
  • "type": "paymentRunPaymentWatch",
  • "payload": {
    }
}
➔ Next to Linked Accounts