Download the PHP package xplicit-dev/mamopay without Composer

MamoPay

The MamoPay PHP library offers seamless integration with the MamoPay API for PHP-based applications, streamlining access and enhancing functionality.

Requirements

A minimum of PHP 5.6.0 up to 8.1

Installation

You can install the package via Composer:

Getting Started

Obtain your API Key:

Log in to the MamoPay dashboard (https://dashboard.mamopay.com/manage/developer)

and navigate to the Developer section to get your API key.

Instantiate MamoPay Client:

For sandbox testing, pass 'true' as second parameter:

The resources can be accessed via the $client object. All the methods invocations follow the following pattern

• Fetch Business Info:

• Fetch Account Balances:

Supported Resources

• Links
  • Transaction
  • Subscription
  • Payout
  • Webhook
• Recipient
• Card
• Invoice

Use of Unlisted Resources

The MamoClient SDK allows you to utilize resources not listed within this package. This flexibility enables you to leverage any additional resources provided by the MamoPay API without constraints.

Links

The resource to generate vanilla and subscription payment links

• generate vanilla payment link:

see params here https://mamopay.readme.io/reference/post_links

this will return a \MamoPay\Api\Objects\PaymentLink object

refer: https://mamopay.readme.io/reference/payment-link-object

• Fetching all Payment Links:

• Update Payment Link:

• Delete Payment Link:

• Fetch Payment Link Info:

Transaction

Initiate transactions by merchant (Merchant Initiated Transaction)

Merchant Initiated Transactions (MIT) allows a business to use card details, that were stored during previous transactions, to charge their customers.

this will return a \MamoPay\Api\Objects\TransactionInfo object

refer : https://mamopay.readme.io/reference/charge-object

• Fetch Transaction Info

• Fetch all Transactions

• Fetch Transaction Info (includes refunds[] breakdown and max_refund_amount on the returned TransactionInfo object)

• Capture Payment - to capture an "On hold" payment

• Reverse Payment - to reverse an "On hold" payment

• Refund Payment

Subscription

• Fetches all subscribers of subscription.

• Fetches all subscription payments made against a Recurring Payment item.

• Unsubscribe subscription

• Cancels an existing recurring payment. This is NOT to unsubscribe a customer from a recurring payment that they have subscribed to. This deletes a previously created subscription for a business.

• Create Subscription Creates a subscription object that defines a billing schedule (frequency, interval, start/end date, etc). This only creates the subscription object; attach the returned subscription identifier to a payment link using the subscription_id attribute on the Links create/update APIs.

• Change Customer Subscription Upgrades a subscriber from their current subscription to a target subscription without re-entering card details. Prorates and charges the difference against the target plan's payment link.

Payout

• Fetch all Disbursements

Issue Disbursements

• Allows the issuance of disbursement

• Allows the issuance of disbursements in bulk

• Create International Payout Initiates an international payout to an existing recipient (created via the Create Recipient API). The destination currency and corridor are determined by the recipient's bank details. Exactly one of $source_amount or $destination_amount must be provided - not both.

Webhook

-Webhook registration for updates on one-off payment statuses and subscription payment statuses.

this will return \MamoPay\Api\Objects\WebhookInfo object

• WebhookEvent class contain all event constants

• Fetches all registered webhooks for a given business

• update webhook details

• Delete a registered webhook

• Delete all registered webhooks

Recipient-section

• Fetches all Recipients.

• Create Recipient Allows a user to create recipient.

• Update Recipient Allows a user to update recipient details.

• Fetch Recipient Allows a user to fetch recipient details.

• Delete Recipient Allows a user to delete recipient.

• Fetch Recipient Balance Fetches the real-time balance of a recipient's ledger. Recipients accumulate balance from payouts_share splits on payments, and the balance is deducted when a payout is issued to the recipient.

• Validate IBAN Validates a UAE IBAN and returns the bank it belongs to. Always returns 200 OK for a well-formed request - an invalid IBAN is reflected by valid: false in the response with an errors array, not by an error response.

Card Section

Create Virtual Corporate Card A Virtual Corporate Card (VCC) is a digital payment solution for businesses to simplify corporate expenses like travel and accommodations.

Parms :

amount The amount on the VCC card. The value can not exceed the card balance.

email Cardholder’s email address. Card holder must be completed KYC.

booking_id Booking reference in case the card will be used for a 1 time booking.

verification_email The email address that will be used for verification purposes.

Partner Cards These APIs allow you to issue and manage virtual partner cards with specific limits and controls for your business partners. Available upon request for a tailored integration.

• Create Partner Card

• Get Partner Cards List (paginated)

• Get Partner Card Details

• Update Partner Card (update the amount limit of an active card)

• Cancel Partner Card (only active cards can be cancelled)

• Get Partner Card Transactions (paginated)

• Get Partner Card Transaction Details

Card Transactions & Expenses

• Fetching Card Transactions (all transactions for cards, paginated)

• Fetch Card Transaction Details

• Update Expense (description, invoice number, status: incomplete / pending_review / ready / synced)

• Fetching Expense Receipts (paginated)

• Fetch Expense Receipt Details

Invoice

Create Invoice - API to create and send an invoice to a customer via email.

Testing

Unit tests run offline (no API key required):

Integration tests hit the live Mamo sandbox. Provide your sandbox API key via environment variables:

Run everything with vendor/bin/phpunit. The webhook test uses MAMO_WEBHOOK_URL (defaults to https://httpbin.org/post) — point it at a reachable endpoint (e.g. an ngrok tunnel) so the sandbox's reachability validation passes.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

License

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