OVO wallet

Overview

OVO Wallet is a payment method to process payments by using OVO e-wallets . You can perform purchases through this method by using Payment Page and Gate, payouts by using Gate.

General information

Payment method type payments by using e-wallets
Countries and regions ID
Payment currencies IDR
Currency conversion +
Purchases +
Payouts +
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Special considerations In this method all payment amounts in IDR are integer. If the currency IDR is specified in the payment request it is necessary to round the payment amount to an integer. If another currency is specified in the request, the payment amount is converted to an equivalent amount in the IDR currency on the ECommPay side and rounded up to an integer.
Obtaining access to the payment method and access fee refer to your ECommPay key account manager

Interaction diagram

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



Operations support

  Interfaces Amounts, IDR Times**
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) minimum maximum basic threshold
Purchases + + 10,000.00 2,000,000.00 until KYC*

10,000,000.00 since KYC

1 minute 85 seconds
Payouts + + 10,000.00 25,000,000.00 1 minute 45 days

* KYC or Know Your Customer is the process that allows organisations to verify clients and prevent frauds.

** The basic and threshold times are defined as follows:

  • The basic time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from customer is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
  • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ECommPay technical support.

Processing scenarios

In the OVO Wallet method, purchases and payouts follow different processing procedures. To perform a purchase operation, 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 analyse the information on payments and operations.

Purchase by using Payment Page

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 ECommPay 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.



Figure: Purchase by using Payment Page

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the OVO Wallet method.
  8. The input form for entering the OVO account identifier is displayed to the customer.
  9. The customer specifies the account identifier.
  10. The payment platform receives the purchase request for payment processing from Payment Page.
  11. The payment platform performs the internal purchase request processing and sends it to the provider service.
  12. The purchase request is processed on the provider service side.
  13. The provider service generates sends a push notification to the mobile phone on which the OVO mobile application is installed .
  14. The customer completes all the required payment steps during 70 seconds.
  15. The payment is processed on the provider side.
  16. The provider service sends the result notification to the payment platform.
  17. The payment platform sends a callback with the payment result to the web service.
  18. The payment platform sends the result to Payment Page.
  19. A page with the payment result information is displayed to the customer on Payment Page.

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 mandatory for any payment method:
    • project_id—the project ID obtained from ECommPay
    • 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. If the currency IDR is specified in the purchase request it is necessary to round the payment amount to an integer. If another currency is specified in the request, the payment amount is converted to an equivalent amount in the IDR currency on the ECommPay side and rounded up to an integer (for example, if the converted amount is 200,000.05 IDR, such an amount is rounded up to 200,001.00 IDR)
    • customer_id—ID of the customer within your project
  2. It is recommended to specify the OVO account identifier of the customer (must consist of no more than 15 digits) in the customer_account_number additional parameter. If the request is missing the parameter, on Payment Page the additional field is displayed to the customer to input missing data. For more details about clarification, see Submission of additional payment information.
  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.

Thus, a correct payment request in the OVO Wallet method must include project, customer, and payment IDs, the currency and the amount of a payment in the appropriate currency, as shown in the following example:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 1000000, 
      payment_currency: 'IDR', 
      project_id: 12345,
      customer_id: 'customer1'
      customer_account_number: '081211111111'
      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.

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

Figure: Example of a successful purchase callback

{
        "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": ""
        },
        "account": {
            "number": "123"
        },
        "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.

Figure: Example of a declined purchase callback

{
        "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": ""
        },
        "account": {
            "number": "9544544545"
        },
        "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:

Purchase by using Gate

General information

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

  1. Send a request with all the required parameters and signature to the ECommPay URL.
  2. Get the callback with the payment result from the payment platform.

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



Figure: Purchase by using Gate

  1. A customer initiates a purchase through OVO Wallet on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified ECommPay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the provider service.
  7. The request is processed on the provider side.
  8. The provider service generates sends a push notification to the mobile phone on which the OVO mobile application is installed .
  9. The customer completes all the required payment steps during 70 seconds.
  10. The payment is processed on the provider side.
  11. The provider service sends the payment result notification to the payment platform.
  12. The payment platform sends a callback to the web service.
  13. The customer receives the payment result on the web service.

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

There are several things you must consider when using purchase requests in the OVO Wallet method:
  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:
    • Object general—general request identification information:
      • project_id—the project ID obtained from ECommPay
      • 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.
    • Object payment—payment information:
      • amount—payment amount in minor currency units. If the currency IDR is specified in the purchase request it is necessary to round the payment amount to an integer. If another currency is specified in the request, the payment amount is converted to an equivalent amount in the IDR currency on the ECommPay side and rounded up to an integer (for example, if the converted amount is 200,000.05 IDR, such an amount is rounded up to 200,001.00 IDR)
      • currency—purchase currency in ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—the unique ID of the customer within your project
      • ip_address—customer IP address
    • Object account—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.

Thus, a correct payment request in the OVO Wallet method must include project and payment IDs, customer and account information, currency and amount of the purchase, as well as signature, as shown in the following example:

Figure: Example of a purchase request

{
    "general": {
        "project_id": 2373,
        "payment_id": "test123129",
        "signature": "6/E1dobuXL+JLua7pbgXm9QBqxv9JgM1EwBc3ovVQ=="
    },
    "payment": {
        "amount": 1000000,
        "currency": "IDR"
    },
    "account": {
        "number": "081211111111",
    },
    "customer": {
        "ip_address": "1.1.1.1",
        "id": "customer1"
    }
}

Callback format

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

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

Figure: Example of a successful purchase callback

{
        "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": ""
        },
        "account": {
            "number": "123"
        },
        "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.

Figure: Example of a declined purchase callback

{
        "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": ""
        },
        "account": {
            "number": "9544544545"
        },
        "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:

Payout by using Gate

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 ECommPay URL, and receives a callback with the payment result. The full sequence of the payout process is provided below.



Figure: Payout by using Gate

  1. A customer orders a payout through the OVO Wallet method.
  2. Merchant's web service sends the request for the payout processing by using Gate to the appropriate ECommPay URL.
  3. Gate redirects the request to the ECommPay payment platform.
  4. The payment platform performs all the necessary checks and processes the request.
  5. The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
  6. The payment platform redirects the payout request to the provider service.
  7. The payout is processed on the provider side.
  8. The provider sends the result notification to the payment platform.
  9. The payment platform sends a callback with the payment result to the web service.
  10. The customer receives the notification about the payout result from the web service.

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

There are several things you must consider when using payout requests in the OVO Wallet method:
  1. You perform purchases 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:
    • Object general—general request identification information:
      • project_id—the project ID obtained from ECommPay
      • 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.
    • Object payment—payout information:
      • amount—payout amount in minor currency units. If the currency IDR is specified in the purchase request it is necessary to round the payment amount to an integer. If another currency is specified in the request, the payment amount is converted to an equivalent amount in the IDR currency on the ECommPay side and rounded up to an integer (for example, if the converted amount is 200,000.05 IDR, such an amount is rounded up to 200,001.00 IDR)
      • currency—payout currency in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—the ID of the customer within merchant project
      • first_name—first name
      • last_name—last name
      • ip_address—IP address
      • city—city
      • day_of_birth—day of birth
      • country—country in the ISO 3166-1 (alpha-2) format,
      • Object identify—customer identity document information:
        • doc_number—document number
        • doc_type—document type
        • doc_issue_country—an ISO 3166-1 (alpha-2) code of country that issued the document
    • Object account—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.

Thus, a correct payment request in the OVO Wallet method must include project and payment IDs, customer and account information, currency and amount of the payout, as well as signature, as shown in the following example:

Figure: Example of a payout request

{
    "general": {
    "project_id": 2853,
    "payment_id": "test-002",
    "signature": "M1vT4q9c8hA8xCjEwGFSAkn+aJmGA4jH6bgBOp8DTf8d/XdoV+vd7Q=="
  },
  "payment": {
    "amount": 10000,
    "currency": "IDR"
  },
  "customer": {
    "id": "payoutTest",
    "first_name": "Suharto",
    "last_name": "Yudhoyono",
    "ip_address": "114.124.147.206",
    "city": "Jakarta",
    "day_of_birth": "21-09-1983",
    "country": "ID",
    "identify": {
      "doc_number": "2101086512740000",
      "doc_type": "none",
      "doc_issue_country": "ID"
    }
  },
  "account": {
    "number": "081211111111"
  }
}

Callback format

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

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

Figure: Example of a successful payout callback

{
        "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.

Figure: Example of a declined payout callback

{
        "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:

Payouts by using Dashboard (Old Dashboard)

To make a payout through Dashboard (Old Dashboard), the merchant sends a request, and receives a notification with the request processing result. There are two ways to initiate payouts through Dashboard (Old Dashboard):
  • as a single payout—in this case, you must specify the currency and amount for a payout available for this method, and fill in all fields required on the Dashboard (Old Dashboard) interface in accordance with the selected payment method
  • as a part of a mass payment—in this case, all parameters are specified in a CSV file in accordance with the requirements in the Payouts by using Gate section (except for the signature)

Information about performed payouts is displayed in the Payments section of Dashboard (Old Dashboard).

More detailed information on the payout processing by using Dashboard (Old Dashboard) is provided in the Performing payouts section.

Analysis of payment results

As with other payment methods ECommPay offers, when using the OVO Wallet method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.

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 and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
  • 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 using the /operations/get queries.

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