Package com.midtrans.service

Interface MidtransIrisApi

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Config apiConfig()
      Do re-set config Class iris-credential, IrisIdempotencyKey
      org.json.JSONObject approvePayouts​(Map<String,​Object> params)
      Do approve `/payouts/approve` Use this API for Apporver to approve multiple payout request.
      org.json.JSONObject createBeneficiaries​(Map<String,​String> params)
      Do create `/beneficiaries` Use this API to create a new beneficiary information for quick access on the payout page in Iris Portal.
      org.json.JSONObject createPayouts​(Map<String,​Object> params)
      Do create `/payouts` This API is for Creator to create a payout.
      org.json.JSONObject getBalance()
      Do get `/balance` API request to Use get current balance information.
      org.json.JSONArray getBankAccounts()
      Do get `/bank_accounts` Use this API for show list of registered bank accounts for facilitator partner
      org.json.JSONArray getBeneficiaries()
      Do get `/beneficiaries` Use this API to fetch list of all beneficiaries saved in Iris Portal.
      org.json.JSONObject getBeneficiaryBanks()
      Do get `/beneficiary_banks` Use this API for show list of supported banks in IRIS.
      org.json.JSONObject getFacilitatorBalance​(String bankAccountId)
      Do get `/bank_accounts/{bank_account_id}/balance` For Facilitator Partner, use this API is to get current balance information of your registered bank account.
      org.json.JSONObject getPayoutDetails​(String referenceNo)
      Do get `/payouts/{reference_no}` Use this API for get details of a single payout
      org.json.JSONArray getTopUpChannels()
      Do get `/channels` Use this API for get top up information channel only for Aggregator Partner
      org.json.JSONArray getTransactionHistory​(String fromDate, String toDate)
      Do get `/statements` Use this API for list all transactions history for a month.
      String ping()
      Do `/ping` Returns pong message for monitoring purpose
      org.json.JSONObject rejectPayouts​(Map<String,​Object> params)
      Do reject `/payouts/reject` Use this API for Apporver to reject multiple payout request.
      org.json.JSONObject updateBeneficiaries​(String aliasName, Map<String,​String> params)
      Do update `/beneficiaries/{alias_name}` Use this API to update an existing beneficiary identified by it's `alias_name`.
      org.json.JSONObject validateBankAccount​(String bank, String account)
      Do validate `/account_validation` Use this API for check if an account is valid, if valid return account information.

    • Method Detail

      • apiConfig

        Config apiConfig()
        Do re-set config Class iris-credential, IrisIdempotencyKey
        Returns:
        {Config class}

      • ping

        String ping()
     throws MidtransError
        Do `/ping` Returns pong message for monitoring purpose
        Returns:
        {String} - with value Pong
        Throws:
        MidtransError - when an exception was occurred during executing the request.

      • getBalance

        org.json.JSONObject getBalance()
                        throws MidtransError
        Do get `/balance` API request to Use get current balance information. For Aggregator Partner you need to top up to Iris’ bank account.
        Returns:
        {JSONObject} - org.json Promise contains Object from JSON decoded response refer to: https://iris-docs.midtrans.com/#check-balance-aggregator
        Throws:
        MidtransError - when an exception was occurred during executing the request.

      • createBeneficiaries

        org.json.JSONObject createBeneficiaries​(Map<String,​String> params)
                                 throws MidtransError
        Do create `/beneficiaries` Use this API to create a new beneficiary information for quick access on the payout page in Iris Portal.
        Parameters:
        params - Map Object parameter, object of Core API JSON body as parameter, will be converted to JSON (more params detail refer to: https://iris-docs.midtrans.com/#create-beneficiaries)
        Returns:
        {JSONObject} - org.json Promise contains Object from JSON decoded response
        Throws:
        MidtransError - when an exception was occurred during executing the request.

      • updateBeneficiaries

        org.json.JSONObject updateBeneficiaries​(String aliasName,
                                        Map<String,​String> params)
                                 throws MidtransError
        Do update `/beneficiaries/{alias_name}` Use this API to update an existing beneficiary identified by it's `alias_name`.
        Parameters:
        aliasName - Alias name used by the Beneficiary. Length should be less than or equal to 20 characters only alphanumeric characters are allowed
        params - Map Object parameter, object of Core API JSON body as parameter, will be converted to JSON (more params detail refer to: https://iris-docs.midtrans.com/#update-beneficiaries)
        Returns:
        {JSONObject} - org.json Promise contains Object from JSON decoded response
        Throws:
        MidtransError - when an exception was occurred during executing the request.

      • getBeneficiaries

        org.json.JSONArray getBeneficiaries()
                             throws MidtransError
        Do get `/beneficiaries` Use this API to fetch list of all beneficiaries saved in Iris Portal.
        Returns:
        {JSONObject} - org.json Promise contains Object from JSON decoded response refer to: https://iris-docs.midtrans.com/#list-beneficiaries
        Throws:
        MidtransError - when an exception was occurred during executing the request.

      • createPayouts

        org.json.JSONObject createPayouts​(Map<String,​Object> params)
                           throws MidtransError
        Do create `/payouts` This API is for Creator to create a payout. It can be used for single payout and also multiple payouts.
        Parameters:
        params - Map Object parameter, object of Core API JSON body as parameter, will be converted to JSON (more params detail refer to: https://iris-docs.midtrans.com/#create-payouts)
        Returns:
        {JSONObject} - org.json Promise contains Object from JSON decoded response
        Throws:
        MidtransError - when an exception was occurred during executing the request.

      • approvePayouts

        org.json.JSONObject approvePayouts​(Map<String,​Object> params)
                            throws MidtransError
        Do approve `/payouts/approve` Use this API for Apporver to approve multiple payout request.
        Parameters:
        params - Map Object parameter, object of Core API JSON body as parameter, will be converted to JSON (more params detail refer to: https://iris-docs.midtrans.com/#approve-payouts)
        Returns:
        {JSONObject} - org.json Promise contains Object from JSON decoded response
        Throws:
        MidtransError - when an exception was occurred during executing the request.

      • rejectPayouts

        org.json.JSONObject rejectPayouts​(Map<String,​Object> params)
                           throws MidtransError
        Do reject `/payouts/reject` Use this API for Apporver to reject multiple payout request.
        Parameters:
        params - Map Object parameter, object of Core API JSON body as parameter, will be converted to JSON (more params detail refer to: https://iris-docs.midtrans.com/#reject-payouts)
        Returns:
        {JSONObject} - org.json Promise contains Object from JSON decoded response
        Throws:
        MidtransError - when an exception was occurred during executing the request.

      • getPayoutDetails

        org.json.JSONObject getPayoutDetails​(String referenceNo)
                              throws MidtransError
        Do get `/payouts/{reference_no}` Use this API for get details of a single payout
        Parameters:
        referenceNo - String parameter, unique reference no of a payout (more params detail refer to: https://iris-docs.midtrans.com/#get-payout-details)
        Returns:
        {JSONObject} - org.json Promise contains Object from JSON decoded response
        Throws:
        MidtransError - when an exception was occurred during executing the request.

      • getTransactionHistory

        org.json.JSONArray getTransactionHistory​(String fromDate,
                                         String toDate)
                                  throws MidtransError
        Do get `/statements` Use this API for list all transactions history for a month. You can specified start date and also end date for range transaction history.
        Parameters:
        fromDate - String date parameter, start date range for payouts (YYYY-MM-DD) more params detail refer to: https://iris-docs.midtrans.com/#transaction-history
        toDate - String date parameter, end date range for payouts (YYYY-MM-DD) more params detail refer to: https://iris-docs.midtrans.com/#get-payout-details
        Returns:
        {JSONObject} - org.json Promise contains Object from JSON decoded response
        Throws:
        MidtransError - when an exception was occurred during executing the request.

      • getTopUpChannels

        org.json.JSONArray getTopUpChannels()
                             throws MidtransError
        Do get `/channels` Use this API for get top up information channel only for Aggregator Partner
        Returns:
        {JSONObject} - org.json Promise contains Object from JSON decoded response (more params detail refer to: https://iris-docs.midtrans.com/#top-up-channel-information-aggregator)
        Throws:
        MidtransError - when an exception was occurred during executing the request.

      • getBankAccounts

        org.json.JSONArray getBankAccounts()
                            throws MidtransError
        Do get `/bank_accounts` Use this API for show list of registered bank accounts for facilitator partner
        Returns:
        {JSONObject} - org.json Promise contains Object from JSON decoded response (more params detail refer to: https://iris-docs.midtrans.com/#bank-accounts-facilitator)
        Throws:
        MidtransError - when an exception was occurred during executing the request.

      • getFacilitatorBalance

        org.json.JSONObject getFacilitatorBalance​(String bankAccountId)
                                   throws MidtransError
        Do get `/bank_accounts/{bank_account_id}/balance` For Facilitator Partner, use this API is to get current balance information of your registered bank account.
        Parameters:
        bankAccountId - String Bank Account Number
        Returns:
        {JSONObject} - org.json Promise contains Object from JSON decoded response refer to: https://iris-docs.midtrans.com/#check-balance-facilitator
        Throws:
        MidtransError - when an exception was occurred during executing the request.

      • getBeneficiaryBanks

        org.json.JSONObject getBeneficiaryBanks()
                                 throws MidtransError
        Do get `/beneficiary_banks` Use this API for show list of supported banks in IRIS. https://iris-docs.midtrans.com/#supported-banks
        Returns:
        {JSONObject} - org.json Promise contains Object from JSON decoded response (more params detail refer to: https://iris-docs.midtrans.com/#list-banks)
        Throws:
        MidtransError - when an exception was occurred during executing the request.

      • validateBankAccount

        org.json.JSONObject validateBankAccount​(String bank,
                                        String account)
                                 throws MidtransError
        Do validate `/account_validation` Use this API for check if an account is valid, if valid return account information.
        Parameters:
        bank - String bank code
        account - String Account number
        Returns:
        {JSONObject} - org.json Promise contains Object from JSON decoded response (more params detail refer to: https://iris-docs.midtrans.com/#validate-bank-account)
        Throws:
        MidtransError - when an exception was occurred during executing the request.