OVO Wallet

Overview

Introduction

OVO Wallet is a payment method which allows to process payments in Indonesian rupiahs by using e-wallets in Indonesia. This method supports purchases and payouts. Two channels can be used for purchase processing—channel 1 is performed without the redirection of the customer to the provider service, and channel 2 involves the redirection of the customer. For more information about the applicable processing channel, refer to your ecommpay key account manager.

This article provides information about working with the OVO Wallet method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

General information

Payment method type digital wallet payments
Payment instruments digital wallets
Countries and regions ID
Payment currencies IDR
Currency conversion on the ecommpay side
One-time purchases +
Credential-on-file purchases –
Full refunds –
Partial refunds –
Payouts +
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, otherwise the fractional part is severed during processing on the payment platform side. 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 to 1,000.00 IDR.
Obtaining access to the payment method and access fee refer to your ecommpay key account manager, additional information available in the ecommpay shop

Interaction diagram

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



Operations support

Various platform interfaces can be used to process payments and perform operations using the OVO Wallet method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links), payouts—by using Gate and Dashboard. At the same time, regardless of the interfaces used, the following properties and limitations are applicable.

When working with the OVO Wallet the following properties and limitations are applicable.

Amounts, IDR ¹ Times ²
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
Note:
  1. KYC or Know Your Customer is the process that allows organisations to verify clients and prevent frauds.
  2. The base and threshold times are defined as follows:
    • The base 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 web service. The base 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 the customer is required). Use the base time to estimate when to react to the absence of payment result callbacks or when to check payment status (details).
    • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the web service receives the callback with the payment result. A payment is automatically assigned the decline status if it wasn't processed within the threshold time. For individual customisation of the threshold time limit, contact ecommpay technical support.

Processing scenarios

A a purchase by using the OVO Wallet method can be processed with or without the redirection of the customer, while processing of a payout requires a notification of the customer via the web service.

Figure 1. Purchase by using Payment Page without the redirection of the customer
Figure 2. Purchase by using Payment Page with the redirection of the customer
Figure 3. Purchase by using Gate without the redirection of the customer
Figure 4. Purchase by using Gate with the redirection of the customer
Figure 5. Payout by using Gate

Scenarios for performing operations via the main interfaces of the payment platform correspond to those presented in the diagrams. Similarly, when additional features (such as payment links) are used, scenarios for performing operations also correspond to the specifics of those features.

Purchase by using Payment Page. Channel 1: without redirection of the customer

General information

To process a purchase through Payment Page by using the OVO Wallet method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.



Figure 6. Purchase processing by using Payment Page: step-by-step description
  1. A customer initiates a purchase in the web service.
  2. The web service sends the request for opening Payment Page to the specified ecommpay URL.
  3. The request for opening Payment Page is sent to the payment platform.
  4. The payment platform receives the request and validates the required parameters and signature.
  5. Payment Page is generated based on the project and 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 processes the request and sends it to the provider service.
  12. The 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 purchase is processed in the provider service.
  16. The provider service sends a notification about the result to the payment platform.
  17. The payment platform sends the payment result callback to the web service.
  18. The payment platform sends the result information to Payment Page.
  19. The result information is displayed to the customer on Payment Page.

Information about the formats of requests and callbacks used for processing payments by using the OVO Wallet method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

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

  1. The following parameters required for any payment must be specified:
    • project_id—project identifier obtained from ecommpay during integration
    • payment_id—payment identifier unique within the project
    • payment_currency—payment currency code in the ISO-4217 alpha-3 format
    • payment_amount—payment amount in the smallest currency unit
    • customer_id—customer identifier unique within the project
  2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
  3. 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 parameter is missing, the payment form may display the input field for entering the missing value (details are available in Submission of additional payment information).
  4. If you need to have the payment form displayed with the OVO Wallet method selected, set the force_payment_method parameter to ovo.
  5. Additionally, any other parameters available for working with Payment Page can be used (details).
  6. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the OVO Wallet method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier and account number, as well as signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "IDR",
   "customer_id": "customer1",
   "customer_account_number": "081211111111",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}
Figure 7. Example of sufficient data in a purchase request
{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "IDR",
   "customer_id": "customer1",
   "customer_account_number": "081211111111",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

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 information about a 10,000.00 IDR purchase made in the 239 project.

Figure 8. Example of callback data indicating that the purchase has been processed
{
        "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": "c66bf3ecb026e2c460712f2ed86f52-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": "ab51MI5wDVMO8j/9wTwpwD2COA1m8ZXXDceGoTLIxAaiZihRQ=="
    }

The following is the example of a callback with information about a declined purchase.

Figure 9. Example of callback data indicating that the purchase has been declined
{
        "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": "2b4241e02c5e1e5156d60a78591da0b4ca1-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": "aWYu87AYwb9Yd+oUMsLEJk9rMwRaLaT1mPiP36Q=="
    }

Useful links

The following articles can be useful when implementing purchases via Payment Page:

Purchase by using Payment Page. Channel 2: with redirection of the customer

General information

To process a purchase through Payment Page by using the OVO Wallet method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.

Figure 10. Purchase processing by using Payment Page: step-by-step description
  1. A customer initiates a purchase in the web service.
  2. The web service sends the request for opening Payment Page to the specified ecommpay URL.
  3. The request for opening Payment Page is sent to the payment platform.
  4. The payment platform receives the request and validates the required parameters and signature.
  5. Payment Page is generated based on the project and request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the OVO Wallet method.
  8. The payment platform receives the request for processing the payment by using the OVO Wallet method.
  9. The payment platform processes the request and sends it to the provider service.
  10. The request is processed on the provider service side.
  11. The data for redirecting the customer to the provider service is sent from the provider service to the payment platform.
  12. The data for redirecting the customer is sent from the payment platform to Payment Page.
  13. The customer is redirected to the provider service.
  14. The customer completes all required payment steps.
  15. The purchase is processed in the provider service.
  16. The result information is displayed to the customer in the provider service.
  17. The customer is redirected to Payment Page.
  18. The provider service sends a notification about the result to the payment platform.
  19. The payment platform sends the payment result callback to the web service.
  20. The payment platform sends the result information to Payment Page.
  21. The result information is displayed to the customer on Payment Page.

Information about the formats of requests and callbacks used for processing payments by using the OVO Wallet method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the OVO Wallet method:

  1. The following parameters required for any payment must be specified:
    • project_id—project identifier obtained from ecommpay during integration
    • payment_id—payment identifier unique within the project
    • payment_currency—payment currency code in the ISO-4217 alpha-3 format
    • payment_amount—payment amount in the smallest currency unit
    • customer_id—customer identifier unique within the project
  2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
  3. It is also necessary to specify the first and last names of the customer in the customer_first_name and customer_last_name parameters.
  4. If you need to have the payment form displayed with the OVO Wallet method selected, set the force_payment_method parameter to ovo.
  5. Additionally, any other parameters available for working with Payment Page can be used (details).
  6. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the OVO Wallet method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information, as well as signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "IDR",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_first_name": "Doe",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}
Figure 11. Example of sufficient data in a purchase request
{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "IDR",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_first_name": "Doe",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

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 information about a 10,000.00 IDR purchase made in the 239 project.

Figure 12. Example of callback data indicating that the purchase has been processed
{
        "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": "c66bf3ecb026e2c460712f2ed86f52-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": "ab51MI5wDVMO8j/9wTwpwD2COA1m8ZXXDceGoTLIxAaiZihRQ=="
    }

The following is the example of a callback with information about a declined purchase.

Figure 13. Example of callback data indicating that the purchase has been declined
{
        "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": "2b4241e02c5e1e5156d60a78591da0b4ca1-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": "aWYu87AYwb9Yd+oUMsLEJk9rMwRaLaT1mPiP36Q=="
    }

Useful links

The following articles can be useful when implementing purchases via Payment Page:

Purchase by using Gate. Channel 1: without redirection of the customer

General information

To process a purchase through Gate by using the OVO Wallet method, the merchant's web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ecommpay URL.
  2. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.



Figure 14. Purchase processing by using Gate: step-by-step description
  1. A customer initiates a purchase by using the OVO Wallet method in the web service.
  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.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it 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 purchase is processed in the provider service.
  11. The provider service sends the payment result notification to the payment platform.
  12. The payment platform sends the payment result callback to the web service.
  13. The customer receives the payment result information from the web service.

Information about the formats of requests and callbacks used for processing payments by using the OVO Wallet method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the OVO Wallet method:

  1. To initiate each purchase, send a separate POST request to the /v2/payment/wallet/ovo/sale endpoint. This endpoint belongs to the group /v2/payment/wallet/{payment_method}/sale.
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
    • Object payment—payment information:
      • amount—payment amount in the smallest currency unit
      • currency—payment currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payment
    • Object account—customer account information:
      • number—OVO account identifier (must consist of no more than 15 digits)
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the OVO Wallet method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer and account information, as well as signature.

{
    "general": {
        "project_id": 2373,
        "payment_id": "test123129",
        "signature": "6/E1dobuXL+JLua7pbgXm9QBqxv9JgM1EwBc3ovVQ=="
    },
    "payment": {
        "amount": 1000000,
        "currency": "IDR"
    },
    "account": {
        "number": "081211111111",
    },
    "customer": {
        "ip_address": "192.0.2.0",
        "id": "customer1"
    }
}
Figure 15. Example of sufficient data in 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": "192.0.2.0",
        "id": "customer1"
    }
}

Final 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 information about a 10,000.00 IDR purchase made in the 239 project.

Figure 16. Example of callback data indicating that the purchase has been processed
{
        "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": "c66bf3ecb026e2c460712f2ed86f52-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": "ab51MI5wDVMO8j/9wTwpwD2COA1m8ZXXDceGoTLIxAaiZihRQ=="
    }

The following is the example of a callback with information about a declined purchase.

Figure 17. Example of callback data indicating that the purchase has been declined
{
        "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": "2b4241e02c5e1e5156d60a78591da0b4ca1-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": "aWYu87AYwb9Yd+oUMsLEJk9rMwRaLaT1mPiP36Q=="
    }

Useful links

The following articles can be useful when implementing purchases via Gate:

Purchase by using Gate. Channel 2: with redirection of the customer

General information

To process a purchase through Gate by using the OVO Wallet method, the merchant's web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ecommpay URL.
  2. Receive an intermediate callback from the payment platform and redirect the customer to the OVO Wallet service.
  3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.

Figure 18. Purchase processing by using Gate: step-by-step description
  1. A customer initiates a purchase by using the OVO Wallet method in the web service.
  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.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the provider service.
  7. The request is processed on the provider service side.
  8. The provider service sends the redirection data to the payment platform.
  9. The payment platform sends the callback with the redirection data to the web service.
  10. The customer is redirected to the provider service.
  11. The customer completes all required payment steps.
  12. The purchase is processed in the provider service.
  13. The result is displayed to the customer.
  14. The customer is redirected to the web service.
  15. The provider service sends the payment result notification to the payment platform.
  16. The payment platform sends the payment result callback to the web service.
  17. The customer receives the payment result information from the web service.

Information about the formats of requests and callbacks used for processing payments by using the OVO Wallet method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the OVO Wallet method:

  1. To initiate each purchase, send a separate POST request to the /v2/payment/wallet/ovo/sale endpoint. This endpoint belongs to the group /v2/payment/wallet/{payment_method}/sale.
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
    • Object payment—payment information:
      • amount—payment amount in the smallest currency unit
      • currency—payment currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payment
      • first_name—customer first name
      • last_name—customer last name
    • Object return_url—contains the URLs to which customer is redirected during or after payment processing:
      • return—URL to return customer to the web service during any step before the payment is completed
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the OVO Wallet method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information, URL for redirection and signature.

{
    "general": {
        "project_id": 2373,
        "payment_id": "test123129",
        "signature": "6/E1dobuXL+JLua7pbgXm9QBqxv9JgM1EwBc3ovVQ=="
    },
    "payment": {
        "amount": 1000000,
        "currency": "IDR"
    },
    "customer": {
        "ip_address": "192.0.2.0",
        "id": "customer1",
        "first_name": "John",
        "last_name": "Doe"
    },
    "return_url": {
        "return": "https://example.com/return"
    }
}
Figure 19. Example of sufficient data in a purchase request
{
    "general": {
        "project_id": 2373,
        "payment_id": "test123129",
        "signature": "6/E1dobuXL+JLua7pbgXm9QBqxv9JgM1EwBc3ovVQ=="
    },
    "payment": {
        "amount": 1000000,
        "currency": "IDR"
    },
    "customer": {
        "ip_address": "192.0.2.0",
        "id": "customer1",
        "first_name": "John",
        "last_name": "Doe"
    },
    "return_url": {
        "return": "https://example.com/return"
    }
}

Formats of intermediate callbacks for customer redirection

Each payment made with the OVO Wallet method requires redirection of customers from the merchant's web service to the OVO Wallet service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the redirect_data object. The format of such callbacks is standard (details), and the following objects and parameters are included in the redirect_data object:

  • body—object with data to be sent in the request body
  • method—parameter specifying the HTTP method for sending the request (GET or POST)
  • url—parameter containing a link for redirection
Figure 20. redirect_data example
  "redirect_data": {
    "body": {},
    "method": "GET",
    "url": "https://www.example.com/pay"
  }

Final 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 information about a 10,000.00 IDR purchase made in the 239 project.

Figure 21. Example of callback data indicating that the purchase has been processed
{
        "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": "c66bf3ecb026e2c460712f2ed86f52-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": "ab51MI5wDVMO8j/9wTwpwD2COA1m8ZXXDceGoTLIxAaiZihRQ=="
    }

The following is the example of a callback with information about a declined purchase.

Figure 22. Example of callback data indicating that the purchase has been declined
{
        "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": "2b4241e02c5e1e5156d60a78591da0b4ca1-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": "aWYu87AYwb9Yd+oUMsLEJk9rMwRaLaT1mPiP36Q=="
    }

Useful links

The following articles can be useful when implementing purchases via Gate:

Payouts by using Gate

General information

To process a payout through Gate by using the OVO Wallet method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of payout processing are provided below.



Figure 23. Payout processing by using Gate: step-by-step description
  1. A customer initiates a payout by using the OVO Wallet method in the web service.
  2. The web service sends the request for processing the payout by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the provider service.
  7. The payout is processed on the side of the provider service.
  8. The provider service sends the result notification to the payment platform.
  9. The payment platform sends the result callback to the web service.
  10. The customer receives the payout result information from the web service.

Information about the formats of requests and callbacks used for processing payouts by using the OVO Wallet method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending payout requests by using the OVO Wallet method:

  1. To initiate each payout send a separate POST request to the /v2/payment/wallet/ovo/payout endpoint. This endpoint belongs to the group /v2/payment/wallet/{payment_method}/payout.
  2. Each request must include the following objects and parameters:
    • Object general—general payout information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) details
    • Object payment—payment information:
      • amount—payout amount in the smallest currency unit
      • currency—payout currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payout
    • Object account—customer account information:
      • number—OVO account identifier (must consist of no more than 15 digits)
      • customer_name—full customer name
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct payout request by using the OVO Wallet method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information, as well as account number and signature.

{
    "general": {
    "project_id": 2853,
    "payment_id": "test-002",
    "signature": "M1vT4q9c8hA8xCjEwGFSaJmGA4jH6bgBOp8DTf8d/XdoV+vd7Q=="
  },
  "payment": {
    "amount": 10000,
    "currency": "IDR"
  },
  "customer": {
    "id": "payoutTest",
    "ip_address": "192.0.2.0"
  },
  "account": {
    "number": "081211111111",
    "customer_name": "John Doe"
  }
}
Figure 24. Example of sufficient data in a purchase request
{
    "general": {
    "project_id": 2853,
    "payment_id": "test-002",
    "signature": "M1vT4q9c8hA8xCjEwGFSaJmGA4jH6bgBOp8DTf8d/XdoV+vd7Q=="
  },
  "payment": {
    "amount": 10000,
    "currency": "IDR"
  },
  "customer": {
    "id": "payoutTest",
    "ip_address": "192.0.2.0"
  },
  "account": {
    "number": "081211111111",
    "customer_name": "John Doe"
  }
}

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 information about a 10,000.00 IDR payout made in the 239 project.

Figure 25. Example of callback data indicating that the payout has been processed
{
        "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": "5b164bbb212ec90b6a9d528a-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+r0aEd5Z2SG+p3iVVEsoDnp+2YyQ=="
    }

The following is the example of a callback with information about a declined payout.

Figure 26. Example of callback data indicating that the payout has been declined
{
        "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": "2d61a5909869b06bc48025f68-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": "WEXldjWeZfui3XJcSvHXmgxnALsxX/8UTQF7DkNPT0oQ=="
    }

Useful links

The following articles can be useful when implementing payouts via Gate:

Payouts by using Dashboard

When working with Dashboard, you can process single and mass payouts by using the OVO Wallet method.

  • To process a single payout, open the payout form, specify all required parameters (including the payment method), send a request and verify that the payout has been processed.

  • To process a mass payout, prepare and upload a file with information about all target payouts, send a batch request, and verify that the payouts have been processed.

    Use a CSV file structured according to the requirements presented in the Mass payments data section. The payout parameters must comply with the requirements (you do not have to generate a signature because it is specified by Dashboard).

More information about processing payouts by using Dashboard is presented in a separate section.

Analysis of payment results

To analyse information about payments made with the OVO Wallet method and other methods, you can use:

  • Dashboard interface toolkit with various lists and analytic panels.
  • Reports in CSV file format, available via the Reports section (one-time and periodically).
  • Data in JSON format, sent by program requests to a specified URL available by using the Data API interface.

If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.