Faspay

https://docs.faspay.co.id
Admin
Faspay is an online payment gateway provider that simplifies payment processing for merchants,...
Tokens:223,135
Snippets:655
Trust Score:8.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Faspay Callback Activation API Endpoint Example

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/e-money-channel-integration-guide/ovo-tokenize-integration-guide

Example of a merchant-defined URL endpoint for receiving Faspay Callback Activation notifications, typically using a GET method.

```Plaintext
<url-merchant>/callback/linkageovo

Method: GET
```

--------------------------------

### Faspay Post Data Transaction Request Examples

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/online-credit-channel-integration-guide

These JSON examples illustrate the structure and parameters required for the 'Post Data Transaction' API call to Faspay. Each example showcases different payment channels and specific parameter usages, such as the `reserve2` field for Kredivo installment options or `bill_miscfee` for additional charges.

```JSON
{
   "request": "Post Data Transaction",
   "merchant_id": "99999",
   "merchant": "Sophia Store",
   "bill_no": "20201222022336",
   "bill_reff": "20200324_02-2286704_336",
   "bill_date": "2020-12-19 06:04:29",
   "bill_expired": "2020-12-19 07:04:29",
   "bill_desc": "Payment Online Via Faspay",
   "bill_currency": "IDR",
   "bill_gross": "100000",
   "bill_miscfee": "0",
   "bill_total": "100000",
   "cust_no": "01",
   "cust_name": "John Doe",
   "payment_channel": "709",
   "pay_type": "01",
   "msisdn": "8562927907",
   "email": "[email protected]",
   "terminal": "10",
   "billing_name": "John Doe",
   "billing_lastname": "Doe",
   "billing_address": "Jl Sabang 37",
   "billing_address_city": "Jakarta",
   "billing_address_region": "DKI Jakarta",
   "billing_address_state": "Indonesia",
   "billing_address_poscode": "10170",
   "billing_address_country_code": "ID",
   "receiver_name_for_shipping": "John Doe",
   "shipping_lastname": "Doe",
   "shipping_address": "Jl. Sabang 37",
   "shipping_address_city": "Jakarta",
   "shipping_address_region": "DKI Jakarta",
   "shipping_address_state": "Indonesia",
   "shipping_address_poscode": "10170",
   "item": {
      "id": "A001",
      "product": "Iphone 12",
      "qty": "1",
      "amount": "100000",
      "type": "Smartphone",
      "merchant_id":"K0001",
      "url": "https://your_website/merchant",
      "image_url": "https://your_image_url/image.jpg"
   },
   "reserve1": "",
   "reserve2": "30_Days",
   "signature": "5dd15c6075d976608e9961b95202e80ba08dbed7"
}
```

```JSON
{
   "request": "Post Data Transaction",
   "merchant_id": "99999",
   "merchant": "Sophia Store",
   "bill_no": "20201222022648",
   "bill_reff": "20200324_02-2286704_336",
   "bill_date": "2020-12-19 06:04:29",
   "bill_expired": "2020-12-19 07:04:29",
   "bill_desc": "Payment Online Via Faspay",
   "bill_currency": "IDR",
   "bill_gross": "100000",
   "bill_miscfee": "100000",
   "bill_total": "200000",
   "cust_no": "01",
   "cust_name": "John Doe",
   "payment_channel": "807",
   "pay_type": "01",
   "msisdn": "8562927907",
   "email": "[email protected]",
   "terminal": "10",
   "billing_name": "John Doe",
   "billing_lastname": "Doe",
   "billing_address": "Jl Sabang 37",
   "billing_address_city": "Jakarta",
   "billing_address_region": "DKI Jakarta",
   "billing_address_state": "Indonesia",
   "billing_address_poscode": "10170",
   "billing_address_country_code": "ID",
   "receiver_name_for_shipping": "John Doe",
   "shipping_lastname": "Doe",
   "shipping_address": "Jl. Sabang 37",
   "shipping_address_city": "Jakarta",
   "shipping_address_region": "DKI Jakarta",
   "shipping_address_state": "Indonesia",
   "shipping_address_poscode": "10170",
   "shipping_msisdn": "0881712345678",
   "item": {
      "product": "Invoice #2286704",
      "qty": "1",
      "amount": "100000",
      "merchant_id":"A0001",
      "payment_plan":"01",
      "tenor":"00"
   },
   "reserve1": "",
   "reserve2": "",
   "signature": "163c0950b2aa74a510f899da7c5379257a462ab7"
}
```

```JSON
{
  "request": "Post Data Transaction",
  "merchant_id": "33521",
  "merchant": "Sophia Store",
  "bill_no": "20201222022844",
  "bill_reff": "20200324_02-2286704_336",
  "bill_date": "2022-04-12 06:04:29",
  "bill_expired": "2022-04-13 07:04:29",
  "bill_desc": "Payment Online Via Faspay",
  "bill_currency": "IDR",
  "bill_gross": "200000000",
  "bill_miscfee": "100000",
  "bill_total": "200100000",
  "cust_no": "01",
  "cust_name": "John Doe",
  "payment_channel": "820",
  "pay_type": "01",
  "msisdn": "8562927907",
  "email": "[email protected]",
  "terminal": "10",
  "billing_name": "John Doe",
  "billing_lastname": "Doe",
  "billing_address": "Jl Sabang 37",
  "billing_address_city": "Jakarta",
  "billing_address_region": "DKI Jakarta"
}
```

--------------------------------

### Example Faspay Callback Request Body JSON

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/faspay-billing-api/callback

An illustrative JSON payload demonstrating a typical Faspay callback notification, showing the expected format and sample values for each parameter.

```json
{
  "billing_id": 1057,
  "service_id": 6,
  "transaction_number": "1233989228221148",
  "billing_total": "10000",
  "signature": "f4ebe62839b2d446ed13b3ca28f819a9ac0baa0a",
  "billing_status": "PAID",
  "payment_id": "1606804843001326",
  "payment_amount": "10000",
  "payment_method": "PERMATA VA",
  "payment_date": "2020-12-01 13:22:11"
}
```

--------------------------------

### Faspay ShopeePay QRIS Redirect Type XML Response (Partial)

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/e-money-channel-integration-guide/shopeepay-qris-integration

A partial example of the post-data response structure for ShopeePay QRIS transactions using the Redirect Type model in XML format. This snippet shows the initial elements of the response, including transaction and merchant details, indicating the start of a redirect flow.

```XML
<?xml version="1.0" encoding="UTF-8" ?>
<faspay>
        <response> Purchase Details Transmission</response>
        <trx_id>9999971150758059</trx_id>
        <merchant_id>99999</merchant_id>
        <merchant>FASPAY DEMO</merchant>
```

--------------------------------

### Faspay Sample Response in XML

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/route-payment/post-data-transaction

An example of a successful Faspay API response payload formatted in XML, demonstrating the structure and typical values for various parameters including transaction details, bill items, and routing information. This sample illustrates the expected output for a payment details inquiry.

```XML
<?xml version="1.0" encoding="UTF-8" ?>
 <faspay>
     <response>Payment Details</response>
     <trx_id>8504999946414145</trx_id>
     <merchant_id>99999</merchant_id>
     <merchant>FASPAY</merchant>
     <bill_no>9333300199999123456</bill_no>
     <external_id></external_id>
     <bill_item>
         <product>Invoice</product>
         <qty>1</qty>
         <amount>1000000</amount>
         <tenor>0</tenor>
         <payment_plan>1</payment_plan>
         <merchant_id>99999</merchant_id>
     </bill_item>
     <response_code>00</response_code>
     <response_desc>Sukses</response_desc>
     <route>
         <owner>26100253</owner>
     </route>
     <route>
         <partner_id>29195827</partner_id>
         <partner_amount>500000</partner_amount>
     </route>
     <route>
         <partner_id>29200008</partner_id>
         <partner_amount>500000</partner_amount>
     </route>
     <redirect_url>https://debit-staging.faspay.co.id/pws/100003/0830000010100000/ca1ed7300c72b8b14bc503826d0f54db8ed1a8b8?trx_id=8504999946414145&merchant_id=99999&bill_no=9333300199999123456</redirect_url>
 </faspay>
```

--------------------------------

### Inquiry Transaction API Endpoint Example

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/features/static-transaction

This snippet provides an example of the HTTP GET request used to perform an inquiry transaction. It specifies the base URL, path, and a query parameter for the inquiry type.

```APIDOC
GET https://url_merchant/va_static/signature?type=inquiry
```

--------------------------------

### Faspay ShopeePay QRIS Direct Type Response Examples

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/e-money-channel-integration-guide/shopeepay-qris-integration

Illustrates the complete post-data response structure for ShopeePay QRIS transactions using the Direct Type model, provided in both XML and JSON formats. These examples include details about the transaction, merchant, and bill items, along with QR code related URLs and content for direct display.

```XML
<?xml version="1.0" encoding="UTF-8"?>
<faspay>
	<response>Purchased Details Transmission</response>
	<trx_id>1999971167165382</trx_id>
	<merchant_id>99999</merchant_id>
	<merchant>FASPAY DEMO</merchant>
	<bill_no>849389422312</bill_no>
	<bill_items>
		<id>123</id>
		<product>Glass Plastic</product>
		<qty>1</qty>
		<amount>10000</amount>
		<payment_plan>01</payment_plan>
		<merchant_id>99999</merchant_id>
		<tenor>00</tenor>
		<type>Furniture</type>
		<url>http://localhost:8088/index</url>
		<image_url>https://cdn.mos.cms.futurecdn.net/Mffc35PH77Dq7USrHb4qNm-1200-80.jpg</image_url>
	</bill_items>
	<bill_items>
		<id>234</id>
		<product>Plastic Bucket</product>
		<qty>1</qty>
		<amount>10000</amount>
		<payment_plan>01</payment_plan>
		<merchant_id>99999</merchant_id>
		<tenor>00</tenor>
		<type>Furniture</type>
		<url>http://localhost:8088/kredivo</url>
		<image_url>https://cdn.mos.cms.futurecdn.net/Mffc35PH77Dq7USrHb4qNm-1200-80.jpg</image_url>
	</bill_items>
	<response_code>00</response_code>
	<response_desc>Success</response_desc>
	<web_url>https://mapi.gw.uat.airpay.co.id/v3/merchant-host/qr/download?qr=oVS1YffoM8BHY1b86hgqGcdPpkW4wpN4ExEuVWIJiZ</web_url>
	<alt_url>https://debit-urgent-staging.faspay.co.id/__assets/qr/99999-1999971167165382.png</alt_url>
	<qr_content>00020101021226560016ID.CO.SHOPEE.WWW011893600918000000026602032660303UBE5204123453033605406100.005802ID5912Faspay Store6015KOTA JAKARTA SE610512345622805241999971167165382-667171363041C94</qr_content>
</faspay>
```

```JSON
{
    "response": "Purchased Detail Transmission",
    "trx_id": 1999971167165382,
    "merchant_id": 99999,
    "merchant": "FASPAY DEMO",
    "bill_no": 849389422312,
    "bill_items": [
      {
        "id": 123,
        "product": "Glass Plastic",
        "qty": 1,
        "amount": 10000,
        "payment_plan": 1,
        "merchant_id": 99999,
        "tenor": 0,
        "type": "Furniture",
        "url": "http://localhost:8088/index",
        "image_url": "https://cdn.mos.cms.futurecdn.net/Mffc35PH77Dq7USrHb4qNm-1200-80.jpg"
      },
      {
        "id": 234,
        "product": "Plastic Bucket",
        "qty": 1,
        "amount": 10000,
        "payment_plan": 1,
        "merchant_id": 99999,
        "tenor": 0,
        "type": "Furniture",
        "url": "http://localhost:8088/kredivo",
        "image_url": "https://cdn.mos.cms.futurecdn.net/Mffc35PH77Dq7USrHb4qNm-1200-80.jpg"
      }
    ],
    "response_code": 0,
    "response_desc": "Success",
    "web_url": "https://mapi.gw.uat.airpay.co.id/v3/merchant-host/qr/download?qr=oVS1YffoM8BHY1b86hgqGcdPpkW4wpN4ExEuVWIJiZ",
    "alt_url": "https://debit-urgent-staging.faspay.co.id/__assets/qr/99999-1999971167165382.png",
    "qr_content": "00020101021226560016ID.CO.SHOPEE.WWW011893600918000000026602032660303UBE5204123453033605406100.005802ID5912Faspay Store6015KOTA JAKARTA SE610512345622805241999971167165382-667171363041C94"
  }
```

--------------------------------

### Example Faspay API Response for Successful Request

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/snap/snap-direct-debit

An example JSON payload demonstrating a successful API response from Faspay, including transaction details, reference numbers, and a web redirect URL for further processing.

```JSON
{
    "responseMessage": "Request has been processed successfully",
    "referenceNo": "9999972270967929",
    "partnerReferenceNo": "2020102900000000000008",
    "webRedirectUrl":"https://debit-staging.faspay.co.id/pws/100003/0830000010100000/f6b92da317d40ffbc40c98ffa80cc924d7b35dd5?trx_id=9999972270967929&merchant_id=99999&bill_no=2020102900000000000008",
    "additionalInfo":
    {
        "merchantId": "99999",
        "amount":
        {
            "value": "100.00",
            "currency": "IDR"
        }
    }
}
```

--------------------------------

### Sample XML Request for Faspay Post Data Transaction

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/e-money-channel-integration-guide/dana-subs-integration-guide

An example XML payload demonstrating the structure for submitting a Post Data Transaction Request to the Faspay system. This snippet includes various transaction, customer, billing, and shipping details, providing a practical reference for developers integrating with the Faspay API.

```XML
<?xml version="1.0" encoding="UTF-8" ?>
<faspay>
  <request>Transmission of Purchase Detail Info</request>
  <merchant_id>99999</merchant_id>
  <merchant>Sophia Store</merchant>
  <bill_no>84938942</bill_no>
  <bill_reff>20200324_02-2286704_336</bill_reff>
  <bill_date>2021-12-30 10:00:00</bill_date>
  <bill_expired>2021-12-31 12:04:10</bill_expired>
  <bill_desc>Payment #12345678</bill_desc>
  <bill_currency>IDR</bill_currency>
  <bill_gross>0</bill_gross>
  <bill_tax>0</bill_tax>
  <bill_miscfee>0</bill_miscfee>
  <bill_total>10000</bill_total>
  <cust_no>1</cust_no>
  <cust_name>John Doe</cust_name>
  <cust_lastname>Doe</cust_lastname>
  <payment_channel>722</payment_channel>
  <pay_type>1</pay_type>
  <bank_userid></bank_userid>
  <msisdn></msisdn>
  <email></email>
  <terminal>10</terminal>
  <billing_name>John</billing_name>
  <billing_lastname>0</billing_lastname>
  <billing_address>jalan pintu air raya</billing_address>
  <billing_address_city>Jakarta Pusat</billing_address_city>
  <billing_address_region>DKI Jakarta</billing_address_region>
  <billing_address_state>Indonesia</billing_address_state>
  <billing_address_poscode>10710</billing_address_poscode>
  <billing_msisdn>8766688686</billing_msisdn>
  <billing_address_country_code>ID</billing_address_country_code>
  <receiver_name_for_shipping>John Doe</receiver_name_for_shipping>
  <shipping_lastname></shipping_lastname>
  <shipping_address>jalan pintu air raya</shipping_address>
  <shipping_address_city>Jakarta Pusat</shipping_address_city>
  <shipping_address_region>DKI Jakarta</shipping_address_region>
  <shipping_address_state>Indonesia</shipping_address_state>
</faspay>
```

--------------------------------

### Faspay E-Wallet Transfer 200 OK Response Example

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/sendme/e-wallet-top-up/transfer-top-up

An example JSON response for a successful e-wallet transfer operation, showing the structure and typical values returned by the Faspay API upon a 200 OK status.

```JSON
{
 "virtual_account": "9920011089",
 "beneficiary_account": "081234567890",
 "beneficiary_name": "Johnny Suh",
 "beneficiary_bank_code": "ovo",
 "beneficiary_region_code": "0102",
 "beneficiary_country_code": "ID",
 "beneficiary_purpose_code": "1",
 "beneficiary_phone": "",
 "beneficiary_email": "[email protected]",
 "trx_no": "12345670096",
 "trx_date": "2021-06-29 11:15:00",
 "instruct_date": "",
 "trx_amount": 2000000,
 "trx_desc": "Top-Up E-Wallet OVO",
 "callback_url": "http://account-service/account/api/mail/sendtotele",
 "trx_id": 1246279,
 "trx_reff": "ITxD7wMZ68cAaFNZQQOM",
 "status": "1",
 "message": "On Process",
 "response_code": "00",
 "response_desc": "success"
}
```

--------------------------------

### Faspay Transaction XML Structure Example

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/e-money-channel-integration-guide/shopeepay-qris-integration

This XML snippet illustrates a typical Faspay transaction structure, detailing bill information, individual product items, and the expected response codes and redirect URLs. It serves as an example for data exchange in XML format.

```XML
<bill_no>163b4ef032520a7.07128111</bill_no>
<bill_items>
	<id>01</id>
	<product>Glass Plastic</product>
	<qty>1</qty>
	<amount>1000000</amount>
	<payment_plan>01</payment_plan>
	<merchant_id>99999</merchant_id>
	<tenor>00</tenor>
	<type>Furniture</type>
	<url>http://localhost</url>
	<image_url>https://cdn.mos.cms.futurecdn.net/Mffc35PH77Dq7USrHb4qNm-1200-80.jpg</image_url>
</bill_items>
<response_code>00</response_code>
<response_desc>Success</response_desc>
<redirect_url>https://web.faspay.co.id/pws/100003/2830000010100000/92fb23821115e920a979b3c28ea969d98ac76497?trx_id=9999971150758059&merchant_id=99999&bill_no=163b4ef032520a7.07128111
</redirect_url>
```

--------------------------------

### Faspay Transaction Request JSON Example

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/features/static-transaction/bni-va-static-integration

A JSON example showing the complete structure for posting transaction data to Faspay, including merchant, billing, shipping, and item details for a payment request.

```JSON
{
  "request": "Post Data Transaction",
  "merchant_id": 99999,
  "merchant": "Sophia Store",
  "bill_no": "9881236312345696",
  "bill_reff": "9881236312345696",
  "bill_date": "2021-10-28 00:19:00",
  "bill_expired": "2021-10-29 00:19:00",
  "bill_desc": "BNI Virtual Account Method",
  "bill_currency": "IDR",
  "bill_gross": "0",
  "bill_tax": "0",
  "bill_miscfee": "0",
  "bill_total": 1000000,
  "cust_no": "5002",
  "cust_name": "John Doe",
  "cust_lastname": "Doe",
  "payment_channel": "801",
  "pay_type": "1",
  "bank_userid": "",
  "msisdn": "",
  "email": "[email\u00a0protected]",
  "terminal": "10",
  "billing_name": "John Doe",
  "billing_lastname": "Doe",
  "billing_address": "jalan pintu air raya",
  "billing_address_city": "Jakarta Pusat",
  "billing_address_region": "DKI Jakarta",
  "billing_address_state": "Indonesia",
  "billing_address_poscode": "10710",
  "billing_msisdn": "856123456789",
  "billing_address_country_code": "ID",
  "receiver_name_for_shipping": "Andreas Wira",
  "shipping_lastname": "Wira",
  "shipping_address": "jalan pintu air raya",
  "shipping_address_city": "Jakarta Pusat",
  "shipping_address_region": "DKI Jakarta",
  "shipping_address_state": "",
  "shipping_address_poscode": "10710",
  "shipping_msisdn": "856123456789",
  "shipping_address_country_code": "ID",
  "item": [
    {
     "qty": "8",
     "amount": "500000",
      "type": "Smartphone"
    },
    {
      "qty": "1",
      "amount": "500000",
      "type": "Smartphone"
    }
  ],
  "reserve1": "",
  "reserve2": "",
  "signature": "d848063d9836c20cf0055d70bd7e862e5f991688"
}
```

--------------------------------

### Example Faspay Callback URL

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/url-callback-return-url

An example of a callback URL that Faspay might hit, demonstrating the structure and parameters passed upon transaction completion to notify the merchant.

```HTTP
https://merchant_url.com/thankyou?trx_id=8985999990013136&merchant_id=99999&merchant=FASPAY+STORE&bill_no=4370&bill_ref=4370&bill_total=10000&bank_user_name=FaspayTest&status=0&signature=0da33ad07fe9980f7b7ff70a964803e821a86866
```

--------------------------------

### Faspay API Response Header Example

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/snap/snap-virtual-account

An example of an HTTP response header from Faspay API, showing Content-type and X-TIMESTAMP. This provides a clear illustration of the expected header structure in API responses.

```HTTP
Content-type: application/json
X-TIMESTAMP: 2020-12-21T10:30:34+07:00
```

--------------------------------

### Faspay Static Transaction Request XML Example

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/features/static-transaction/bnc-va-static-integration

Provides an example XML payload for submitting a static transaction request to the Faspay API, demonstrating the structure and typical values for various transaction parameters.

```XML
<faspay>
  <request>Transmission of Purchase Detail Info</request>
  <merchant_id>99999</merchant_id>
  <merchant>Sophia Store</merchant>
  <bill_no>9022222298758909234</bill_no>
  <bill_reff>fspytrx</bill_reff>
  <bill_date>2022-07-01 10:00:00</bill_date>
  <bill_expired>2022-07-21 06:04:10</bill_expired>
  <bill_desc>Payment #12345678</bill_desc>
  <bill_currency>IDR</bill_currency>
  <bill_gross>0</bill_gross>
  <bill_tax>0</bill_tax>
  <bill_miscfee>0</bill_miscfee>
  <bill_total>1000000</bill_total>
  <cust_no>1</cust_no>
  <cust_name>John Doe</cust_name>
  <cust_lastname>Doe</cust_lastname>
  <payment_channel>718</payment_channel>
  <pay_type>1</pay_type>
  <bank_userid></bank_userid>
  <msisdn></msisdn>
  <email></email>
  <terminal>10</terminal>
  <billing_name>John Doe</billing_name>
  <billing_lastname>Doe</billing_lastname>
  <billing_address>jalan pintu air raya</billing_address>
  <billing_address_city>Jakarta Pusat</billing_address_city>
  <billing_address_region>DKI Jakarta</billing_address_region>
  <billing_address_state>Indonesia</billing_address_state>
  <billing_address_poscode>10710</billing_address_poscode>
  <billing_msisdn>08766688686</billing_msisdn>
  <billing_address_country_code>ID</billing_address_country_code>
  <receiver_name_for_shipping>John Doe</receiver_name_for_shipping>
  <shipping_lastname></shipping_lastname>
  <shipping_address>jalan pintu air raya</shipping_address>
  <shipping_address_city>Jakarta Pusat</shipping_address_city>
  <shipping_address_region>DKI Jakarta</shipping_address_region>
  <shipping_address_state>Indonesia</shipping_address_state>
  <shipping_address_poscode>10710</shipping_address_poscode>
  <shipping_msisdn>08766688686</shipping_msisdn>
  <shipping_address_country_code>ID</shipping_address_country_code>
  <reserve1>0</reserve1>
  <reserve2></reserve2>
</faspay>
```

--------------------------------

### Sample Response Payloads for Faspay Top Up Instruction

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/e-money-channel-integration-guide/ovo-tokenize-integration-guide

Provides example response bodies in both XML and JSON formats from the Faspay Top Up Instruction API. These samples illustrate the detailed top-up options and status information returned by the service.

```XML
<?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>
```

```JSON
{
  "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"
}
```

--------------------------------

### Sample Request Payloads for Faspay Top Up Instruction

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/e-money-channel-integration-guide/ovo-tokenize-integration-guide

Provides example request bodies in both XML and JSON formats for the Faspay Top Up Instruction API. These samples demonstrate the correct structure and typical values for all required parameters, aiding in quick implementation.

```XML
<?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>
```

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

--------------------------------

### Faspay Xpress API Documentation

Source: https://docs.faspay.co.id/getting-started/untitled/how-to-use/create-billing-system

Covers the Xpress API, specifically detailing Xpress Version 4 for streamlined payment processes.

```APIDOC
Xpress:
  Xpress Version 4
```

--------------------------------

### Faspay Credit Card Transaction Response Payload Example

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/credit-card-transaction/additional-api-integration/server-callback-url-notification-credit-card

An example of the data structure returned by the Faspay API after a credit card transaction. It includes details such as card type, partial card number, bank response codes, authorization ID, and installment information, providing a comprehensive overview of the transaction outcome.

```APIDOC
    [EXCEED_HIGH_RISK] => No
    [CARDTYPE] => V
    [CARD_NO_PARTIAL] => 413718xxxxxx3783
    [CARDNAME] => tes
    [is_on_us] => Yes
    [ACQUIRER_BANK] => 016
    [WHITELIST_CARD] => No
    [BANK_RES_CODE] => 00
    [BANK_RES_MSG] => APPROVED OR COMPLETED
    [AUTH_ID] => 657399
    [BANK_REFERENCE] => 12902
    [INSTALLMENT_CODE] => 
    [INSTALLMENT_TERM] => 0
    [INSTALLMENT_MONTHLY] => 0.00
    [INSTALLMENT_LAST] => 0.00
    [popupProceed] => Click here to proceed
```

--------------------------------

### Faspay Account Activation API Request Body Examples

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/e-money-channel-integration-guide/ovo-tokenize-integration-guide

Sample request bodies for the Faspay Account Activation API in XML and JSON formats, demonstrating how to structure the activation payload.

```XML
<?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>
```

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

--------------------------------

### Faspay Account Activation API Response Body Examples

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/e-money-channel-integration-guide/ovo-tokenize-integration-guide

Sample response bodies for the Faspay Account Activation API in XML and JSON formats, showing successful activation and redirection details.

```XML
<?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=2FA&ampclient-id=OAMERCHANTAB&ampphoneNumber=08138282%2A%2A%2A%2A&amprefId=0cdef070-77e2-42e9-b365-9a27bb2a0af5&amptoken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb2RlaGFzaCI6Ik56QTFNRGxrTldZd05UUmxOR013TmprNU56bGhZVFF5TkRGa01UVXlPR1kiLCJyYW5kb20iOiJOVGcxTmpFeU53IiwidmVyc2lvbiI6MX0.jiWSIoIZ8SfNEwvwX5Y57raYwg0RIfr3Wr3ChyLwv7M&ampsubmissionType=redirect&ampdestination=https%3A%2F%2Fdebit-staging.faspay.co.id%2Fpws%2Fovo_openapi%2Fcallback&ampstate=4f260f83e2fa19f3cf51c082&amptheme=theme1</redirectURL>
     <response_code>00</response_code>
     <response_desc>Success</response_desc>
</faspay>
```

```JSON
{
  "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.eyJjb2RlaGFzaCI6Ik56QTFNRGxrTldZd05UUmxOR013TmprNU56bGhZVFF5TkRGa01UVXlPR1kiLCJyYW5kb20iOiJOVGcxTmpFeU53IiwidmVyc2lvbiI1MX0.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"
}
```

--------------------------------

### Faspay Online Debit: Post Data Transaction Response

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/online-debit/b-secure

Example JSON response received after successfully posting a data transaction to Faspay. It contains transaction details, response codes, and a crucial redirect URL for the customer to complete the payment.

```JSON
{
   "response": "Transmission of Purchase Detail Info",
   "trx_id": "9999981000005892",
   "merchant_id": "99999",
   "merchant": "Sophia Store",
   "bill_no": "20201222114107",
   "bill_items": {
      "id": "A001",
      "product": "Invoice #2286704",
      "qty": "1",
      "amount": "100000",
      "payment_plan": "01",
      "merchant_id": "99999",
      "tenor": "00"
   },
   "response_code": "00",
   "response_desc": "Success",
   "redirect_url" : "https://dev.faspay.co.id/pws/100003/0830000010100000/4e73de7139cd0c00466a4db93fdf1407a17a5670?trx_id=9999981000005892&merchant_id=99999&bill_no=20201222114107"
}
```

--------------------------------

### Faspay SendMe API for Fund Transfers

Source: https://docs.faspay.co.id/getting-started/untitled/how-to-use/create-billing-system

Provides comprehensive documentation for the SendMe API, covering account registration, confirmation, fund transfers, name and balance inquiries, transaction mutations, status checks, notifications, error codes, and functionalities for cash-out and e-wallet top-ups.

```APIDOC
SendMe:
  Register Account
  Confirmation Register Account
  Transfer
  Inquiry Name
  Inquiry Balance
  Mutasi
  Inquiry Status
  Notification / Callback
  Error Code And Response Code
  APPENDIX
  Cash Out:
    ATM Permata Cash Out
    Alfamart Cash Out
    Indomaret Cash Out
  E-Wallet (Top Up):
    Inquiry Name
    Transfer (Top Up)
```

--------------------------------

### Faspay Post Data Transaction Response

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/e-money-channel-integration-guide/dana-integration

Example JSON response received from Faspay after a successful post data transaction request. This response contains the transaction ID, merchant details, bill information, and the crucial redirect URL for the customer.

```JSON
{
   "response": "Transmission of Purchase Detail Info",
   "trx_id": "9999981900021790",
   "merchant_id": "99999",
   "merchant": "Sophia Store",
   "bill_no": "20201222023626",
   "bill_items": {
      "id": "A001",
      "product": "Invoice #2286704",
      "qty": "1",
      "amount": "100000",
      "payment_plan": "01",
      "merchant_id": "99999",
      "tenor": "00"
   },
   "response_code": "00",
   "response_desc": "Success",
   "redirect_url" : "https://dev.faspay.co.id/pws/100003/0830000010100000/7ad74a4aa1c86aeb1308ea5c44e4aa0f4d6ed4e7?trx_id=9999981900021790&merchant_id=99999&bill_no=20201222023626"
}
```

--------------------------------

### Sample Faspay OVO Tokenize Payment Request Body

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/e-money-channel-integration-guide/ovo-tokenize-integration-guide

Provides example request bodies for the Faspay OVO Tokenize payment API, demonstrating the structure and values for both XML and JSON formats. These examples illustrate how to construct a payment initiation request.

```XML
<?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>[email protected]</email>
	<pay_type>0</pay_type>
	<signature>1d4c5f7246a762c4ab61cd3d399efa4c28978bf3</signature>
</faspay>
```

```JSON
{
  "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": "[email protected]",
  "pay_type": "0",
  "signature": "1d4c5f7246a762c4ab61cd3d399efa4c28978bf3"
}
```

--------------------------------

### Faspay Request Signature Generation

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/route-payment/post-data-transaction

Illustrates the formula and a concrete example for generating the 'signature' parameter required for Faspay API requests. The signature is calculated using SHA1 and MD5 hashing of the merchant's user ID, password, and the bill number.

```Pseudocode
$signature : sha1(md5(($user_id.$pass.$bill_no)));
Sample signature: sha1(md5("bot310001p@ssw0rd310001zx")) = e0ba1b2dc29ab4cb4221df092f44b1c4e6f45c63
```

--------------------------------

### Faspay Unicount Dinamis: Post Data Transaction Request Example

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/features/unicount

This JSON payload illustrates the structure for initiating a dynamic Unicount transaction with Faspay. It includes essential merchant and bill details, customer information, and specifies '410' as the payment channel for Unicount.

```JSON
{
   "request": "Post Data Transaction",
   "merchant_id": "99999",
   "merchant": "Sophia Store",
   "bill_no": "20201219060429",
   "bill_reff": "20200324_02-2286704_336",
   "bill_date": "2020-12-19 06:04:29",
   "bill_expired": "2020-12-19 07:04:29",
   "bill_desc": "Payment Online Via Faspay",
   "bill_currency": "IDR",
   "bill_gross": "100000",
   "bill_miscfee": "100000",
   "bill_total": "200000",
   "cust_no": "01",
   "cust_name": "John Doe",
   "payment_channel": "410",
   "pay_type": "01",
   "msisdn": "8562927907",
   "email": "[email protected]",
   "terminal": "10",
   "billing_address": "Jl Sabang 37",
   "billing_address_city": "Jakarta",
   "billing_address_region": "DKI Jakarta",
   "billing_address_state": "Indonesia",
   "billing_address_poscode": "10170",
   "billing_address_country_code": "ID",
   "receiver_name_for_shipping": "John Doe",
   "shipping_address": "Jl. Sabang 37",
   "shipping_address_city": "Jakarta",
   "shipping_address_region": "DKI Jakarta",
   "shipping_address_state": "Indonesia",
   "shipping_address_poscode": "10170",
   "item": {
      "id": "A001",
      "product": "Invoice #2286704",
      "qty": "1",
      "amount": "100000",
      "payment_plan": "01",
      "merchant_id":"99999",
      "tenor": "00"
   },
   "reserve1": "",
   "reserve2": "",
   "signature": "8a5fc4e99a402e94f107118ac5ea4abbfc60e1d4"
}
```

--------------------------------

### Faspay Route Payment API Endpoints

Source: https://docs.faspay.co.id/getting-started/untitled/how-to-use/create-billing-system

Documents the Route Payment API, covering post data transactions, generating QRIS, creating virtual accounts, and direct debit operations for flexible payment routing.

```APIDOC
Route Payment:
  Post Data Transaction
  SNAP Generate QRIS
  SNAP Create Virtual Account
  SNAP Direct Debit
```

--------------------------------

### Faspay Virtual Account Inquiry Sample Request

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/route-payment/snap-inquiry-static-va

An example JSON payload demonstrating a typical request to the Faspay Virtual Account inquiry endpoint.

```json
{
    "partnerServiceId": "  88899",
    "customerNo": "12345678901234567890",
    "virtualAccountNo": "  08889912345678901234567890",
    "inquiryRequestId": "abcdef-123456-abcdef"
}
```

--------------------------------

### Faspay ShopeePay Post Data Transaction Request Example

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/e-money-channel-integration-guide/shopeepay-jump-app-integration

This JSON object represents the payload sent from the merchant's backend to Faspay to initiate a ShopeePay transaction. It includes merchant details, bill information, customer data, and item specifics required for the payment.

```json
{
   "request": "Post Data Transaction",
   "merchant_id": "99999",
   "merchant": "Sophia Store",
   "bill_no": "20201222024626",
   "bill_reff": "20200324_02-2286704_336",
   "bill_date": "2020-12-19 06:04:29",
   "bill_expired": "2020-12-19 07:04:29",
   "bill_desc": "Payment Online Via Faspay",
   "bill_currency": "IDR",
   "bill_gross": "100000",
   "bill_miscfee": "100000",
   "bill_total": "200000",
   "cust_no": "01",
   "cust_name": "John Doe",
   "payment_channel": "713",
   "pay_type": "01",
   "msisdn": "8562927907",
   "email": "[email\u00a0protected]",
   "terminal": "10",
   "billing_address": "Jl Sabang 37",
   "billing_address_city": "Jakarta",
   "billing_address_region": "DKI Jakarta",
   "billing_address_state": "Indonesia",
   "billing_address_poscode": "10170",
   "billing_address_country_code": "ID",
   "receiver_name_for_shipping": "John Doe",
   "shipping_address": "Jl. Sabang 37",
   "shipping_address_city": "Jakarta",
   "shipping_address_region": "DKI Jakarta",
   "shipping_address_state": "Indonesia",
   "shipping_address_poscode": "10170",
   "item": {
      "id": "A001",
      "product": "Invoice #2286704",
      "qty": "1",
      "amount": "100000",
      "payment_plan": "01",
      "merchant_id":"99999",
      "tenor": "00"
   },
   "reserve1": "",
   "reserve2": "",
   "signature": "676a826d180a0a6cad33ff58c09a2377893850ca"
}
```

--------------------------------

### Faspay Cancel Subscription Response Sample Payloads

Source: https://docs.faspay.co.id/merchant-integration/api-reference-1/debit-transaction/e-money-channel-integration-guide/dana-subs-integration-guide

Illustrative examples of the Faspay Cancel Subscription Response payload in both XML and JSON formats, showing typical values for a successful cancellation. These samples help developers understand the expected structure and content of the API response.

```XML
<faspay>
        <response>Canceling Payment</response>
        <subscription_id>20220920111315800000DANAW3ID708600245077</subscription_id>
        <merchant_id>99999</merchant_id>
        <merchant>Sophia Store</merchant>
        <bill_no>9881236390987599</bill_no>
        <subs_status_code>2</subs_status_code>
        <subs_status_desc>Inactive</subs_status_desc>
        <payment_cancel>Out of Stock</payment_cancel>
        <payment_cancel_date>2022-10-10 10:00:00</payment_cancel_date>
        <response_code>00</response_code>
        <response_desc>Success</response_desc>
</faspay>
```

```JSON
{
  "response": "Canceling Payment",
  "subscription_id": "20220920111315800000DANAW3ID708600245077",
  "merchant_id": "99999",
  "merchant": "Sophia Store",
  "bill_no": "9881236390987600",
  "subs_status_code": "2",
  "subs_status_desc": "Inactive",
  "payment_cancel": "Out Of Stock",
  "payment_cancel_date": "2022-10-10 10:00:00",
  "response_code": "00",
  "response_desc": "Success"
}
```
Tokens:
Raw