Introduction

The Wixxir Seller API allows you to integrate secure Diginote payments directly into your website or application.

With Wixxir, you can offer both single payments and installment-based payments to your customers, while all payment processing is handled securely on the Wixxir platform.

This documentation will guide you through integrating Wixxir into your system, creating payment requests, and managing the complete checkout flow.

Overview

The Wixxir API enables sellers to seamlessly integrate Diginote-based payment solutions into their platforms.

Using the API, you can:

• Create payment requests
• Accept one-time (full) payments
• Offer installment payment options
• Automatically generate Diginotes
• Redirect customers to Wixxir’s secure checkout page

Wixxir handles all payment processing, security, and compliance, allowing you to focus on your business while providing a flexible payment experience to your customers.

Get API Key

To use the Wixxir Seller API, you must first obtain your API key.

Log in to your Wixxir Seller Dashboard. If you do not have an account, create one here.

After logging in, navigate to:

Dashboard → Wixxir Diginote API

In this section, you will find your:

• Secret API Key

Use this key in your backend requests to authenticate with the Wixxir API.

Important: Never expose your API key in frontend code. All API requests must be made from your server.

PHP / Laravel

PHP / Laravel integration guide.

Quick Start

Integrate Wixxir into your Laravel application in just a few steps and start accepting payments immediately.

Your customers will be able to select Pay with Wixxir at checkout and complete their payment securely on the Wixxir platform.

Follow the steps below to complete your integration.

Add API Key

Add your Wixxir API key to your environment configuration.

Open your .env file and add:

WIXXIR_API_KEY=your_api_key_here

Configure Wixxir

Configure Wixxir inside your Laravel application.

Open the following file:

config/services.php

Add the Wixxir configuration:

'wixxir' => [
    'api_key' => env('WIXXIR_API_KEY'),
    'endpoint' => 'https://wixxir.com/api/seller/payment/create'
],

Add Wixxir to Checkout Page

Add Wixxir as a payment option on your checkout page.

Example:

<form action="/pay-with-wixxir" method="POST">
        <button type="submit">
        Pay with Wixxir
    </button>
</form>

Add Route

Define a route to handle the Wixxir payment request.

Route::post('/pay-with-wixxir', [
    CheckoutController::class, 'payWithWixxir'
]);

Add Controller Logic

Send a payment request to Wixxir from your backend.

use Illuminate\Support\Facades\Http;

public function payWithWixxir()
{
    $response = Http::withHeaders([
        'X-API-KEY' => config('services.wixxir.api_key')
    ])->post(config('services.wixxir.endpoint'), [

        'order_id' => $orderId,
        'product_name' => $productName,
        'amount' => $amount,
        'currency' => $currency,
        'customer_email' => $customerEmail,
        'customer_name' => $customerName,
        'customer_phone' => $customerPhone,
        'return_url' => $successUrl,
        'cancel_url' => $cancelUrl

    ]);

    $checkoutUrl = $response->json()['checkout_url'];

    return redirect($checkoutUrl);
}

The values above should come from your existing order and customer system.

Customer Payment Flow

The payment process works as follows:

Customer selects product
↓
Customer goes to checkout
↓
Customer clicks "Pay with Wixxir"
↓
Your server sends payment request to Wixxir API
↓
Wixxir returns checkout URL
↓
Customer is redirected to Wixxir checkout
↓
Customer completes payment
↓
Customer is redirected back to your website

Authentication

All API requests must be authenticated using your Wixxir API key.

You must include your API key in the request headers:

X-API-KEY: your_api_key_here

This key identifies your account and ensures that the request is authorized.

Important: Never expose your API key in frontend code. Always send requests from your backend server.

Create Payment

Use this endpoint to create a new payment request.

Endpoint:

POST https://wixxir.com/api/seller/payment/create

Headers:

X-API-KEY: your_api_key_here

Request Type: JSON

Once the request is successful, Wixxir will return a checkout URL where your customer will be redirected to complete the payment.

Request Parameters

The following parameters must be sent in the request body:

Response Format

If the request is successful, Wixxir returns a checkout URL.

Success Response:

{
    "status": "success",
    "checkout_url": "https://wixxir.com/checkout/abc123"
}

Error Response:

{
    "status": "error",
    "message": "Invalid API key"
}

Redirect your customer to the checkout_url to complete the payment.

Return URL

After a successful payment, the customer will be redirected to your specified return URL.

This URL is defined in your API request using the return_url parameter.

You can use this page to display a success message, order confirmation, or any post-payment information.

Example:

https://yourwebsite.com/payment-success

Important: You should verify the payment status on your backend before marking an order as completed.

Cancel URL

If the customer cancels the payment or exits the checkout process, they will be redirected to your cancel URL.

This URL is defined in your API request using the cancel_url parameter.

You can use this page to:

• Allow the customer to retry the payment
• Show a cancellation message
• Redirect back to the checkout page

Example:

https://yourwebsite.com/payment-cancel

Security

Never expose your API key in frontend JavaScript.

All Wixxir API requests must be sent from your backend server.

That's It

After completing these steps, Wixxir will immediately work as a payment method on your website.

No additional setup is required.

Support

For integration support contact:

support@wixxir.com