Introduction
This section describes the WIXXIR payment gateway API.
WIXXIR API is easy to implement in your business software. Our API is well formatted URLs, accepts cURL requests, returns JSON responses.
You can use the API in test mode, which does not affect your live data. The API key is use to authenticate the request and determines the request is valid payment or not. For test mode just use the sandbox URL and In case of live mode use the live URL from section Initiate Payment .
Supported Currencies
This section describes the currencies supported by WIXXIR
WIXXIR allows to make transaction with below currencies. Any new currency may update in future.
| Currency Name | Currency Symbol | Currency Code |
|---|---|---|
| United States Dollar | $ | USD |
| Avrupa | € | EUR |
| İngiltere | £ | GBP |
| Türkiye | ₺ | TRY |
| Bitcoin | BTC | BTC |
Get API Key
This section describes how you can get your API key.
Login to your WIXXIR seller account. If you do not have an account, click here.
After logging in, go to your dashboard sidebar and find the Wixxir Diginote API section.
Inside this section, you will find your Secret Key (API Key).
Use the copy button to easily copy your key and use it in your API requests.
Keep your Secret Key secure and do not share it with anyone.
Initiate Payment
This section describes the process of initaiing the payment.
To initiate the payment follow the example code and be careful with the perameters. You will need to make request with these following API end points.
Live End Point: https://wixxir.com/payment/initiate
Test End Point: https://wixxir.com/sandbox/payment/initiate
Test Mode Mail: test_mode@mail.com
Test Mode Verification Code: 222666
Request Method: POST
Request to the end point with the following parameters below.
| Param Name | Param Type | Description |
|---|---|---|
| public_key | string (50) | Required Your Public API key |
| identifier | string (20) | Required Identifier is basically for identify payment at your end |
| currency | string (4) | Required Currency Code, Must be in Upper Case. e.g. USD,EUR |
| amount | decimal | Required Payment amount. |
| details | string (100) | Required Details of your payment or transaction. |
| ipn_url | string | Required The url of instant payment notification. |
| success_url | string | Required Payment success redirect url. |
| cancel_url | string | Required Payment cancel redirect url. |
| site_logo | string/url | Required Your business site logo. |
| checkout_theme | string | Optional Checkout form theme dark/light. Default theme is light |
| customer_name | string (30) | Required Customer name. |
| customer_email | string (30) | Required Customer valid email. |
Validate The Payment and IPN
This section describes the process to get your instant payment notification.
To initiate the payment follow the example code and be careful with the perameters. You will need to make request with these following API end points.
End Point: Your business application ipn url.
Request Method: POST
You will get following parameters below.
| Param Name | Description |
|---|---|
| status | Payment success status. |
| identifier | Identifier is basically for identify payment at your end. |
| signature | A hash signature to verify your payment at your end. |
| data | Data contains some basic information with charges, amount, currency, payment transaction id etc. |