Download the PHP package simpaypl/laravel without Composer

SimPay Laravel package

(c) 2025 Payments Solution Sp. z o.o.

Installation:

Installation via Composer:

Optionally you can publish config file:

You should put these parameters in your .env file:

Base usage

SimPay plugin is accessible through two methods:

1. Facade - to use facade you should do:

2. Using app() helper:

Important information

Our library does not create any routes for you - you have to manually register routes for IPN handling. With this library you can create transactions, get transaction information and validate IPN signature.

Exceptions

Every exception in our library is extended from

• When response from our API is 401 or 403, \SimPay\Laravel\Exceptions\AuthorizationException is thrown;
• When response from our API is 404, \SimPay\Laravel\Exceptions\ResourceNotFoundException is thrown (this will be also thrown, when SMS code does not exists);
• When response from our API is 422, \SimPay\Laravel\Exceptions\ValidationFailedException is thrown (you can get errors by using $exception->errors().

Payments

Generate payment

Response will be SimPay\Laravel\Responses\TransactionGeneratedResponse. You can get url and transactionId using these public parameters:

• url
• transactionId

Get transaction info

Response will be SimPay\Laravel\Responses\Payment\TransactionInfoResponse. Public parameters:

• id (string)
• status (See below)
• amount (See below)
• channel (null or string)
• control (null or string)
• description (null or string)
• redirects (See below)
• customer (See below)
• billing (See below)
• shipping (See below)
• cart (See below)
• additional (array or null)
• paidAt (Carbon instance or null)
• expiresAt (Carbon instance or null)
• createdAt (Carbon instance)
• updatedAt (Carbon instance)

status is an enum located in SimPay\Laravel\Enums\Payment\TransactionStatus.

Enum cases:

• New
• Generated
• Confirmed
• Paid
• Failure
• Expired
• Refunded

amount is an instance of SimPay\Laravel\Responses\Payment\TransactionInfo\AmountResponse. Public parameters:

• value (float)
• currency (string)
• commission (float or null)

redirects is an instance of SimPay\Laravel\Responses\Payment\TransactionInfo\RedirectsResponse. Public parameters (string or null):

• success
• failure

customer is an instance of SimPay\Laravel\Responses\Payment\TransactionInfo\CustomerResponse. Public parameters (string or null):

• name
• email
• ip

billing and shipping are instances of SimPay\Laravel\Responses\Payment\TransactionInfo\CustomerFullDataResponse. Public parameters (string or null):

• name
• surname
• street
• building
• flat
• city
• region
• postalCode
• country
• company

cart is an array of SimPay\Laravel\Responses\Payment\TransactionInfo\CartItemResponse. Public parameters of single cart item:

• name (string)
• quantity (int)
• price (float)
• producer (string or null)
• category (string or null)
• code (string or null)

Get payment channels

Response is an array of SimPay\Laravel\Responses\Payment\ServiceChannel\ChannelResponse. Public parameters:

• id (string)
• name (string)
• type (string)
• img (string)
• commission (float or null)
• currencies (array)
• amount (see below)

amount is an instance of SimPay\Laravel\Responses\Payment\ServiceChannel\ChannelAmountResponse. Public parameters (float):

• min
• max

Signature validator

Response is boolean. True means signature is valid. False - invalid.

Direct Billing

Generate transaction

amountType() accepts an Enum SimPay\Laravel\Enums\DirectBilling. Enum cases:

• Required
• Net
• Gross (default)

Response will be SimPay\Laravel\Responses\TransactionGeneratedResponse. You can get url and transactionId using these public parameters:

• url
• transactionId

Get transaction info

Response will be an instance of SimPay\Laravel\Responses\DirectBilling\TransactionInfoResponse. Public parameters:

• id (string)
• status (see below)
• phoneNumber (string or null)
• control (string or null)
• value (float)
• valueNet (float)
• valueCreated (float)
• valueCreatedType (see below)
• carrier (see below)
• notify (see below)
• score (float or null)
• createdAt (Carbon instance or null)
• updatedAt (Carbon instance or null)

status is an Enum located in SimPay\Laravel\Enums\DirectBilling\TransactionStatus. Enum cases:

• New
• Confirmed
• Paid
• Rejected
• Cancelled
• GenerateError

valueCreatedType is an Enum located in SimPay\Laravel\Enums\DirectBilling\AmountType. Enum cases:

• Required
• Net
• Gross

carrier is null or an Enum located in SimPay\Laravel\Enums\DirectBilling\MobileCarrier. Enum cases:

• Orange
• Play
• TMobile
• Plus
• Netia

notify is an instance of SimPay\Laravel\Responses\DirectBilling\TransactionInfo\NotifyResponse. Public parameters:

• isSend (bool)
• lastSendAt (Carbon instance or null)
• count (int)

Calculate amount

Response is an instance of SimPay\Laravel\Responses\DirectBilling\AmountCalculatorResponse. Public parameters:

• orange
• play
• tMobile
• plus
• netia

Every parameter is an instance of SimPay\Laravel\Responses\DirectBilling\AmountCalculator\AmountResponse. Public parameters:

• net (float or null)
• gross (float or null)

Signature validator

Response is boolean. True means signature is valid. False - invalid.

SMS

Get service numbers

Response is an array of SimPay\Laravel\Responses\Sms\SmsNumberResponse. Public parameters of SmsNumberResponse:

• number (int)
• value (float)
• valueGross (float)
• adult (bool)

Check code

Response is an instance of SimPay\Laravel\Responses\Sms\SmsCodeResponse. Public parameters:

• used (bool)
• code (string)
• test (bool)
• from (string)
• number (int)
• value (float)
• usedAt (Carbon instance or null)