Ezyrec Documentation

Ezyrec Documentation

Welcome to the mobi! Get familiar with our products, features and integrations! This Ezyrec Documentation helps to make your payment made easier.
  • CREATE_CUST

    Create the customer

    REQUEST

    { service:"CREATE_CUST", CustomerId:"K9961402", CustomerName:"Shafi", PhoneNumber:"01133570750", Email:"shafi@gomobi.io", Address:"Mobi Asia Sdn Bhd, damansara heights, kuala lumpur, malaysia" }

    RESPONSE

    { "responseCode": "0000", "responseMessage": "SUCCESSFUL", "responseDescription": "Customer data inserted successfully", "responseData": { "Id": 117, "CustomerId": "K9961402", "CustomerName": "Shafi", "CreatedOn": "2020-01-17T17:25:02.1682018+08:00", "Active": "1", "PhoneNumber": "01133570750", "Email": "shafi@gomobi.io", "Address": "Mobi Asia SDN BHD, damansara heights, kuala lumpur, malaysia", "State": 0, "PostalCode": "", "Country": 0 } }
  • READ_CUST

    Read the customer information

    REQUEST

    { “service” : "READ_CUST" }

    RESPONSE

    { "responseCode": "0000", "responseMessage": "SUCCESSFUL", "responseDescription": "1 CUSTOMER FOUND", "responseData": { "customerList": [ { "Id": 118, "CustomerId": "K9961403", "CustomerName": "Shafi", "CreatedOn": "2020-01-17T00:00:00", "Active": "1", "PhoneNumber": "01133570750", "Email": “shafi@gomobi.io”, SMSSentDate": "0001-01-01T00:00:00", "Address": "", "State": 0, "StateName": "", "PostalCode": "", "Country": 0, "CountryName": "" } ] } }
  • UPDATE_CUST

    Update the customer information

    REQUEST

    { “service”:"UPDATE_CUS” ,” Id”: 118, “CustomerId”:"K9961403", “CustomerName”:"Shafi", “PhoneNumber”:"01133570750", “Email”:"shafi@gomobi.io", “ Address”:"Menara Shell, KL Sentral", “Status”:"1", }

    RESPONSE

    { "responseCode": "0000", "responseMessage": "SUCCESSFUL", "responseDescription": "CUSTOMER DATA UPDATED SUCCESSFULLY", "responseData": { "Id": 118, "CustomerId": "K9961403", "CustomerName": "Shafi", "CreatedOn": "2020-01-17T17:53:44.5932018+08:00", "Active": "1", "PhoneNumber": "01133570750", "Email": "mohammed@gomobi.io", "Address": "Menara Shell, KL Sentral", "State": 0, "PostalCode": "", "Country": 0 } }
  • CREATE_PLAN

    Create the payment plan

    REQUEST

    { “service”:"CREATE_PLAN", “Amount”: 11.80, “Frequency”:1, “NameOfThePlan”:"APIRE C", NoOfPayments”:"6", “Description”:"This plan is to test EZYREC+ API", }

    RESPONSE

    { "responseCode": "0000", "responseMessage": "SUCCESSFUL", "responseDescription": "PAYMENT PLAN CREATED SUCCESSFULLY", "responseData": { "Id": 75, "NameOfThePlan": "APIREC", "CreatedOn": "2020-01-17T18:18:16.3732018+08:00", "Status": "1", "Amount": 11.8, "Frequency": 1, "Description": "This plan is to test EZYREC+ API", "NoOfPayments": 6 } }
  • READ_PLAN

    Read the payment plan

    REQUEST

    { “service”:"READ_PLAN" }

    RESPONSE

    { "responseCode": "0000", "responseMessage": "SUCCESSFUL", "responseDescription": "PAYMENT PLAN LIST RETRIEVED SUCCESSFULLY", "responseData": { "planList": [ { "Id": 14, "NameOfThePlan": "abc", "CreatedOn": "2019-07-22T00:00:00", "UpdatedOn": "2019-08-27T00:00:00", "Status": "1", "Amount": 100.00, "Frequency": 1, "FrequencyName": "1/Daily", "Description": "", "NoOfPayments": 36, "DisplayFrequency": "Daily" } ] } }
  • UPDATE_PLAN

    Update the payment plan

    REQUEST

    { “service”: "UPDATE_PLAN", NameOfThePlan” : "APIREC+", Description: "This plan is to test EZYREC+ API", Status: "1", ID: 74 }

    RESPONSE

    { "responseCode": "0000", "responseMessage": "SUCCESSFUL", "responseDescription": "PAYMENT PLAN DATA UPDATED SUCCESSFULLY", "responseData": { "Id": 74, "UpdatedOn": "2020-01-20T10:39:43.343601+08:00", "Status": "1", "Description": "This plan is to test EZYREC+ API", "NameOfThePlan": "APIREC+" } }
  • ADD_CARD

    Add a card

    REQUEST

    { service:"ADD_CARD", CustomerId:"118", CardNumber:"5541221145872998", CardHolderName: "Mobi", ExpiryDateYear: 2021, ExpiryDateMonth: 02 }

    RESPONSE

    { "responseCode": "0000", "responseMessage": "SUCCESSFUL", "responseDescription": "CARD ADDED SUCCESSFULLY", "responseData": { "customerId": "0", "maskedPan": "491891ffffff5005", "expDate": { "expDateMonth": "12", "expDateYear": "2020", "expDate": "2012" }, "cardHolderName": "Mobi", "cardId": "0", "cardBrand": "", "bankName": "CITIC BANK INTERNATIONAL, LTD.", "cardType": "credit" } }
  • READ_CARD

    Read added card

    REQUEST

    { “service”:"READ_CARD", “ CustomerId”:"31" }

    RESPONSE

    { "responseCode": "0000", "responseMessage": "SUCCESSFUL", "responseDescription": "CARD LIST RETRIEVED SUCCESSFULLY", "responseData": { "cardList": [ { "Id": 18, "SourceName": "EZYREC+ API", "CustomerId": 31, "PhoneNumber": "0199880838", "AddedOn": "2019-07-24T00:00:00", "MaskedCard": "5509 XXXX XXXX 0259", "CardHolderName": "Anson Leo...", "CardBrand": "mastercard", "ExpiryDate": "05/2020", "CardType": "debit", "noOfSubscriptionUnderThisCard": 1 } ] }
  • ADD_SUBSCRIPTION

    Add a subscription for the customer

    REQUEST

    { “service”:"ADD_SUBSCRIPTION", “CustomerId”:"31", “PaymentPlan”:"62", “StartDate”:"2020-01-20", “ CardId”:"18", “Reference”:"RECPLUS API TEST SUBSCRIPTION" }

    RESPONSE

    { "responseCode": "0000", "responseMessage": "SUCCESSFUL", "responseDescription": "PAYMENT PLAN CREATED SUCCESSFULLY", "responseData": { "ID": 29, "CreatedOn": "2020-01-20T14:49:05.763601+08:00", "CustomerID": "31", "PaymentPlan": 62, "CardID": 18, "DynamicPlanStartDate": "20/1/2020 12:00:00 AM", "Reference": "" } }
  • READ_SUBSCRIPTION

    Read all subscriptions under the customer

    REQUEST

    { “service”: "READ_SUBSCRIPTION", “CustomerId”:"31" }

    RESPONSE

    { "responseCode": "0000", "responseMessage": "SUCCESSFUL", "responseDescription": "SUBSCRIPTION LIST RETRIEVED SUCCESSFULLY", "responseData": { "subscriptionList": [ { "ID": 21, "CreatedOn": "2019-10-07T18:04:56", "CustomerID": "31", "PaymentPlan": 62, "CardID": 18, "Active": "0", "DynamicPlanStartDate": "2019-12-10T00:00:00", "Reference": "", "LastHoldDate": "2020-01-08T15:48:44", "LastResumeDate": "0001-01-01T00:00:00", "HoldReason": "the end of subscription", "InvoiceCount": 0, "CustomerName": "Anson", "CardHolderName": "Anson Leong", "CardBrand": "mastercard", "MaskedCard": "5509 XXXX XXXX 0259", "NameOfThePlan": "002", "Amount": 150.00, "FrequencyName": "Half-Yearly" } ] } }
  • HOLD_SUBSCRIPTION

    Hold a subscription

    REQUEST

    { “service”: "HOLD_SUBSCRIPTION", “SubscriptionId”:"21", “HoldReason”:”Customer Terminated” }

    RESPONSE

    { "responseCode": "0000", "responseMessage": "SUCCESSFUL", "responseDescription": "HOLD SUBSCRIPTION SUCCESSFUL", "responseData": "" }
  • RESUME_SUBSCRIPTION

    Resume/Unhold a subscription

    REQUEST

    { “service”: "RESUME_SUBSCRIPTION", “SubscriptionId”:"21" }

    RESPONSE

    { "responseCode": "0000", "responseMessage": "SUCCESSFUL", "responseDescription": "RESUME SUBSCRIPTION SUCCESSFUL", "responseData": "" }
  • READ_INVOICE

    Read all the invoices

    REQUEST

    { “service”: "READ_INVOICE" }

    RESPONSE

    { "responseDescription": "INVOICE LIST RETRIEVED SUCCESSFULLY", "responseData": { "invoiceList": [ { "Id": 4, "InvoiceName": "August/2019/1/4", "CustomerId": 1, "MerchantCustomerId": "MYMV0027", "CustomerName": "MOHAMMED", "Amount": 125.00, "Email": "asyraf@gomobi.io", "PhoneNumber": "0122908627", "MaskedCard": "4862 XXXX XXXX 3952", "CardHolderName": "ASYRAF", "InvoiceDate": "2019-10-23T00:00:00", "InvoiceMonth": 6, "InvoiceYear": 2019, "Paid": "0", "PaidManually": "0", "SuccessfulPaymentDate": "2019-08-23T00:00:00", "TransactionID": "1907250714995320000012000000000790", "LastTryDate": "2019-11-22T00:00:00", "TodayRetries": 0, "AllRetries": 9 } ] }
  • READ_TRANSACTIONS

    Read all the transactions

    REQUEST

    { “service”: "READ_TRANSACTIONS", “InvoiceId”: "1" }

    RESPONSE

    { "responseCode": "0000", "responseMessage": "SUCCESSFUL", "responseDescription": "TRANSACTION LIST RETRIEVED SUCCESSFULLY", "responseData": { "transactionList": [ { "Id": 1, "TransactionDate": "2019-07-04T00:00:00", "Amount": 50.00, "TransactionID": "1907040713109320000012000000000731", "RRN": "", "Trace": "000731", "Date": "04-Jul-2019", "Time": "13:47", "ApproveCode": "000016", "CardNo": "XXXX 7B43", "TC": "32000001000731", "BatchNo": "7", "CardHolderName": "mohammed", "TransactionType": "SALE", "InvoiceName": "Jun/2019/1/1", "CustomerID": "1", "MobileNo": "01133570750", "Email": "premkumar1@gomobi.io", "InvoiceID": "1" } ] } }
  • READ_FORECAST

    Read all the upcoming transactions

    REQUEST

    { “service”: "READ_ FORECAST" }

    RESPONSE

    { "responseCode": "0000", "responseMessage": "SUCCESSFUL", "responseDescription": "FORECAST LIST RETRIEVED SUCCESSFULLY", "responseData": { "forecastList": [ { "UniqueID": 0, "next": "2020-01-20T00:00:00", "week": "WEEK3", "CustomerName": "Aminah", "CustomerId": "abc123", "Email": "1sukhbirsingh@gmail.com", "PhoneNumber": "0163902108", "NameOfThePlan": "monthly renewal ", "Amount": 90.00, "Frequency": "Daily" }, { "UniqueID": 1, "next": "2020-01-21T00:00:00", "week": "WEEK3", "CustomerName": "Aminah", "CustomerId": "abc123", "Email": "1sukhbirsingh@gmail.com", "PhoneNumber": "0163902108", "NameOfThePlan": "monthly renewal ", "Amount": 90.00, "Frequency": "Daily" } ] } }
  • RETRY_TRANSACTION

    Retry a failed transaction

    REQUEST

    { “service”: "RETRY_TRANSACTION", “InvoiceID”: 1 }

    RESPONSE

    { "responseCode": "0000", "responseMessage": "SUCCESSFUL", "responseDescription": "PAYMENT SUCCESSFUL", "responseData": { "customerId": 1, "cardNo": "XXXX 0007", "Amount": 50.0, "cardHolderName": "mohammed noorul ilahi", "Tips": "0.0", "Rrn": "000000000014", "Aid": "", "Trace": "000829", "Date": "24-Jan-2020", "Time": "15:38", "approveCode": "000014", "Tc": "32000001000829", "trxId": "2001240115285320000012000000000829", "invoiceId": "October/2019/1/1", "txnType": "EZYREC+ SALE", "batchNo": "7" } }
  • PRE_AUTH_SMS

    Send a pre-auth SMS to add card

    REQUEST

    { “service”: "PRE_AUTH_SMS", “ CustomerId”: 1 }

    RESPONSE

    { "responseDescription": "PRE-AUTH SMS SENT SUCCESSFULLY”, "responseData": { "InvoiceId": “You will be charged at MOBI for RM1.00 on 18-Jun-2019 16:57. Click to Confirm payment”, "Opt": "http://demo.ezywire.com/mo/?sl=zR59E0F834Dgs", "CustomerID": "1” } }