sylapi/omnipay-inbank

InBank gateway for Omnipay payment processing library

Maintainers

Details

github.com/sylapi/omnipay-inbank

Source

Issues

Installs: 3 249

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 2

v1.1.0 2023-06-27 12:06 UTC

Requires

Requires (Dev)

MIT 684774d7ff5d43b289669d3cab010f159a1baebd

This package is not auto-updated.

Last update: 2025-04-01 20:00:06 UTC

README

PHPStan Build codecov.io

Init

$gateway = Omnipay::create('InBank');
$gateway->setApiKey('--APIKEY--');
$gateway->setShopUidd('--SHOPUIDD--');
$gateway->setTestMode(true);
$gateway->setApiUrlSandbox('https://demo-api.inbank.cz'); /* Optional (default: https://demo-api.inbank.pl) */
$gateway->setApiUrlProduction('https://api.inbank.cz'); /* Optional (default: https://api.inbank.pl) */

Ping

try {
    $response = $gateway->ping()->send();
    if($response->isSuccessful())
    {
        var_dump($response->getData());
    } 
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Purchase

try {
    $response = $gateway->purchase([
        'creditApplication' => [
            "product_code" => "hirepurchase_epos_0.0%_e57c6ec8018d",
            "amount" =>  "2000.0",
            "period" => 12,
            "payment_day" => 4,
            "monthly_income" => "4222.11",
            "dependants_count" => "0",
            "monthly_household_costs" => "0.0",
            "income_source" => "pension",
            "payout_account_number" =>  "PL92962000058311149653553838"
        ],
        "customer" => [
            "identity_code" => "50110502242",
            "first_name" => "Example",
            "last_name" => "Customer"
        ],
        "customerAddresses" => [
            [
                "type" => "legal",
                "country" => "PL",
                "street" => "Fabryczna",
                "house" => "5A",
                "apartment" => "101",
                "zip_code" => "00-100"
            ]
        ],
        "customerContact" => [
            "mobile" => "+48500600700",
            "email" => "test@email.dev"
        ],
        "customerIdentification" => [
            "document_type" => "id_card",
            "document_number" => "XLP255805",
            "document_valid_to" => "2021-08-26"
        ],
        "customerConsents" => [
            "operational_contact_email" => true,
            "inbank_queries_after_contract_expiry" => false,
            "marketing_email" => false,
            "marketing_sms" => false,
            "marketing_phone" => false
        ]
    ])->send();
    if($response->isSuccessful())
    {
        var_dump($response->getData());
        var_dump($response->getTransactionId());
    } 
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Purchase Signing

try {
    $response = $gateway->purchaseSigning([
            'applicationUuid' => '11111111-1111-1111-1111-111111111111',
            'signingMethod' => \Omnipay\InBank\Enums\SigningMethod::DIGITAL
        ])->send();

    if($response->isSuccessful())
    {
        var_dump($response->getData());
    } 
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Fetch Transaction

try {
    $response = $gateway->fetchTransaction([ 
            'applicationUuid' => '11111111-1111-1111-1111-111111111111'
        ])->send();

    if($response->isSuccessful())
    {
        var_dump($response->getData());
        var_dump($response->getPaymentSchedule());
    } 
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Accept Purchase

try {
    $response = $gateway->acceptPurchase([
            'applicationUuid' => '11111111-1111-1111-1111-111111111111'
        ])->send();

    if($response->isSuccessful())
    {
        var_dump($response->getData());
        var_dump($response->getContractUuid());
    } 
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Cancel Purchase

try {
    $response = $gateway->cancelPurchase([
            'applicationUuid' => '11111111-1111-1111-1111-111111111111'
        ])->send();

    if($response->isSuccessful())
    {
        var_dump($response->getData());
    } 
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Contract Printout

try {
    $response = $gateway->contractPrintout([
            'contractUuid' => '11111111-1111-1111-1111-111111111111',
            'forceRegeneration' => true
        ])->send();

    if($response->isSuccessful())
    {
        var_dump($response->getData());
        var_dump($response->getUuid());
        var_dump($response->getLink());
    } 
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Fetch Contract

try {
    $response = $gateway->fetchContract([
            'contractUuid' => '11111111-1111-1111-1111-111111111111'
        ])->send();

    if($response->isSuccessful())
    {
        var_dump($response->getData());
        var_dump($response->getTransactionId());
        var_dump($response->getContractUuid());
    } 
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Printout

try {
    $response = $gateway->printout([
            'applicationUuid' => '11111111-1111-1111-1111-111111111111',
            'printoutType' => \Omnipay\InBank\Enums\PrintoutType::APPLICATION,
            'forceRegeneration' => true
        ])->send();

    if($response->isSuccessful())
    {
        var_dump($response->getData());
        var_dump($response->getUuid());
        var_dump($response->getLink());
    } 
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Init Contract Signing

try {
    $response = $gateway->initContractSigning([
            'contractUuid' => '11111111-1111-1111-1111-111111111111',
            'signingMethod' => \Omnipay\InBank\Enums\SigningMethod::SMS
        ])->send();

    if($response->isSuccessful())
    {
        var_dump($response->getData());
    } 
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Contract Signing

try {
    $response = $gateway->contractSigning([
            'contractUuid' => '11111111-1111-1111-1111-111111111111',
            'confirmationCode' => '561085',
            'signingMethod' => \Omnipay\InBank\Enums\SigningMethod::SMS
        ])->send();

    if($response->isSuccessful())
    {
        var_dump($response->getData());
    } 
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Contract Cancel

try {
    $response = $gateway->contractCancel([
        'contractUuid' => '11111111-1111-1111-1111-111111111111'
    ])->send();

    if(!$response->isSuccessful())
    {
        var_dump($response->getMessage());
    }
    
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Verification Application

try {
    $response = $gateway->applicationVerification([
            'applicationUuid' => '11111111-1111-1111-1111-111111111111',
            'uuid' => '11111111-1111-1111-1111-111111111111',
            'verificationMethod' => \Omnipay\InBank\Enums\VerificationMethod::BLUE_MEDIA,
            'returnUrl' => 'http://test.shop.dev/returnUrl.php'
        ])->send();

    if($response->isSuccessful())
    {
        var_dump($response->getData());
        if($response->isRedirect()) {
            var_dump($response->getRedirectUrl());
            $response->redirect();
        }
    } 
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Verification Application Status

try {
    $response = $gateway->applicationVerificationStatus([
            'applicationUuid' => '11111111-1111-1111-1111-111111111111',
            'verificationMethod' => \Omnipay\InBank\Enums\VerificationMethod::BLUE_MEDIA
        ])->send();

    if($response->isSuccessful())
    {
        var_dump($response->getData());
        var_dump($response->getVerificationStatus());
    } 
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Contract Merchant Approval

try {
    $response = $gateway->contractMerchantApproval([
            'contractUuid' => '11111111-1111-1111-1111-111111111111'
        ])->send();

    if(!$response->isSuccessful())
    {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Calculations

try {
    $response = $gateway->calculations([ 
        'productCode' => 'hirepurchase_epos_0.8%_11111111',
        'amount' => 7000,
        'period' => 12,
        'downPaymentAmount' => 1500,
        'paymentDay' => 4,
        'responseLevel' => \Omnipay\InBank\Enums\ResponeLevel::SIMPLE,
    ])->send();

    if($response->isSuccessful())
    {
        var_dump($response->getData());
    } 
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Product Details

try {
    $response = $gateway->productDetails([
        'productCode' => 'hirepurchase_epos_0.0%_11111111'
    ])->send();

    if($response->isSuccessful())
    {
        var_dump($response->getData());
    } 
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Fetch Customer

try {
    $response = $gateway->fetchCustomer([
            'applicationUuid' => '11111111-1111-1111-1111-111111111111'
        ])->send();
    if($response->isSuccessful())
    {
        var_dump($response->getData());
        var_dump($response->getPaymentSchedule());
    } 
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Get Payment Schedule of Credit Application

try {
    $response = $gateway->paymentSchedule([
        'applicationUuid' => '11111111-1111-1111-1111-111111111111',
        'responseLevel' => \Omnipay\InBank\Enums\PaymentSchedulesResponeLevel::FULL
    ])->send();
    if($response->isSuccessful())
    {
        var_dump($response->getData());
        var_dump($response->getTransactionId());
        var_dump($response->getApplicationUuid());
    }
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Recalculate Payment Schedule

try {
    $response = $gateway->recalculatePaymentSchedule([
        'applicationUuid' => '11111111-1111-1111-1111-111111111111',
        'downPaymentAmount' => 1000
    ])->send();
    if($response->isSuccessful())
    {
        var_dump($response->getData());
        var_dump($response->getTransactionId());
        var_dump($response->getApplicationUuid());
    }
    else {
        var_dump($response->getMessage());
    }
} catch (\Exception $e) {
    var_dump($e->getMessage());
}

Commands

COMMAND DESCRIPTION
composer tests Tests
composer phpstan PHPStan