Skip to main content
API docs by Redocly

Webhooks API

E-mail: developer@vippsmobilepay.com


MobilePay Webhooks API makes it easy for you to register to webhooks.

Currently supported events about payments (those that start with payment.*) are only about payments from "App payments" product.

Event transfer.succeeded is generic and supports all products.

fetch all webhooks

Authorizations:
apiKeyopenId

Responses

Response samples

Content type
application/json
{
  • "webhooks": [
    ]
}

create webhook

Authorizations:
apiKeyopenId
Request Body schema: application/json
events
required
Array of strings
Items Enum: "payment.reserved" "payment.expired" "paymentpoint.activated" "payment.cancelled_by_user" "transfer.succeeded"

List of subscribed events.

url
required
string <url>

URL to where webhook requests will be sent. Must be HTTPS. Scheme and host will be converted to lower case. Result can be seen in the response.

paymentPointId
string or null <uuid>

Optional. Webhook will receive notifications only coming from specified payment point.

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "events": [
    ],
  • "paymentPointId": "f29aded7-4abb-4e8e-a778-5cb45a5dd4cb"
}

Response samples

Content type
application/json
{
  • "webhookId": "e4a2e195-74f6-42e1-a172-83291c9d2a41",
  • "url": "https://www.my-site.com/webhooks",
  • "events": [
    ],
  • "signatureKey": "my-secure-signature-key",
  • "paymentPointId": "bc2d4b85-3b0a-4aa4-b568-12a186a862b5"
}

update webhook

Authorizations:
apiKeyopenId
path Parameters
webhookid
required
string <uuid>
Request Body schema: application/json
events
required
Array of strings
Items Enum: "payment.reserved" "payment.expired" "paymentpoint.activated" "payment.cancelled_by_user" "transfer.succeeded"

List of subscribed events.

url
required
string <url>

URL to where webhook requests will be sent. Must be HTTPS. Scheme and host will be converted to lower case. Result can be seen in the response.

paymentPointId
string or null <uuid>

Optional. Webhook will receive notifications only coming from specified payment point.

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "events": [
    ],
  • "paymentPointId": "f29aded7-4abb-4e8e-a778-5cb45a5dd4cb"
}

Response samples

Content type
application/json
{
  • "webhookId": "e4a2e195-74f6-42e1-a172-83291c9d2a41",
  • "url": "https://www.my-site.com/webhooks",
  • "events": [
    ],
  • "signatureKey": "my-secure-signature-key",
  • "paymentPointId": "bc2d4b85-3b0a-4aa4-b568-12a186a862b5"
}

fetch single webhook

Authorizations:
apiKeyopenId
path Parameters
webhookid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "webhookId": "e4a2e195-74f6-42e1-a172-83291c9d2a41",
  • "url": "https://www.my-site.com/webhooks",
  • "events": [
    ],
  • "signatureKey": "my-secure-signature-key",
  • "paymentPointId": "bc2d4b85-3b0a-4aa4-b568-12a186a862b5"
}

delete webhook

Authorizations:
apiKeyopenId
path Parameters
webhookid
required
string <uuid>

Responses

publish test notification to a specified webhook

Authorizations:
apiKeyopenId
path Parameters
webhookid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "code": "1234",
  • "message": "Error message explaining the error that happened while processing the request",
  • "correlationId": "91f2b05f-2171-4cea-9d5a-1cdbed6ae2cd",
  • "origin": "WBH"
}