lomi/sdk

Payment processing API for francophone West African businesses.

For more information, please visit https://lomi.africa.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/lomi/lomi-sdk.git"
    }
  ],
  "require": {
    "lomi/lomi-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/lomi/sdk/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: ApiKeyAuth
$config = LomiSDK\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LomiSDK\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');


$apiInstance = new LomiSDK\Api\BeneficiaryPayoutsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$beneficiary_payouts_create = {"name":"Sample beneficiary_payout","description":"Example beneficiary_payout object"}; // \LomiSDK\Model\BeneficiaryPayoutsCreate

try {
    $result = $apiInstance->createBeneficiaryPayout($beneficiary_payouts_create);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BeneficiaryPayoutsApi->createBeneficiaryPayout: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.lomi.africa

Class	Method	HTTP request	Description
BeneficiaryPayoutsApi	createBeneficiaryPayout	POST /beneficiary_payouts	Create beneficiary payout
BeneficiaryPayoutsApi	listBeneficiaryPayouts	GET /beneficiary_payouts	List beneficiary payouts
BeneficiaryPayoutsApi	retrieveBeneficiaryPayout	GET /beneficiary_payouts/{payout_id}	Retrieve beneficiary payout
CheckoutSessionsApi	createCheckoutSession	POST /checkout_sessions	Create checkout session
CheckoutSessionsApi	deleteCheckoutSession	DELETE /checkout_sessions/{session_id}	Delete checkout session
CheckoutSessionsApi	listCheckoutSessions	GET /checkout_sessions	List checkout sessions
CheckoutSessionsApi	retrieveCheckoutSession	GET /checkout_sessions/{session_id}	Retrieve checkout session
CheckoutSessionsApi	updateCheckoutSession	PATCH /checkout_sessions/{session_id}	Update checkout session
CustomerInvoicesApi	listCustomerInvoices	GET /customer_invoices	List customer invoices
CustomerInvoicesApi	retrieveCustomerInvoice	GET /customer_invoices/{invoice_id}	Retrieve customer invoice
CustomersApi	createCustomer	POST /customers	Create customer
CustomersApi	deleteCustomer	DELETE /customers/{customer_id}	Delete customer
CustomersApi	listCustomers	GET /customers	List customers
CustomersApi	retrieveCustomer	GET /customers/{customer_id}	Retrieve customer
CustomersApi	updateCustomer	PATCH /customers/{customer_id}	Update customer
DiscountCouponsApi	createDiscountCoupon	POST /discount_coupons	Create discount coupon
DiscountCouponsApi	deleteDiscountCoupon	DELETE /discount_coupons/{coupon_id}	Delete discount coupon
DiscountCouponsApi	listDiscountCoupons	GET /discount_coupons	List discount coupons
DiscountCouponsApi	retrieveDiscountCoupon	GET /discount_coupons/{coupon_id}	Retrieve discount coupon
DiscountCouponsApi	updateDiscountCoupon	PATCH /discount_coupons/{coupon_id}	Update discount coupon
EventsApi	listEvents	GET /events	List events
EventsApi	retrieveEvent	GET /events/{event_id}	Retrieve event
InstalmentPaymentsApi	listInstalmentPayments	GET /instalment_payments	List instalment payments
InstalmentPaymentsApi	retrieveInstalmentPayment	GET /instalment_payments/{payment_id}	Retrieve instalment payment
MeterBalancesApi	listMeterBalances	GET /meter_balances	List meter balances
MeterBalancesApi	retrieveMeterBalance	GET /meter_balances/{balance_id}	Retrieve meter balance
MetersApi	createMeter	POST /meters	Create meter
MetersApi	deleteMeter	DELETE /meters/{meter_id}	Delete meter
MetersApi	listMeters	GET /meters	List meters
MetersApi	retrieveMeter	GET /meters/{meter_id}	Retrieve meter
MetersApi	updateMeter	PATCH /meters/{meter_id}	Update meter
PaymentLinksApi	createPaymentLink	POST /payment_links	Create payment link
PaymentLinksApi	deletePaymentLink	DELETE /payment_links/{link_id}	Delete payment link
PaymentLinksApi	listPaymentLinks	GET /payment_links	List payment links
PaymentLinksApi	retrievePaymentLink	GET /payment_links/{link_id}	Retrieve payment link
PaymentLinksApi	updatePaymentLink	PATCH /payment_links/{link_id}	Update payment link
PaymentRequestsApi	createPaymentRequest	POST /payment_requests	Create payment request
PaymentRequestsApi	deletePaymentRequest	DELETE /payment_requests/{request_id}	Delete payment request
PaymentRequestsApi	listPaymentRequests	GET /payment_requests	List payment requests
PaymentRequestsApi	retrievePaymentRequest	GET /payment_requests/{request_id}	Retrieve payment request
PaymentRequestsApi	updatePaymentRequest	PATCH /payment_requests/{request_id}	Update payment request
PayoutMethodsApi	listPayoutMethods	GET /payout_methods	List payout methods
PayoutMethodsApi	retrievePayoutMethod	GET /payout_methods/{payout_method_id}	Retrieve payout method
PayoutsApi	createPayout	POST /payouts	Create payout
PayoutsApi	deletePayout	DELETE /payouts/{payout_id}	Delete payout
PayoutsApi	listPayouts	GET /payouts	List payouts
PayoutsApi	retrievePayout	GET /payouts/{payout_id}	Retrieve payout
PayoutsApi	updatePayout	PATCH /payouts/{payout_id}	Update payout
PricesApi	createPrice	POST /prices	Create price
PricesApi	deletePrice	DELETE /prices/{price_id}	Delete price
PricesApi	listPrices	GET /prices	List prices
PricesApi	retrievePrice	GET /prices/{price_id}	Retrieve price
PricesApi	updatePrice	PATCH /prices/{price_id}	Update price
ProductsApi	createProduct	POST /products	Create product
ProductsApi	deleteProduct	DELETE /products/{product_id}	Delete product
ProductsApi	listProducts	GET /products	List products
ProductsApi	retrieveProduct	GET /products/{product_id}	Retrieve product
ProductsApi	updateProduct	PATCH /products/{product_id}	Update product
RefundsApi	createRefund	POST /refunds	Create refund
RefundsApi	deleteRefund	DELETE /refunds/{refund_id}	Delete refund
RefundsApi	listRefunds	GET /refunds	List refunds
RefundsApi	retrieveRefund	GET /refunds/{refund_id}	Retrieve refund
RefundsApi	updateRefund	PATCH /refunds/{refund_id}	Update refund
SPIAccountAliasesApi	listSpiAccountAliases	GET /spi_account_aliases	List spi account aliases
SPIAccountAliasesApi	retrieveSpiAccountAliase	GET /spi_account_aliases/{alias_id}	Retrieve spi account aliase
SPIQRCodesApi	createSpiQrCode	POST /spi_qr_codes	Create spi qr code
SPIQRCodesApi	deleteSpiQrCode	DELETE /spi_qr_codes/{qr_code_id}	Delete spi qr code
SPIQRCodesApi	listSpiQrCodes	GET /spi_qr_codes	List spi qr codes
SPIQRCodesApi	retrieveSpiQrCode	GET /spi_qr_codes/{qr_code_id}	Retrieve spi qr code
SPIQRCodesApi	updateSpiQrCode	PATCH /spi_qr_codes/{qr_code_id}	Update spi qr code
SubscriptionsApi	createSubscription	POST /subscriptions	Create subscription
SubscriptionsApi	deleteSubscription	DELETE /subscriptions/{subscription_id}	Delete subscription
SubscriptionsApi	listSubscriptions	GET /subscriptions	List subscriptions
SubscriptionsApi	retrieveSubscription	GET /subscriptions/{subscription_id}	Retrieve subscription
SubscriptionsApi	updateSubscription	PATCH /subscriptions/{subscription_id}	Update subscription
TransactionsApi	listTransactions	GET /transactions	List transactions
TransactionsApi	retrieveTransaction	GET /transactions/{transaction_id}	Retrieve transaction
WebhookDeliveryLogsApi	listWebhookDeliveryLogs	GET /webhook_delivery_logs	List webhook delivery logs
WebhookDeliveryLogsApi	retrieveWebhookDeliveryLog	GET /webhook_delivery_logs/{log_id}	Retrieve webhook delivery log
WebhooksApi	createWebhook	POST /webhooks	Create webhook
WebhooksApi	deleteWebhook	DELETE /webhooks/{webhook_id}	Delete webhook
WebhooksApi	listWebhooks	GET /webhooks	List webhooks
WebhooksApi	retrieveWebhook	GET /webhooks/{webhook_id}	Retrieve webhook
WebhooksApi	updateWebhook	PATCH /webhooks/{webhook_id}	Update webhook

Models

• BeneficiaryPayouts
• BeneficiaryPayoutsCreate
• BeneficiaryPayoutsUpdate
• BnplStatus
• CheckoutSessionStatus
• CheckoutSessions
• CheckoutSessionsCreate
• CheckoutSessionsUpdate
• CurrencyCode
• CustomerInvoices
• CustomerInvoicesCreate
• CustomerInvoicesUpdate
• Customers
• CustomersCreate
• CustomersUpdate
• DiscountCoupons
• DiscountCouponsCreate
• DiscountCouponsUpdate
• Error
• ErrorError
• Events
• EventsCreate
• EventsUpdate
• Frequency
• InstalmentPayments
• InstalmentPaymentsCreate
• InstalmentPaymentsUpdate
• InvoiceStatus
• ListBeneficiaryPayouts200Response
• ListCheckoutSessions200Response
• ListCustomerInvoices200Response
• ListCustomers200Response
• ListCustomers200ResponsePagination
• ListDiscountCoupons200Response
• ListEvents200Response
• ListInstalmentPayments200Response
• ListMeterBalances200Response
• ListMeters200Response
• ListPaymentLinks200Response
• ListPaymentRequests200Response
• ListPayoutMethods200Response
• ListPayouts200Response
• ListPrices200Response
• ListProducts200Response
• ListRefunds200Response
• ListSpiAccountAliases200Response
• ListSpiQrCodes200Response
• ListSubscriptions200Response
• ListTransactions200Response
• ListWebhookDeliveryLogs200Response
• ListWebhooks200Response
• MeterBalances
• MeterBalancesCreate
• MeterBalancesUpdate
• Meters
• MetersCreate
• MetersUpdate
• PaymentLinks
• PaymentLinksCreate
• PaymentLinksUpdate
• PaymentMethodCode
• PaymentRequests
• PaymentRequestsCreate
• PaymentRequestsUpdate
• PayoutMethods
• PayoutMethodsCreate
• PayoutMethodsUpdate
• PayoutStatus
• Payouts
• PayoutsCreate
• PayoutsUpdate
• Prices
• PricesCreate
• PricesUpdate
• PricingModelEnum
• ProductTypeEnum
• Products
• ProductsCreate
• ProductsUpdate
• ProviderCode
• RefundStatus
• Refunds
• RefundsCreate
• RefundsUpdate
• SpiAccountAliases
• SpiAccountAliasesCreate
• SpiAccountAliasesUpdate
• SpiAccountStatus
• SpiAccountType
• SpiPaymentStatus
• SpiQrCodes
• SpiQrCodesCreate
• SpiQrCodesUpdate
• SubscriptionStatus
• Subscriptions
• SubscriptionsCreate
• SubscriptionsUpdate
• TransactionStatus
• Transactions
• TransactionsCreate
• TransactionsUpdate
• WebhookDeliveryLogs
• WebhookDeliveryLogsCreate
• WebhookDeliveryLogsUpdate
• WebhookEvent
• Webhooks
• WebhooksCreate
• WebhooksUpdate

Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

hello@lomi.africa

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.1.0
  • Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen