DocumentationSwaggerUser docsSystem status
PluginsPayments

Webhook payment

Create a custom payment provider

Overview

If Omnium does not provide the integration needed, you can use a Webhook payment provider. Following features is supported

  • Capture
  • Refunds
  • Authorization
  • Cancellation/Void

Configuration Steps

  1. Navigate to: Configuration > Settings > Orders > Payment > Payment Types > Add New > WebhookPayment

Required Settings

FieldValue
Payment Setting NameCustomizable
Payment Method NameCustomizable
Provider NameWebhookPayment
Display NameCustomizable
Base URLYour webhook base url. The base url(or transactions url's) should contain a guide or be ip restriced.

Properties for transaction url's

Webhook payment needs some properties in the property list, to be able to do capture, credit etc. Add the following:

KeyValue
CaptureUrlYour endpoint for Capture
CreditUrlYour endpoint for Credit
VoidUrlYour endpoint for Cancellation/Void
AuthorizationUrlOptional endpoint if the webhook provier should support adding payment from Omnium GUI

Omnium will call this endpoints with the following request model:

{
"OrderNumber": "105388",
"Amount": 400,
"CurrencyCode": "NOK",
"TransactionId": "105388",
"PaymentMethodName": "WebhookPayment",
"MarketId": "NOR",
"CustomerNumber": "3453234234234"
}

If payment is success, we expect to get statuscode 200 returned from the webhook. If not, we will read the content as an error message.

Previous

Walley

Next

Zaver

On this page