Gateway API (0.23.0)

Overview

Konnect provides an easy payment experience for your customers and easy integration process for the developers. Payment process works by creating Payment Request and then the customers accepting the Payment Request.

  1. Create payment request URLs, each request has a unique Payment Reference.
  2. Your customers have the choice to specify their payment methods.
  3. You receive the payment confirmation with a unique Payment ID.

Setup

  1. Create a Konnect account https://preprod.konnect.network/admin
  2. Create an organisation
  3. Copy the wallet key from the organisation dashboard
  4. generate an api key from organisation dashboard
  5. Use your wallet & api key to initiate and receive payments


Note

You can test all our API endpoints in our Sandbox environment, by signing up on our Sandbox Platform.

which will mock your transactions to perform end-to-end testing of your Integration flow.

The base URL for production environment will be https: //api.konnect.network/api/v2/

The base URL for Sandbox environment will be https: //api.preprod.konnect.network/api/v2/

Payments

Init payment

This endpoint creates a new payment request.

header Parameters
x-api-key
required
string
Example: 6137ad140c181c5eb44a7f88:Rp2dpHPb0mBpj3_51s86zzp3PXs5w1

An API key is a unique identifier for each organisation used to perform API calls to Konnect API.

Request Body schema: application/json
receiverWalletId
required
string
amount
required
number
type
string
lifespan
number

Duration before the payment expires. In minutes

token
string
Enum: "TND" "EUR"
firstName
string
lastName
string
phoneNumber
string
email
string
orderId
string
link
string

payment link

webhook
string

Webhook is the way in which konnect can send automated information or let's say request to notify client bankend server that payment was processed.
Note: 1- in case of including a webhook, successUrl/failUrl won't be executed, only webhook will be called.
2- payment ref is included in webhook query so payment status can be tracked though GET /payments/:paymentId

successUrl
string

url were user will be redirected after successful payment.
note : payment ref is included in webhook query.

failUrl
string

url were user will be redirected after failed payment.
note : payment ref is included in webhook query.

acceptedPaymentMethods
Array of strings
Default: ["bank_card","wallet","e-DINAR"]
Items Enum: "MCOIN" "bank_card" "wallet" "e-DINAR" "wire_transfer"

accepted payment method

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Get Payment details

path Parameters
paymentId
string
Example: 5e68ed190a43a43998c6eeba

Payment's id

Responses

Response samples

Content type
application/json
{
  • "payment": {
    }
}

Webhook

Webhook is your URL to which Konnect will send the payment details as a GET request.

Parameter Description
payment_ref Payment ID

For example:

https: //www.monsite.tn/module/konnect/webhook?cart_id=6670&payment_ref=5f9498735289e405fc7c18ac

Prestashop

Konnect is also available as a module for Prestashop websites.

Please contact us to get access to it. Send us an email at:

support@konnect.network

Wordpress

Konnect is also available as a module for Woocommerce websites.

Please contact us to get access to it. Send us an email at:

support@konnect.network

API Key

An API key is a unique identifier for each organisation used to perform API calls to Konnect API.

The API Key can be generated from the organisation profile in the Dashboard.

It has a specific format as follows: organisationId:uniqueKey

example '6137ad140c181c5eb44a7f88:Rp2dpHPb0mBpj3_51s86zzp3PXs5w1'