lamine-minato/orange-money-gateway

A PHP package to manage payments via Orange Money in your PHP applications.

1.0.1 2024-11-10 02:07 UTC

Requires

• php: ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0
• symfony/http-client: ^7.0
• symfony/property-access: ^7.0

Requires (Dev)

• symfony/var-dumper: ^7.0

MIT

• Lamine Diarra

• api
• payment
• Orange Money

README

A PHP package to manage payments via Orange Money in your PHP applications.

How it work ?

• Use following command to install:

composer require lamine-minato/orange-money-gateway

• Create an OrangeMoneyAction object:

$action = new OrangeMoneyAction(
    orangeBearer: "bearer",
    merchantKey: "merchantKey",
    currency: OrangeMoneyCurrency::XOF,
    amount: 10000,
    returnUrl: "https://api.example.com/return",
    cancelUrl: "https://api.example.com/cancel",
    notifUrl: "https://api.example.com/notif",
    lang: "fr",
    reference: "Minato"
);

Make sure to replace variable by the corrects one

• Call execute method on OrangeMoneyGateway class:

$response = OrangeMoneyGateway::execute($action);

and Voila!

It will return a OrangeMoneyPaymentResponse object containing payToken and paymentUrl

In case of error, it will throw an exception of type OrangeMoneyException

You can also pass a configuration to the execute method of OrangeMoneyGateway if you want to modify the urls for retrieving the payment url

$action = new OrangeMoneyAction(...);

$config = new OrangeMoneyConfig(
    tokenUrl: "https://api.orange.com/oauth/v3/token",
    proccessUrl: "https://api.orange.com/orange-money-webpay/ml/v1/webpayment",
)

$response = OrangeMoneyGateway::execute($action, $config);

License

The MIT License (MIT). Please see License for more information.

Contributing

Read here for more information.