OVO Wallet

Interaction diagram

Payment processing by using the OVO Wallet payment method requires merchant's web service, one of Monetix interfaces, and the Monetix payment platform, as well as the technical facilities of the provider.

Operations support

	Interfaces			Amounts, IDR		Times
	Payment Page	Gate	Dashboard	minimum	maximum	basic	threshold
Purchases				*	*	*	*
Payouts				*	*	*	*

* Refer to your Monetix key account manager for the information.

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section and click the Payment methods tab.

Processing scenarios

In the OVO Wallet method, purchases and payouts follow different processing procedures. To perform a purchase operation, your customer is required to use his mobile application, or you need to redirect customer to the provider service, while to initiate a payout, you need to notify customer via merchant's web service.

The sections that follow provide detailed information about what you need to perform payments and how you can analyze the information on payments and operations.

General information

In the OVO Wallet method, when processing a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the Monetix URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the OVO Wallet method selected. For more information about preselecting payment methods, see in Preselecting payment methods.

The full sequence and particularities of the purchase process are provided below.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the OVO Wallet payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Request format

There are several things you need to consider when using the OVO Wallet method:

1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are required for any payment method:
   • project_id—the project ID obtained from Monetix
   • payment_id—payment ID unique within the project
   • payment_currency—payment currency in ISO-4217 alpha-3 format
   • payment_amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
   • customer_id—unique ID of the customer within your project
   • customer_first_name—customer first name
   • customer_last_name—customer last name
   • customer_email—customer email
2. Also, you may need to add the customer_account_number parameter with the customer OVO account identifier. If this parameter is missing from the request, the customer will be prompted to enter their OVO account identifier during the payment. Consult with your Monetix key account manager to learn whether this parameter is mandatory.
3. If you need to have payment form displayed with the OVO Wallet method selected, set the force_payment_method parameter to ovo.
4. If required, you can also add any other additional parameters Payment Page supports.
5. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Here is an example of data from a request for Payment Page opening:

EPayWidget.run(
    { 
        payment_id: 'X03936', 
        payment_amount: 1000000, 
        payment_currency: 'IDR', 
        project_id: 12345,
        customer_id: 'customer1',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        customer_email: 'johndoe@email.com',
        signature: "kUi2x9dKHAVNU0FYldJrxh4yo...wX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the OVO Wallet method, see Payment Page invocation parameters.

Callback format

The OVO Wallet method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks in Payment Page.

The following is the example of a callback with an information about successful 10,000.00 IDR purchase made in the 439 project.

{
        "project_id": 439,
        "payment": {
            "id": "EP8417-7f12",
            "type": "purchase",
            "status": "success",
            "date": "2021-06-09T13:41:43+0000",
            "method": "ovo",
            "sum": {
                "amount": 1000000,
                "currency": "IDR"
            },
            "description": ""
        },
        "operation": {
            "id": 1711,
            "type": "sale",
            "status": "success",
            "date": "2021-06-09T13:41:43+0000",
            "created_date": "2021-06-09T13:41:39+0000",
            "request_id": "c66bf3ecb02c4c19a11b2cd6e2c460712f2ed86f52-00000001",
            "sum_initial": {
                "amount": 1000000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 1000000,
                "currency": "IDR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 6682,
                "payment_id": "",
                "auth_code": "",
                "date": "2021-06-09T13:41:42+0000"
            }
        },
        "signature": "ab51MI5wDVMO8jL/9wTwpwD2COA1m8ZXXDceGoTLIxAaiZihRQ=="
    }

The following is the example of a callback for a declined purchase.

{
        "project_id": 439,
        "payment": {
            "id": "EPe5bd-2f88",
            "type": "purchase",
            "status": "decline",
            "date": "2021-06-09T13:44:40+0000",
            "method": "ovo",
            "sum": {
                "amount": 20000,
                "currency": "IDR"
            },
            "description": ""
        },
        "operation": {
            "id": 1712,
            "type": "sale",
            "status": "decline",
            "date": "2021-06-09T13:44:40+0000",
            "created_date": "2021-06-09T13:44:34+0000",
            "request_id": "2b4241e02c5e1e9e75156d60a78591da0b4ca1-00000001",
            "sum_initial": {
                "amount": 20000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 20000,
                "currency": "IDR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 6682,
                "payment_id": "",
                "auth_code": "",
                "date": "2021-06-09T13:44:38+0000"
            }
        },
        "signature": "aWYu87AYwbcAq9kyR1FgBSFN9Yd+oUMsLEJk9rMwRaLaT1mPiP36Q=="
    }

Related topics

The following topics might be useful when implementing payments by using Payment Page:

• Integration procedure
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

General information

In the OVO Wallet method, the merchant web service is required to do the following when processing a purchase by using Gate:

1. Send request with all the required parameters and signature to the Monetix URL.
2. Redirect the customer to the OVO Wallet service.
3. Accept the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.

The sections that follow discuss in more details the request format and the Gate parameters to use in the OVO Wallet payment method and provide the information on the format of callbacks with purchase results.

Request format

1. You perform purchases by sending the /v2/payment/wallet/ovo/sale request by using POST (HTTP) method. This is an e-wallet payments request group: /v2/payment/wallet/{payment_method}/sale.
2. The following objects and parameters must be specified in any request:
   • general—object with general request identification information:
     • project_id—the project ID obtained from Monetix
     • payment_id—payment ID unique within the project
     • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
   • payment—object with purchase information:
     • amount—purchase amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
     • currency—code of purchase currency in the ISO-4217 alpha-3 format
   • customer—object with customer information:
     • id—the unique ID of the customer within your project
     • ip_address—customer device IP
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email
3. Also, you may need to add the account object with the number parameter containing the customer OVO account identifier. If this parameter is missing from the request, the customer will be prompted to enter their OVO account identifier during the payment. Consult with your Monetix key account manager to learn whether this parameter is mandatory.
4. The following parameters with the return URLs are optional, but we strongly advise you to specify them in the request to provide your customer a better user experience. If you don't specify any parameters of the return_url object in the request, by default Gate will redirect the customer to the URL specified in your project in Monetix.
   • return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
     • success—the URL to redirect the customer to after the payment is successfully completed
     • decline—the URL to redirect the customer to after the payment is declined
     • return—the URL to redirect the customer to when they prematurely terminate the payment. This URL is also used if the success and decline parameters are not specified in the request.
5. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a purchase request in the OVO Wallet method.

{
    "general": {
        "project_id": 2373,
        "payment_id": "test123129",
        "signature": "6/E1dobuXL+JLua7pbgXm9QBqxv9JgM1EwBc3ovVQ=="
    },
    "payment": {
        "amount": 1000000,
        "currency": "IDR"
    },
    "customer": {
        "ip_address": "198.51.100.47",
        "id": "customer1",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    }
}

Format of customer redirection data

After receiving and processing your purchase request, the payment platform sends a callback to your web service containing the data to redirect the customer to the OVO Wallet service.

To redirect the customer, use the values of the following parameters in the redirect_data object:

• url—the URL to redirect the customer to
• body—the data to be sent in the request body
• method—the HTTP method to get an HTML page of the website (for example, POST or GET)
• encrypted—this is the service parameter. Ignore the data it contains.

Here is an example of a piece of callback containing the data to redirect the customer.

"redirect_data": {
    "method": "POST",
    "body": {
        "example_parameter_1": "value_1",
        "example_parameter_2": "value_2"
    },
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Callback format

The OVO Wallet method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks in Gate.

The following is the example of a callback with an information about successful 10,000.00 IDR purchase made in the 439 project.

{
        "project_id": 439,
        "payment": {
            "id": "EP8417-7f12",
            "type": "purchase",
            "status": "success",
            "date": "2021-06-09T13:41:43+0000",
            "method": "ovo",
            "sum": {
                "amount": 1000000,
                "currency": "IDR"
            },
            "description": ""
        },
        "operation": {
            "id": 1711,
            "type": "sale",
            "status": "success",
            "date": "2021-06-09T13:41:43+0000",
            "created_date": "2021-06-09T13:41:39+0000",
            "request_id": "c66bf3ecb02c4c19a11b2cd6e2c460712f2ed86f52-00000001",
            "sum_initial": {
                "amount": 1000000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 1000000,
                "currency": "IDR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 6682,
                "payment_id": "",
                "auth_code": "",
                "date": "2021-06-09T13:41:42+0000"
            }
        },
        "signature": "ab51MI5wDVMO8jL/9wTwpwD2COA1m8ZXXDceGoTLIxAaiZihRQ=="
    }

The following is the example of a callback for a declined purchase.

{
        "project_id": 439,
        "payment": {
            "id": "EPe5bd-2f88",
            "type": "purchase",
            "status": "decline",
            "date": "2021-06-09T13:44:40+0000",
            "method": "ovo",
            "sum": {
                "amount": 20000,
                "currency": "IDR"
            },
            "description": ""
        },
        "operation": {
            "id": 1712,
            "type": "sale",
            "status": "decline",
            "date": "2021-06-09T13:44:40+0000",
            "created_date": "2021-06-09T13:44:34+0000",
            "request_id": "2b4241e02c5e1e9e75156d60a78591da0b4ca1-00000001",
            "sum_initial": {
                "amount": 20000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 20000,
                "currency": "IDR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 6682,
                "payment_id": "",
                "auth_code": "",
                "date": "2021-06-09T13:44:38+0000"
            }
        },
        "signature": "aWYu87AYwbcAq9kyR1FgBSFN9Yd+oUMsLEJk9rMwRaLaT1mPiP36Q=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

• Integration procedure
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

General information

To perform a payout through the OVO Wallet method, merchant's web service sends a request with all the required parameters and signature to Monetix URL, and receives a callback with the payment result. The full sequence of the payout process is provided below.

The sections that follow discuss in more details the request format and the Gate parameters to use in the OVO Wallet payment method and provide the information on the format of callbacks with payout results.

Request format

1. You perform payout by sending the /v2/payment/wallet/ovo/payout request by using POST (HTTP) method. This is an e-wallet payments request group /v2/payment/wallet/{payment_method}/payout.
2. The following objects and parameters must be specified in any request:
   • general—object with general request identification information:
     • project_id—the project ID obtained from Monetix
     • payment_id—payment ID unique within the project
     • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
   • payment—object with payout information:
     • amount—payout amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
     • currency—code of payout currency in the ISO-4217 alpha-3 format
   • customer—object with customer information:
     • id—the unique ID of the customer within your project
     • ip_address—customer device IP
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email
   • account—object with customer account information:
     • number—OVO account identifier (must consist of no more than 15 digits)
3. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a payout request in the OVO Wallet method.

{
    "general": {
        "project_id": 2853,
        "payment_id": "test-002",
        "signature": "M1vT4q9c8hA8xCjEwGFSAkn+aJmGA4jH6bgBOp8DTf8d/XdoV+vd7Q=="
    },
    "payment": {
        "amount": 10000,
        "currency": "IDR"
    },
    "customer": {
        "id": "payoutTest",
        "ip_address": "114.124.147.206",
        "email": "johndoe@example.com",
        "first_name": "John",
        "last_name": "Doe"
    },
    "account": {
        "number": "081211111111"
    }
}

Callback format

The OVO Wallet method uses the standard format for callbacks to deliver payout results. For more information, see Callbacks in Gate.

The following is the example of a callback with an information about successful 10,000.00 IDR payout made in the 439 project.

{
        "project_id": 439,
        "payment": {
            "id": "164601_32630630",
            "type": "payout",
            "status": "success",
            "date": "2021-06-09T13:46:08+0000",
            "method": "ovo",
            "sum": {
                "amount": 1000000,
                "currency": "IDR"
            },
            "description": ""
        },
        "account": {
            "number": "1234"
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 1713,
            "type": "payout",
            "status": "success",
            "date": "2021-06-09T13:46:08+0000",
            "created_date": "2021-06-09T13:46:03+0000",
            "request_id": "5b164bbbb2dcf7ec1d6190a7212ec90b6a9d528a-00000001",
            "sum_initial": {
                "amount": 1000000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 1000000,
                "currency": "IDR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 6682,
                "payment_id": "ecf16ae5-6419",
                "auth_code": "",
                "date": "2021-06-09T13:46:06+0000"
            }
        },
        "signature": "upl29ym7t+r0aYiZOaJl/9chb34gmyEd5Z2SG+p3iVVEsoDnp+2YyQ=="
    }

The following is the example of a callback for a declined payout.

{
        "project_id": 439,
        "payment": {
            "id": "164753_53114954",
            "type": "payout",
            "status": "decline",
            "date": "2021-06-09T13:48:00+0000",
            "method": "ovo",
            "sum": {
                "amount": 40000,
                "currency": "IDR"
            },
            "description": ""
        },
        "account": {
            "number": "456"
        },
        "customer": {
            "id": "customer2"
        },
        "operation": {
            "id": 1714,
            "type": "payout",
            "status": "decline",
            "date": "2021-06-09T13:48:00+0000",
            "created_date": "2021-06-09T13:47:54+0000",
            "request_id": "2d61a590c26ea70a7474d9869b06bc48025f68-00000001",
            "sum_initial": {
                "amount": 40000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 40000,
                "currency": "IDR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 6682,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "WEXldjWeZanWbwyD9Sfui3XJcSvHXmgxnALsxX/8UTQF7DkNPT0oQ=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

• Integration procedure
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

• single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
• as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.

Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.

For more information about payout processing by using Dashboard, see Performing payouts.

General information

You can perform test purchases with the OVO Wallet payment method by using Payment Page and Gate.

To perform test purchases, you'll need the test project ID and the secret key to it. To get them, please contact the technical support team at support@monetix.pro and then contact your Monetix key account manager to set up a test environment to work with the OVO Wallet payment method.

When performing test payments, keep in mind that:

• your requests must contain the test project ID
• the payment currency that you send in requests can be only IDR
• random values may be used as the payment ID and in the parameters with customer information
• the interface of the test checkout page may be different from the production one.

Test payments statuses

To receive one of the following statuses in the callback with the test purchase result, use a particular value for the purchase amount in the request:

• 40000 and 40400—to receive a callback with the decline status
• any other value—to receive a callback with the success status

Testing purchase by using Payment Page

To perform a test purchase by using Payment Page:

1. Send a request for purchase through Payment Page to the payment platform.
2. Choose a payment method on the test checkout page. If you've passed the force_payment_method parameter with the ovo value in the request, you won't have to choose the payment method.
3. Specify a random first name and last name in the data entry fields. The payment instructions will be displayed to you after.
4. Accept a callback with information about the test purchase result.
5. Wait a few seconds until the result of the test purchase is displayed to you on the test checkout page.

See the detailed information about purchase processing through Payment Page in the OVO Wallet payment method in the Purchase by using Payment Page section.

Testing purchase by using Gate

To perform a test purchase by using Gate:

1. Send a request for performing a test purchase to the payment platform.
2. Accept a callback with the data for displaying payment instructions. Your system will display the payment instructions to you after.
3. Accept a callback with information about the test payment result.
4. Wait a few seconds until your system shows you the result of the test purchase.

See the detailed information about purchase processing through Gate in the OVO Wallet payment method in the Purchase by using Gate section.

As with other payment methods Monetix offers, when using this method, you have several options to analyze the information about payments and operations.

You can load and analyze all the necessary information in Dashboard (dash-light.trxhost.com), for instance you can use the analytic panels in the Analytics section for this purpose.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

• Dashboard allows you to download reports in CSV format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
• Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by means of sending requests to the /operations/get endpoint.

If you have any further questions regarding payment data analysis, contact Monetix technical support.