OVO Tokenize Integration Guide

OVO Tokenize is one of Faspay Collection's products which is a digital financial service that makes it easier for users to transaction online at Merchant. This Ovo Tokenize can be embedded directly on the Merchant store application/website, and the Customer can directly pay the bill through the merchant.

The integration process of OVO will be explained below.

Integration Step

1. Activation

2. Callback Activation

3. Payment

4. Payment Notification

5. Top Up Instruction

6. General API:

   1. Check Balance

   2. History Transaction

   3. Unlink

1. Activation

This API service is designed to enable the activation of user (customer) accounts, allowing them to be seamlessly integrated into the merchant's website or application. This integration enables customers to make direct payments for transactions on the merchant's page.

URL EndPoint

Environment	XML	JSON
Development	https://debit- sandbox.faspay.co.id/pws/100037/183xx00010100000/	https://debit- sandbox.faspay.co.id/cvr/100037/10

Body Parameter

Parameter	Data Type	M/O/C	Description
request	Alphanumeric	O	Request description
merchant_id	Numeric	M	Merchant Code from Faspay = BOI.
payment_channel	Numeric(3)	M	Channel code
phone_no	Numeric(12)	M	Customer phone number
cust_name	Alphanumeric	M	Customer name
signature	Alphanumeric	M	sha1(md5(user_id + password + phone_no))

Sample Code - XML

Sample Code - JSON

Activation Response

You will get the Activation Response following like below:

Parameter body

Parameter	Data Type	M/O/C	Description
response	Alphanumeric	O	response description
status	Alphanumeric	M	Status activation account
message	Alphanumeric	M	message response activation
redirectURL	Alphanumeric	M	URL redirection to fill in OTP and PIN fields. Notes: Merchant has to redirect with client side browser to this URL.
response_code	Numeric	M	Response code from sevice API 00: Success 01: Failed
response_desc	Alphanumeric	M	Response Description from response code

Sample Code - XML

Sample Code - JSON

2. Callback Activation

This API service is designed to send notifications to the merchant's server, informing them about the status of the user's account activation, whether it has succeeded or failed.

URL Endpoint

For Endpoint URL, from the merchant side specifying.

Example:

<url-merchant>/callback/linkageovo

Method: GET

You will get the callback activation response:

Body Parameter

Parameter	Data Type	M/O/C	Description
response	Alphanumeric	O	Response description of the Service.
phone_number	Numeric	M	Phone number user
response_code	Numeric	M	Response code 00: Success
response_desc	Alphanumeric	M	Response description from response code.

Sample Code - XML

Sample Code - JSON

3. Payment

This API service is designed to handle transactions made by customers using the OVO Tokenize payment method.

URL Endpoint

Environment	XML	JSON
Development	https://debit- sandbox.faspay.co.id/pws/100038/189xx00010100000/	https://debit- sandbox.faspay.co.id/cvr/100038/10

Method: POST

Body Parameter

Parameter	Data Type	M/O/C	Description
request	Alphanumeric	O	Request description of service
merchant_id	Numeric	M	Merchant code from Faspay = BOI.
bill_no	Numeric (32)	M	Order number
bill_desc	Alphanumeric	M	Bill description of transaction
bill_total	Numeric	M	Total nominal transaction
bill_currency	Numeric	M	Bill currency
payment_channel	Numeric	M	Payment channel code
phone_no	Numeric	M	Phone number customer
cust_name	Alphanumeric	M	Customer name
email	Alphanumeric	M	Email customer
pay_type	Numeric	M	Payment type: 0: Cash Only 1: Points Only 2: Cash & Point, priority Point
signature	Numeric	M	sha1(md5(user_id + password + phone_no))

Sample Code Request - XML

Sample Code Response - JSON

You will get the payment response:

Body Parameter

Parameter	Data Type	M/O/C	Description
response	Alphanumeric	O	Response description
redirectURL	Alphanumeric	M	URL redirection to fill in OTP and PIN fields. Notes: Merchant has to redirect with client side browser to this URL.
status	Alphanumeric	M	Status transaction
trx_id	Alphanumeric	M	Transaction ID (Issued/generated by Faspay (Media Indonusa)) Notes: Unique Transaction ID for 1 day or as long as it hasn't been paid and hasn't expired.
bill_no	Numeric (32)	M	Order number
amount	Alphanumeric	M	Amount of transaction.
payment_day	Datetime YYYY-MM-DD HH:MM:SS (6)	M	Date of transaction
response_code	Numeric	M	Response code from service 00: Success 01: Failed
response_desc	Alphanumeric	M	Response description of response code.

Sample Code Response - XML

Sample Code Response - JSON

3.1 Payment Token Expired

Abnormal conditions occur when the payment token has passed the given time period (Expired) or the customer updates the phone number in OVO app or it could be from the customer breaking the linkage from partner app.

Body Parameter

Parameter	Data Type	M/O/C	Description
request	Alphanumeric	O	Request description
merchant_id	Numeric	M	Merchant Code from Faspay = BOI.
bill_no	Numeric (32)	M	Order number
bill_desc	Alphanumeric	M	Bill description of transaction
bill_total	Numeric	M	Total nominal transaction
bill_currency	Numeric	M	Bill currency
payment_channel	Numeric	M	Payment channel code
phone_no	Numeric	M	Phone number customer
cust_name	Alphanumeric	M	Customer name
email	Alphanumeric	M	Email customer
pay_type	Numeric	M	Payment type: 0: Cash Only 1: Points Only 2: Cash & Point, priority Point
signature	Alphanumeric	M	sha1(md5(user_id + password + phone_no))

Sample Code Request - XML

Sample Code Request - JSON

You will get the response:

Body Parameter

Parameter	Data Type	M/O/C	Description
response	Alphanumeric	O	Response description
response_code	Numeric	M	Response code from sevice API 00: Success 01: Failed 02: Failed, please regenerate payment token
response_desc	Numeric	M	Response description of response code.
url	Alphanumeric	M	URL Direction to regenerate payment tokens.

Sample Code Response - XML

Sample Code Response - JSON

4. Payment Notification

Payment notification from Faspay to Merchant backend will also be triggered in the event of transaction status getting updated, to ensure the merchant is securely informed. Please provide the URL and make sure it's registered on the Faspay system. The detailed API reference can be found here.

5. Top Up Instruction

This API service shows the content of Top Up instructions if the User/Customer wants to make a Top Up transaction.

URL Endpoint

Environment	XML	JSON
Development	https://debit- sandbox.faspay.co.id/pws/100042/183xx00010100000/	https://debit- sandbox.faspay.co.id/cvr/100042/10

Method: POST

Body Parameter

Parameter	Data Type	M/O/C	Description
request	Alphanumeric	O	Request description
merchant_id	Numeric	M	Merchant Code from Faspay = BOI.
merchant	Alphanumeric	M	Merchant Name
phone_no	Numeric	M	Customer phone number.
payment_channel	Numeric	M	OVO Tokenize channel Code.
signature	Alphanumeric	M	sha1(md5(user_id + password + phone_no))

Sample Code Request - XML

Sample code Request - JSON

You will get the top up instruction response:

Body Parameter

Parameter	Data Type	M/O/C	Description
request	Alphanumeric	O	Response description.
merchant_id	Numeric	M	Merchant Code from Faspay = BOI.
phone_no	Alphanumeric	M	Customer phone number.
payment_channel	Numeric	M	OVO Tokenize channel Code.
merchant	Alphanumeric	M	Merchant name
topup_instruction	Array	M	Information on each type of top up instruction.
instruction_1	Array	M	Detailed information for Top Up Instruction
option	Alphanumeric	M	Pilihan metode transaksi top up: • ATM • Internet/Mobile Banking • Grab • Tokopedia • Merchan t/ Mitra OVO
icon	Alphanumeric	M	Url that displays the icon for each type of top up option
url	Alphanumeric	M	The link that will display the top up instruction display.
response_code	Numeric	M	Response code from sevice API 00: Success 01: Failed
response_desc	Alphanumeric	M	Response description of response code.

Sample Code Response - XML

Sample Code Response - JSON

6. General API

6.1 Check Balance

The General API service checks customer balances for OVO cash and OVO Points.

URL Endpoint

Environment	XML	JSON
Development	https://debit- sandbox.faspay.co.id/pws/100039/183xx00010100000/	https://debit- sandbox.faspay.co.id/cvr/100039/10

Method: POST

Body Parameter

Parameter	Data Type	M/O/C	Description
request	Alphanumeric	O	Request description
merchant_id	Numeric	M	Merchant Code from Faspay = BOI.
payment_channel	Numeric	M	OVO Tokenize channel Code.
phone_no	Numeric	M	Customer phone number.
signature	Alphanumeric	M	sha1(md5(user_id + password + phone_no))

Sample Code Request - XML

Sample Code Request - JSON

You will get the response:

Body Parameter

Parameter	Data Type	M/O/C	Description
response	Alphanumeric	O	Response description
phone_no	Alphanumeric	M	Customer phone number.
payment_channel	Alphanumeric	M	Code channel OVO Tokenize
merchant_id	Alphanumeric	M	Merchant Code from Faspay = BOI.
detail	Array	M	Detail of data balance channel
cash	Array	M	Amount of cash balance
points	Array	M	Number of points earned by the user
balance	Numeric	M	Amount balance.
response_code	Numeric	M	Response code from sevice API 00: Success 01: Failed
response_desc	Alphanumeric	M	Response description

Sample Code Response - XML

Sample Code Response - JSON

6.2 History Transaction

In the General API service, this function is to check mutations or customer transaction history using the OVO Tokenize payment channel.

URL Endpoint

Environment	XML	JSON
Development	https://debit- sandbox.faspay.co.id/pws/100041/183xx00010100000/	https://debit- sandbox.faspay.co.id/cvr/100041/10

Method: POST

Body Parameter

Parameter	Data Type	M/O/C	Description
request	Alphanumeric	O	Request description
merchant_id	Numeric	M	Merchant code from Faspay = BOI.
merchant	Alphanumeric	M	Merchant name
phone_no	Numeric	M	Customer phone number
payment_channel	Numeric	M	Channel code of OVO
start_date	Datetime YYYY-MM-DD	M	Start date that you want to view transactions for. starting from today or before from today.
end_date	Datetime YYYY-MM-DD	M	The date until the last day you want to see the transaction history. End date it can from before today until today.
page	Numeric	M	Page of view history transaction.
limit	Numeric	M	Number of transactions history displayed perpage
signature	Alphanumeric	M	sha1(md5(user_id + password + phone_no))

Sample Code Request - XML

Sample Code Request - JSON

You will get the response:

Body Parameter

Parameter	Data Type	M/O/C	Description
response	Alphanumeric	O	Response description
phone_no	Numeric	M	Customer phone number
merchant_id	Numeric	M	Merchant code from Faspay = BOI.
payment_channel	Numeric	M	Channel code of OVO
merchant	Alphanumeric	O	Merchant name
list_transaction	Array	M	List history transaction customer.
transaction_(count)	Array	M	Number of list history transaction (example: transaction_1, transaction_2)
payment_date	Datetime YYYY-MM-DD HH:MM:SS (6)	M	Payment date of transaction.
status	Alphanumeric	M	Status transaction.
trx_id	Numeric	M	Transaction ID (Issued/generated by Faspay (Media Indonusa)) Notes: Unique Transaction ID for 1 day or as long as it hasn't been paid and hasn't expired.
trx_amount	Numeric	M	Transaction amount total
amount_detail	Array	M	Detail amount
type	Alphanumeric	M	Type of transaction use Cash or Points
amt	Numeric	M	Amount alocation OVO
response_code	Numeric	M	Response code from sevice API 00: Success 01: Failed
response_desc	Alphanumeric	M	Response description of code response

Sample Code Response - XML

Sample Code Response - JSON

6.3 Unlink

In the OVO General API service, this function is to disconnect OVO customer account embedded in the previously connected Merchant web/application.

URL Endpoint

Environment	XML	JSON
Development	https://debit- sandbox.faspay.co.id/pws/100040/183xx00010100000/	https://debit- sandbox.faspay.co.id/cvr/100040/10

Method: POST

Body Parameter

Parameter	Data Type	M/O/C	Description
request	Alphanumeric	O	Request description
merchant_id	Numeric	M	Merchant code from Faspay = BOI.
merchant	Alphanumeric	M	Merchant name
phone_no	Numeric	M	Customer phone number
payment_channel	Numeric	M	Channel code of OVO
signature	Alphanumeric	M	sha1(md5(user_id + password + phone_no))

Sample Code Request - XML

Sample Code Request - JSON