API Documentation

API Documentation
  1. /charge-types

    Get the list of RentMoola charge types available. These are needed when making payments. Charge types very rarely change, and it's recommended you cache the available types within your application.
    GET

    /users

    Create users to assign payment methods, make payments and setup recurring payment plans.

      /users/{USER_ID}

      Fetch or update a user by their user ID.

        /users/{USER_ID}/payments

        Get the payments that this user has made.
        GET

        /users/{USER_ID}/recurring-plan

        Fetch or update this users current recurring monthly plan.

        /users/{USER_ID}/payment-methods

        Fetch the payment methods that are mapped to this user.
        GET

          /users/{USER_ID}/payment-methods/{PAYMENT_METHOD_ID}

          Fetch a payment method by its ID.
          GET

          /users/{USER_ID}/payment-methods/cc

          Create a new Credit Card payment method.

          /users/{USER_ID}/payment-methods/dd

          Create a new RM Direct Debit payment method.

    /payments

    Manage your payments. Make a one time payment, lookup past transactions, or refund a transaction.

      /payments/{PAYMENT_ID}

      Fetch a past payment by its ID
      GET

        /payments/{PAYMENT_ID}/refund

        Refund a Credit Card transaction.

      /payments/calculate-fees

      Calculate fees by its payment method

    /recurring-plans

    Setup recurring plans to charge new payments on a monthly basis. Plans can be modified or cancelled at any time.
    GET

    /webhooks

    Get a list of web hook events.
    GET

    /report

    Get a list of reports.

      /report/eft

      Get a list of eft reports.
      GET
WebHooks

WebHooks allow you to be notified when specific events happen to your account in real time. We will alert you when transactions are created, refunded or returned, as well as when an onboarding application is updated. All you need to do is provide us with a URL to post the WebHooks to.

Testing

You can use these test cards to simulate a successful transaction. Note that International Cards are international for Canadian Clients.

Number Description Card Currency
4444333322221111 Visa Credit Test Card USD
4917610000000000 Visa Credit Card USD
4206720389883775 Visa Debit Test Card USD
5105105105105100 Mastercard Credit Card USD
5404000000000001 MasterCard Credit Card USD
5573560100022200 Mastercard Debit Test Card USD
4530910000012345 Visa Credit Card CAD
4506440000000017 Visa Debit Card CAD
5191330000004415 MasterCard Credit Card Test Card CAD
370123456789017 Amex Test Card for Optimal USD
6011234567890123 Discover Test Credit Card USD
6759950000000162 Maestro Debit Test Card USD
Plugins
  1. Omnipay

    Omnipay is a payment processing library for PHP 5.3+. It is designed to be a plug and play solution, allowing our API to be implemented in a few easy steps.