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

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

Parameter

Data Type

M/O/C

Description

request

Alphanumeric

Request description

merchant_id

Numeric

Merchant Code from Faspay = BOI.

payment_channel

Numeric(3)

Channel code

phone_no

Numeric(12)

Customer phone number

cust_name

Alphanumeric

Customer name

signature

Alphanumeric

sha1(md5(user_id + password + phone_no))

<?xml version="1.0" encoding="UTF-8" ?>
<faspay>
    <request>Account Activation OVO OpenAPI</request>
    <merchant_id>99999</merchant_id>
    <payment_channel>720</payment_channel>
    <phone_no>081382826301</phone_no>
    <cust_name>Andrea Hinata</cust_name>
    <signature>1d4c5f7246a762c4ab61cd3d399efa4c28978bf3</signature>
</faspay>

{
  "request": "Account Activation OVO OpenAPI",
  "merchant_id": "99999",
  "payment_channel": "720",
  "phone_no": "081382826301",
  "cust_name": "Andrea Hinata",
  "signature": "1d4c5f7246a762c4ab61cd3d399efa4c28978bf3"
}

Activation Response

You will get the Activation Response following like below:

Parameter

Data Type

M/O/C

Description

response

Alphanumeric

response description

status

Alphanumeric

Status activation account

message

Alphanumeric

message response activation

redirectURL

Alphanumeric

URL redirection to fill in OTP and PIN fields.

Notes: Merchant has to redirect with client

side browser to this URL.

response_code

Numeric

Response code from sevice API

00: Success

01: Failed

response_desc

Alphanumeric

Response Description from response code

<?xml version="1.0" encoding="UTF-8"?>
<faspay>
     <response>Account Activation OVO Open API</response>
     <status>ALLOWED</status>
     <message>SUCCESS</message>
     <redirectURL>https://webview.byte-
stack.net/cellblockui/partner/activation?action=otpLinkage&ampauthType=2F
A&ampclient-
id=OAMERCHANTAB&ampphoneNumber=08138282%2A%2A%2A%2A&amprefId=0cdef070-
77e2-42e9-b365-
9a27bb2a0af5&amptoken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb2RlaGFzaC
I6Ik56QTFNRGxrTldZd05UUmxOR013TmprNU56bGhZVFF5TkRGa01UVXlPR1kiLCJyYW5kb20
iOiJOVGcxTmpFeU53IiwidmVyc2lvbiI6MX0.jiWSIoIZ8SfNEwvwX5Y57raYwg0RIfr3Wr3C
hyLwv7M&ampsubmissionType=redirect&ampdestination=https%3A%2F%2Fdebit-
staging.faspay.co.id%2Fpws%2Fovo_openapi%2Fcallback&ampstate=4f260f83e2fa
19f3cf51c082&amptheme=theme1</redirectURL>
     <response_code>00</response_code>
     <response_desc>Success</response_desc>
</faspay>

{
  "response": "Account Activation OVO Open API",
  "status": "ALLOWED",
  "message": "SUCCESS",
  "redirectURL": "https://webview.byte-stack.net/cellblockui/partner/activation?action=otpLinkage&ampauthType=2FA&ampclient-id=OAMERCHANTAB&ampphoneNumber=08138282%2A%2A%2A%2A&amprefId=0cdef070-77e2-42e9-b365-9a27bb2a0af5&amptoke=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb2RlaGFzaCI6Ik56QTFNRGxrTldZd05UUmxOR013TmprNU56bGhZVFF5TkRGa01UVXlPR1kiLCJyYW5kb20iOiJOVGcxTmpFeU53IiwidmVyc2lvbiI6MX0.jiWSIoIZ8SfNEwvwX5Y57raYwg0RIfr3Wr3ChyLwv7M&ampsubmissionType=redirect&ampdestination=https%3A%2F%2Fdebit-staging.faspay.co.id%2Fpws%2Fovo_openapi%2Fcallback&ampstate=4f260f83e2fa19f3cf51c082&amptheme=theme1",
  "response_code": "0",
  "response_desc": "Success"
}

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:

Parameter

Data Type

M/O/C

Description

response

Alphanumeric

Response description of the Service.

phone_number

Numeric

Phone number user

response_code

Numeric

Response code 00: Success

response_desc

Alphanumeric

Response description from response code.

<?xml version="1.0" encoding="UTF-8" ?>
<faspay>
    <response>Account Activation OVO OpenAPI</response>
    <phone_number>081234567891</phone_number>
    <response_code>00</response_code>
    <response_desc>success</response_desc>
</faspay>

{
  "response": "Account Activation OVO OpenAPI",
  "phone_number": "081234567891",
  "response_code": "00",
  "response_desc": "success"
}

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

Parameter

Data Type

M/O/C

Description

request

Alphanumeric

Request description of service

merchant_id

Numeric

Merchant code from Faspay = BOI.

bill_no

Numeric (32)

Order number

bill_desc

Alphanumeric

Bill description of transaction

bill_total

Numeric

Total nominal transaction

bill_currency

Numeric

Bill currency

payment_channel

Numeric

Payment channel code

phone_no

Numeric

Phone number customer

cust_name

Alphanumeric

Customer name

Alphanumeric

Email customer

pay_type

Numeric

Payment type:

0: Cash Only

1: Points Only

2: Cash & Point, priority Point

signature

Numeric

sha1(md5(user_id + password + phone_no))

<?xml version="1.0" encoding="UTF-8" ?>
<faspay>
	<request>Transfer OVO OpenAPI</request>
	<merchant_id>99999</merchant_id>
	<bill_no>123</bill_no>
	<bill_desc>prepaid credit transfer.</bill_desc>
	<bill_total>10000</bill_total>
	<bill_currency>IDR</bill_currency>
	<payment_channel>720</payment_channel>
	<phone_no>081382826301</phone_no>
	<cust_name>Andrea Hinata</cust_name>
	<email>andreahinata@email.com</email>
	<pay_type>0</pay_type>
	<signature>1d4c5f7246a762c4ab61cd3d399efa4c28978bf3</signature>
</faspay>

{
  "request": "Transfer OVO OpenAPI",
  "merchant_id": "99999",
  "bill_no": "123",
  "bill_desc": "prepaid credit transfer.",
  "bill_total": "10000",
  "bill_currency": "IDR",
  "payment_channel": "720",
  "phone_no": "081382826301",
  "cust_name": "Andrea Hinata",
  "email": "andreahinata@gmail.com",
  "pay_type": "0",
  "signature": "1d4c5f7246a762c4ab61cd3d399efa4c28978bf3"
}

You will get the payment response:

Parameter

Data Type

M/O/C

Description

response

Alphanumeric

Response description

redirectURL

Alphanumeric

URL redirection to fill in OTP and PIN fields.

Notes: Merchant has to redirect with client

side browser to this URL.

status

Alphanumeric

Status transaction

trx_id

Alphanumeric

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)

Order number

amount

Alphanumeric

Amount of transaction.

payment_day

Datetime

YYYY-MM-DD

HH:MM:SS (6)

Date of transaction

response_code

Numeric

Response code from service 00: Success 01: Failed

response_desc

Alphanumeric

Response description of response code.

<?xml version="1.0" encodin0g="UTF-8"?>
<faspay>
    <response>Transfer OVO Open API</response>
    <redirectURL>https://webview.byte-
stack.net/cellblockui/v2/paymentPin?clientTxnId=9999982980212147&ampactio
n=payment&ampclient-
id=OAMERCHANTAB&amptoken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb2RlaGF
zaCI6Ik9UUXdNems0TVRSak0yRmtOR0poTkdJNVlUYzVNbVZrTTJWbE1qaGxNVGciLCJyYW5k
b20iOiJOVGcxTmpJeE5RIiwidmVyc2lvbiI6MX0.fI9wW9ODfFoDpG1YhcZl7B8ntTG7uxS6e
AkEVZlYPgY&ampsubmissionType=redirect&ampdestination=https%3A%2F%2Fdebit-
staging.faspay.co.id%2Fpws%2Fovo_openapi%2Fcallback&ampstate=945b59559ca2
a45c9bc1a00c&amptheme=theme1</redirectURL>
    <status>PENDING</status>
    <trx_id>9999982980212147</trx_id>
    <bill_no>123</bill_no>
    <amount>100</amount>
    <payment_day>2021-11-11 11:26:42</payment_day>
    <response_code>00</response_code>
    <response_desc>Success</response_desc>
</faspay>

{
  "response": "Transfer OVO Open API",
  "redirectURL": "https://webview.byte-stack.net/cellblockui/v2/paymentPin?clientTxnId=9999982980212147&ampaction=payment&ampclient-id=OAMERCHANTAB&amptoken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb2RlaGFzaCI6Ik9UUXdNems0TVRSak0yRmtOR0poTkdJNVlUYzVNbVZrTTJWbE1qaGxNVGciLCJyYW5kb20iOiJOVGcxTmpJeE5RIiwidmVyc2lvbiI6MX0.fI9wW9ODfFoDpG1YhcZl7B8ntTG7uxS6eAkEVZlYPgY&ampsubmissionType=redirect&ampdestination=https%3A%2F%2Fdebit-staging.faspay.co.id%2Fpws%2Fovo_openapi%2Fcallback&ampstate=945b59559ca2a45c9bc1a00c&amptheme=theme1",
  "status": "PENDING",
  "trx_id": "9999982980212147",
  "bill_no": "123",
  "amount": "100",
  "payment_day": "2021-11-11 11:26:42",
  "response_code": "00",
  "response_desc": "Success"
}

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.

Parameter

Data Type

M/O/C

Description

request

Alphanumeric

Request description

merchant_id

Numeric

Merchant Code from Faspay = BOI.

bill_no

Numeric (32)

Order number

bill_desc

Alphanumeric

Bill description of transaction

bill_total

Numeric

Total nominal transaction

bill_currency

Numeric

Bill currency

payment_channel

Numeric

Payment channel code

phone_no

Numeric

Phone number customer

cust_name

Alphanumeric

Customer name

Alphanumeric

Email customer

pay_type

Numeric

Payment type:

0: Cash Only

1: Points Only

2: Cash & Point, priority Point

signature

Alphanumeric

sha1(md5(user_id + password + phone_no))

<?xml version="1.0" encoding="UTF-8" ?>
<faspay>
    <request>Transfer OVO OpenAPI</request>
    <merchant_id>99999</merchant_id>
    <bill_no>123</bill_no>
    <bill_desc>credit purchase transfer</bill_desc>
    <bill_total>10000</bill_total>
    <bill_currency>IDR</bill_currency>
    <payment_channel>720</payment_channel>
    <phone_no>081382826301</phone_no>
    <cust_name>Andrea Hinata</cust_name>
    <email>andreahinata@email.com</email>
    <pay_type>0</pay_type>
    <signature>1d4c5f7246a762c4ab61cd3d399efa4c28978bf3</signature>
</faspay>

{
  "request": "Transfer OVO OpenAPI",
  "merchant_id": "99999",
  "bill_no": "123",
  "bill_desc": "credit purchase transfer",
  "bill_total": "10000",
  "bill_currency": "IDR",
  "payment_channel": "720",
  "phone_no": "081382826301",
  "cust_name": "Andrea Hinata",
  "email": "andreahinata@gmail.com",
  "pay_type": "0",
  "signature": "1d4c5f7246a762c4ab61cd3d399efa4c28978bf3"
}

You will get the response:

Parameter

Data Type

M/O/C

Description

response

Alphanumeric

Response description

response_code

Numeric

Response code from sevice API

00: Success

01: Failed

02: Failed, please regenerate payment token

response_desc

Numeric

Response description of response code.

url

Alphanumeric

URL Direction to regenerate payment

tokens.

<?xml version="1.0" encoding="UTF-8"?>
<faspay>
    <response>Transfer OVO Open API</response>
    <response_code>02</response_code>
    <response_desc>Failed, please regenerate payment token</response_desc>
    <url>https://webview.byte-stack.net/cellblockui/v2/paymentPin?action=regeneratePayment&client-
id=OAMERCHANTAB&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb2RlaGFzaCI6Ik9XTXlNelJsWm1RMlpEZ3pOR1JpTm1FMFl6TmpNV1ptT0RJM1lqZ3lZelUiLCJyYW5kb20iOiJ
OVGt5TmpreU1RIiwidmVyc2lvbiI6MX0.gsoyoo-7CkQdeNAIaeWKlxd4fvwggHcoQcj_kjiaLXM&submissionType=redirect&state=1467becd
693e806472723795&destination=https%3A%2F%2Fdebit-dev.faspay.co.id%2Fpws%2Fovo_openapi%2Fcallback&theme=theme1
    </url>
</faspay>

{
  "response": "Transfer OVO Open API",
  "response_code": "02",
  "response_desc": "Failed, please regenerate payment token",
  "url": "https://webview.byte-stack.net/cellblockui/v2/paymentPin?action=regeneratePayment&client-id=OAMERCHANTAB&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb2RlaGFzaCI6Ik9XTXlNelJsWm1RMlpEZ3pOR1JpTm1FMFl6TmpNV1ptT0RJM1lqZ3lZelUiLCJyYW5kb20iOiJOVGt5TmpreU1RIiwidmVyc2lvbiI6MX0.gsoyoo-7CkQdeNAIaeWKlxd4fvwggHcoQcj_kjiaLXM&submissionType=redirect&state=a720b840be9f744f513e12ce&destination=https%3A%2F%2Fdebit-dev.faspay.co.id%2Fpws%2Fovo_openapi%2Fcallback&theme=theme1"
}

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

Parameter

Data Type

M/O/C

Description

request

Alphanumeric

Request description

merchant_id

Numeric

Merchant Code from Faspay = BOI.

merchant

Alphanumeric

Merchant Name

phone_no

Numeric

Customer phone number.

payment_channel

Numeric

OVO Tokenize channel Code.

signature

Alphanumeric

sha1(md5(user_id + password + phone_no))

<?xml version="1.0" encoding="UTF-8" ?>
<faspay>
    <request>Top Up Instruction OVO Open API</request>
    <merchant_id>99999</merchant_id>
    <merchant>FASPAY DEMO</merchant>
    <phone_no>081382826301</phone_no>
    <payment_channel>720</payment_channel>
    <signature>1d4c5f7246a762c4ab61cd3d399efa4c28978bf3</signature>
</faspay>

{
"request": "Top Up Instruction OVO Open API",
"merchant_id": "99999",
"merchant": "FASPAY DEMO",
"phone_no": "081382826301",
"payment_channel": "720",
"signature": "1d4c5f7246a762c4ab61cd3d399efa4c28978bf3"
}

You will get the top up instruction response:

Parameter

Data Type

M/O/C

Description

request

Alphanumeric

Response description.

merchant_id

Numeric

Merchant Code from Faspay = BOI.

phone_no

Alphanumeric

Customer phone number.

payment_channel

Numeric

OVO Tokenize channel Code.

merchant

Alphanumeric

Merchant name

topup_instruction

Array

Information on each type of top up

instruction.

instruction_1

Array

Detailed information for Top Up Instruction

option

Alphanumeric

Pilihan metode transaksi top up:

• ATM

• Internet/Mobile Banking

• Grab

• Tokopedia

• Merchan t/ Mitra OVO

icon

Alphanumeric

Url that displays the icon for each type of top up option

url

Alphanumeric

The link that will display the top up

instruction display.

response_code

Numeric

Response code from sevice API

00: Success

01: Failed

response_desc

Alphanumeric

Response description of response code.

<?xml version="1.0" encoding="UTF-8"?>
<faspay>
	<response>Top Up Instruction OVO Open API</response>
	<phone_no>081382826301</phone_no>
	<merchant_id>99999</merchant_id>
	<payment_channel>720</payment_channel>
	<merchant>FASPAY DEMO</merchant>
	<topup_instruction>
		<instruction_1>
			<option>ATM</option>
			<icon>https://images.ovo.id/fintech/topup/icons/ic_bank_topup.png</icon>
			<url>https://images.ovo.id/fintech/topup/topup_atm.html?20181102</url>
		</instruction_1>
		<instruction_2>
			<option>Internet / Mobile Banking</option>
			<icon>https://images.ovo.id/fintech/topup/icons/ic_mobile_bank_topup.png</icon>
			<url>https://images.ovo.id/fintech/topup/topup_mobile.html?20181102</url>
		</instruction_2>
		<instruction_3>
			<option>Grab</option>
			<icon>https://images.ovo.id/fintech/topup/icons/ic_grab.png</icon>
			<url>https://images.ovo.id/fintech/topup/topup_grab.html</url>
		</instruction_3>
		<instruction_4>
			<option>Tokopedia</option>
			<icon>https://images.ovo.id/fintech/topup/icons/ic_tokopedia.png</icon>
			<url>https://images.ovo.id/fintech/topup/topup_tokopedia.html</url>
		</instruction_4>
		<instruction_5>
			<option>Merchant / Mitra OVO</option>
			<icon>https://images.ovo.id/fintech/topup/icons/ic_merchant_topup.png</icon>
			<url>https://images.ovo.id/fintech/topup/topup_merchant.html?20181102</url>
		</instruction_5>
	</topup_instruction>
	<response_code>00</response_code>
	<response_desc>Success</response_desc>
</faspay>

{
  "response": "Top Up Instruction OVO Open API",
  "phone_no": "081382826301",
  "merchant_id": "99999",
  "payment_channel": "720",
  "merchant": "FASPAY DEMO",
  "topup_instruction": {
    "instruction_1": {
      "option": "ATM",
      "icon": "https://images.ovo.id/fintech/topup/icons/ic_bank_topup.png",
      "url": "https://images.ovo.id/fintech/topup/topup_atm.html?20181102"
    },
    "instruction_2": {
      "option": "Internet / Mobile Banking",
      "icon": "https://images.ovo.id/fintech/topup/icons/ic_mobile_bank_topup.png",
      "url": "https://images.ovo.id/fintech/topup/topup_mobile.html?20181102"
    },
    "instruction_3": {
      "option": "Grab",
      "icon": "https://images.ovo.id/fintech/topup/icons/ic_grab.png",
      "url": "https://images.ovo.id/fintech/topup/topup_grab.html"
    },
    "instruction_4": {
      "option": "Tokopedia",
      "icon": "https://images.ovo.id/fintech/topup/icons/ic_tokopedia.png",
      "url": "https://images.ovo.id/fintech/topup/topup_tokopedia.html"
    },
    "instruction_5": {
      "option": "Merchant / Mitra OVO",
      "icon": "https://images.ovo.id/fintech/topup/icons/ic_merchant_topup.png",
      "url": "https://images.ovo.id/fintech/topup/topup_merchant.html?20181102"
    }
  },
  "response_code": "00",
  "response_desc": "Success"
}

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

Parameter

Data Type

M/O/C

Description

request

Alphanumeric

Request description

merchant_id

Numeric

Merchant Code from Faspay = BOI.

payment_channel

Numeric

OVO Tokenize channel Code.

phone_no

Numeric

Customer phone number.

signature

Alphanumeric

sha1(md5(user_id + password + phone_no))

<faspay>
<request>Check Balance OVO OpenAPI</request>
<merchant_id>99999</merchant_id>
<payment_channel>720</payment_channel>
<phone_no>081382826301</phone_no>
<signature>1d4c5f7246a762c4ab61cd3d399efa4c28978bf3</signature>
</faspay>

{
"request": "Check Balance OVO OpenAPI",
"merchant_id": "99999",
"payment_channel": "720",
"phone_no": "081382826301",
"signature": "1d4c5f7246a762c4ab61cd3d399efa4c28978bf3"
}

You will get the response:

Parameter

Data Type

M/O/C

Description

response

Alphanumeric

Response description

phone_no

Alphanumeric

Customer phone number.

payment_channel

Alphanumeric

Code channel OVO Tokenize

merchant_id

Alphanumeric

Merchant Code from Faspay = BOI.

detail

Array

Detail of data balance channel

cash

Array

Amount of cash balance

points

Array

Number of points earned by the user

balance

Numeric

Amount balance.

response_code

Numeric

Response code from sevice API

00: Success

01: Failed

response_desc

Alphanumeric

Response description

<?xml version="1.0" encoding="UTF-8"?>
<faspay>
    <response>Check Balance OVO Open API</response>
    <phone_no>081382826301</phone_no>
    <payment_channel>720</payment_channel>
    <merchant_id>99999</merchant_id>
    <detail>
        <cash>
          <balance>1967700</balance>
        </cash>
        <points>
          <balance>2539434</balance>
        </points>
    </detail>
    <response_code>00</response_code>
    <response_desc>Success</response_desc>
</faspay>

{
"response": "Check Balance OVO Open API",
"phone_no": "081382826301",
"payment_channel": "720",
"merchant_id": "99999",
"detail": {
    "cash": {
        "balance": "1967700"
     },
    "points": {
        "balance": "2539434"
     }
},
"response_code": "00",
"response_desc": "Success"
}

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

Parameter

Data Type

M/O/C

Description

request

Alphanumeric

Request description

merchant_id

Numeric

Merchant code from Faspay = BOI.

merchant

Alphanumeric

Merchant name

phone_no

Numeric

Customer phone number

payment_channel

Numeric

Channel code of OVO

start_date

Datetime

YYYY-MM-DD

Start date that you want to view transactions for. starting from today or before from today.

end_date

Datetime

YYYY-MM-DD

The date until the last day you want to see the transaction history. End date it can from before today until today.

page

Numeric

Page of view history transaction.

limit

Numeric

Number of transactions history displayed

perpage

signature

Alphanumeric

sha1(md5(user_id + password +

phone_no))

<?xml version="1.0" encoding="UTF-8"?>
<faspay>
    <request>History OVO Open API</request>
    <merchant_id>99999</merchant_id>
    <merchant>FASPAY STORE</merchant>
    <phone_no>081382826301</phone_no>
    <payment_channel>720</payment_channel>
    <start_date>2021-11-11</start_date>
    <end_date>2021-11-11</end_date>
    <page>1</page>
    <limit>10</limit>
    <signature>1d4c5f7246a762c4ab61cd3d399efa4c28978bf3</signature>
</faspay>

{
  "request": "History OVO Open API",
  "merchant_id": "99999",
  "merchant": "FASPAY STORE",
  "phone_no": "081382826301",
  "payment_channel": "720",
  "start_date": "2021-11-11",
  "end_date": "2021-11-11",
  "page": "1",
  "limit": "10",
  "signature": "1d4c5f7246a762c4ab61cd3d399efa4c28978bf3"
}

You will get the response:

Parameter

Data Type

M/O/C

Description

response

Alphanumeric

Response description

phone_no

Numeric

Customer phone number

merchant_id

Numeric

Merchant code from Faspay = BOI.

payment_channel

Numeric

Channel code of OVO

merchant

Alphanumeric

Merchant name

list_transaction

Array

List history transaction customer.

transaction_(count)

Array

Number of list history transaction (example:

transaction_1, transaction_2)

payment_date

Datetime

YYYY-MM-DD

HH:MM:SS (6)

Payment date of transaction.

status

Alphanumeric

Status transaction.

trx_id

Numeric

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

Transaction amount total

amount_detail

Array

Detail amount

type

Alphanumeric

Type of transaction use Cash or Points

amt

Numeric

Amount alocation OVO

response_code

Numeric

Response code from sevice API

00: Success

01: Failed

response_desc

Alphanumeric

Response description of code response

<?xml version="1.0" encoding="UTF-8"?>
<faspay>
	<response>History OVO Open API</response>
	<phone_no>081382826301</phone_no>
	<merchant_id>99999</merchant_id>
	<payment_channel>720</payment_channel>
	<merchant>FASPAY STORE</merchant>
	<list_transaction>
		<transaction_1>
			<payment_date>2021-11-11 11:27:34</payment_date>
			<status>SUCCESS</status>
			<trx_id>9999982980212147</trx_id>
			<trx_amount>100</trx_amount>
			<amount_detail>
				<type>CASH</type>
				<amt>100</amt>
			</amount_detail>
		</transaction_1>
		<transaction_2>
			<payment_date>2021-11-11 10:57:31</payment_date>
			<status>SUCCESS</status>
			<trx_id>9999982903353426</trx_id>
			<trx_amount>100</trx_amount>
			<amount_detail>
				<type>CASH</type>
				<amt>100</amt>
			</amount_detail>
		</transaction_2>
		<transaction_3>
			<payment_date>2021-11-11 10:47:59</payment_date>
			<status>SUCCESS</status>
			<trx_id>9999982941269845</trx_id>
			<trx_amount>100</trx_amount>
			<amount_detail>
				<type>CASH</type>
				<amt>100</amt>
			</amount_detail>
		</transaction_3>
	</list_transaction>
	<list_refund/>
	<response_code>00</response_code>
	<response_desc>Sukses</response_desc>
</faspay>

{
  "response": "History OVO Open API",
  "phone_no": "081382826301",
  "merchant_id": "99999",
  "payment_channel": "720",
  "merchant": "FASPAY STORE",
  "list_transaction": {
    "transaction_1": {
      "payment_date": "2021-11-11 11:27:34",
      "status": "SUCCESS",
      "trx_id": "9999982980212148",
      "trx_amount": "100",
      "amount_detail": {
        "type": "CASH",
        "amt": "100"
      }
    },
    "transaction_2": {
      "payment_date": "2021-11-11 10:57:31",
      "status": "SUCCESS",
      "trx_id": "9999982903353426",
      "trx_amount": "100",
      "amount_detail": {
        "type": "CASH",
        "amt": "100"
      }
    },
    "transaction_3": {
      "payment_date": "2021-11-11 10:47:59",
      "status": "SUCCESS",
      "trx_id": "9999982941269844",
      "trx_amount": "100",
      "amount_detail": {
        "type": "CASH",
        "amt": "100"
      }
    }
  },
  "list_refund": "",
  "response_code": "00",
  "response_desc": "Success"
}

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

Parameter

Data Type

M/O/C

Description

request

Alphanumeric

Request description

merchant_id

Numeric

Merchant code from Faspay = BOI.

merchant

Alphanumeric

Merchant name

phone_no

Numeric

Customer phone number

payment_channel

Numeric

Channel code of OVO

signature

Alphanumeric

sha1(md5(user_id + password +

phone_no))

<?xml version="1.0" encoding="UTF-8"?>
<faspay>
	<request>Unlink OVO Open API</request>
	<merchant_id>99999</merchant_id>
	<merchant>FASPAY STORE</merchant>
	<phone_no>081382826301</phone_no>
	<payment_channel>720</payment_channel>
	<signature>1d4c5f7246a762c4ab61cd3d399efa4c28978bf3</signature>
</faspay>

{
"request": "Unlink OVO Open API",
"merchant_id": "99999",
"merchant": "FASPAY STORE",
"phone_no": "081382826301",
"payment_channel": "720",
"signature": "1d4c5f7246a762c4ab61cd3d399efa4c28978bf3"

PreviousShopeePay QRIS Integration Guide NextDANA Subs Integration Guide

Last updated 8 months ago