From 8050c8a3396d82d73dbdfd72f4733a374a89cb21 Mon Sep 17 00:00:00 2001
From: Muhammad Harits Arrazi <m.harits7@gmail.com>
Date: Fri, 15 Mar 2024 11:17:00 +0700
Subject: [PATCH] Add full name params to request/response of some api

---
 source/includes/_payment_routing.md |  4 +++-
 source/includes/static_va.md.erb    | 27 ++++++++++++++++++++++-----
 2 files changed, 25 insertions(+), 6 deletions(-)

diff --git a/source/includes/_payment_routing.md b/source/includes/_payment_routing.md
index a04c579d..da55add7 100644
--- a/source/includes/_payment_routing.md
+++ b/source/includes/_payment_routing.md
@@ -294,7 +294,8 @@ Endpoint:
 | need_frontend | Boolean     |  TRUE | -| Partner need UI or not, if true, we will route to payment link, otherwise will be route to API-based solution. |
 | list_enable_payment_method | String; comma separated     |  TRUE | - | To configure payment methods to be enabled in the payment method page.  |
 | list_enable_sof | String; comma separated      |  TRUE | - | To configure list of source of fund (banks or ewallets) to be enabled in the payment method page. For additional detail please refer to [List Allowed Payment Methods and SOF](https://api-docs.oyindonesia.com/#if-need_frontend-true-list-of-allowed-payment-methods-and-sof) |
-| sender_email | String     |  FALSE | - | Email of sender |
+| sender_email | String     |  CONDITIONAL | - | Email of sender. Required when creating VA from mandiri(008), permata(013) or cimb(022). |
+| full_name | String       | CONDITIONAL | - | Fill with the name of end-user that will pay this transaction. Required when creating VA from mandiri(008), permata(013) or cimb(022). |
 | receive_amount | Numeric     |  TRUE | - | The amount of a transaction to be paid, min. amount is 10000, except if you use unique code BCA which has min. amount 11000 or CARDS which has min. amount 15000 |
 | va_display_name | String     |  FALSE | Partner's brand name | Display name for VA that will be displayed once user do inquiry. If empty VA name will be set using partner brand name. This parameter will be used only if you use BANK_TRANSFER payment method and routed to VA. |
 | trx_expiration_time | Date string; yyyy-mm-dd hh:mm:ss format (UTC+7)    |  FALSE | Refer to [Default Expiration Time](https://api-docs.oyindonesia.com/#transaction-expiration-time-guidelines-create-and-update-payment-routing) | Set expiration time of transaction. Please refer to [Transaction Expiration Time Guidelines](https://api-docs.oyindonesia.com/#transaction-expiration-time-guidelines-create-and-update-payment-routing) |
@@ -329,6 +330,7 @@ Endpoint:
 |ewallet_url|String| For `use_linked_account: true`: URL that prompt user to input PIN to authorize Direct Payment. For `use_linked_account: false`: A deep link URL that allows user to access the specific e-wallet vendor's application for making a payment. Currently, only Linkaja, ShopeePay and Dana are supported options. This attribute will only be present if the request parameter 'need_frontend' is set to 'FALSE' and the payment method selected is 'EWALLET'.|
 |cards_url|String| URL that allows user to make payment using their Credit Card. This attribute will only be present if the request parameter 'need_frontend' is set to 'FALSE' and the payment method selected is 'CARDS'.|
 |unique_code_detail|Object|Contains two objects of number: `amount` which is the requested amount and `unique_code` which is the generated 3 digits unique code ; conditional, only exist if request need_frontend is FALSE and payment_method is BANK_TRANSFER and you use unique code BCA.|
+full_name | String(255) | If `full_name` is needed when creating the transaction, the inputted `full_name` value at creation will be shown here.|
 
 <aside class="warning">
 Note: For payments and inquiries involving a BSI VA using BSI Mobile or Banking Syariah Indonesia Net, please only input the last 12 digits of the va_number (remove 6059 from the va_number with format "6059xxxxxxxxxxxx"). This does not apply to payments and inquiries involving a BSI VA using other methods. Also note that BSI VAs currently do not support the reusable option, so make sure that partner_user_id is left empty if BSI is chosen in list_enable_sof.
diff --git a/source/includes/static_va.md.erb b/source/includes/static_va.md.erb
index 23a072a2..28c4fb78 100644
--- a/source/includes/static_va.md.erb
+++ b/source/includes/static_va.md.erb
@@ -274,7 +274,8 @@ is_single_use | Boolean | FALSE | false | True means that this VA should be clos
 expiration_time | Long | FALSE | - | Expiration time of the VA in minutes, e.g If VA want to be expired after 5 minutes, you just have to set expiration_time to 5. If empty VA will be expired in 24 hour
 is_lifetime | Boolean | FALSE | FALSE | If it is set to FALSE (default) then VA will expire based on the expiration time. Otherwise, it will remain active.
 username_display | String(255) | FALSE | username | Customizable VA display name that will be seen by user, If empty willl be using partner username
-email | String(255) | FALSE | - | Email of user, using email standard format
+email | String(255) | CONDITIONAL (Required by some banks) | - | Email of user, using email standard format. Required by mandiri(008), permata(013) and cimb(022).
+full_name | String(255) | CONDITIONAL (Required by some banks) | - | Fill with the name of end-user that will pay this transaction. Required by mandiri(008), permata(013) and cimb(022).
 trx_expiration_time | Long | FALSE | - | Transaction expiration time in minutes, e.g If Transaction want to be expired after 5 minutes, you just have to set expiration_time to 5. If empty transaction expiration time will be the same with va expiration time
 partner_trx_id | String(255) | FALSE | - | Partner unique Transaction ID of a VA
 trx_counter | Int | FALSE | -1/1 | Transaction counter to limit number of transaction that can be receive by va number, if empty will be use default value -1 for multiple use va, and 1 for single use va. If counter reach zero, va cannot be inquiry or accept payment.
@@ -298,6 +299,7 @@ trx_expiration_time | Long | Transaction expiration time on Unix timestamp in mi
 partner_trx_id | String(255) | Partner unique Transaction ID of a VA
 trx_counter | Int | Transaction counter to limit number of transaction that can be receive by va number, if empty will be use default value -1 for multiple use va, and 1 for single use va. If counter reach zero, va cannot be inquiry or accept payment.
 counter_incoming_payment | Integer | Count total incoming payment of VA
+full_name | String(255) | If `full_name` is needed when creating the transaction, the inputted `full_name` value at creation will be shown here
 
 <aside class="warning">
 Note: For payments and inquiries involving a BSI VA using BSI Mobile or Banking Syariah Indonesia Net, please only input the last 12 digits of the va_number (remove 6059 from the va_number with format "6059xxxxxxxxxxxx"). This does not apply to payments and inquiries involving a BSI VA using other methods
@@ -480,7 +482,9 @@ print(data.decode("utf-8"))
     "counter_incoming_payment": 0,
     "trx_expiration_time": 1582790250609,
     "partner_trx_id": "TRX0001",
-    "trx_counter": -1
+    "trx_counter": -1,
+    "email": "budi@gmal.com",
+    "full_name": "budi budiman"
 }
 ```
 
@@ -515,6 +519,8 @@ counter_incoming_payment | Integer | Count total incoming payment of VA
 trx_expiration_time | Long | Transaction expiration time on Unix timestamp in milliseconds, -1 means no expiration time.
 partner_trx_id | String(255) | Partner unique Transaction ID of a VA
 trx_counter | Int | Transaction counter to limit number of transaction that can be receive by va number, if empty will be use default value -1 for multiple use va, and 1 for single use va. If counter reach zero, va cannot be inquiry or accept payment.
+email | String(255) | If `email` is inputted when creating the transaction, the inputted value at creation will be shown here
+full_name | String(255) | If `full_name` is needed when creating the transaction, the inputted value at creation will be shown here 
 
 <aside class="warning">
 Note: For payments and inquiries involving a BSI VA using BSI Mobile or Banking Syariah Indonesia Net, please only input the last 12 digits of the va_number (remove 6059 from the va_number with format "6059xxxxxxxxxxxx"). This does not apply to payments and inquiries involving a BSI VA using other methods
@@ -798,6 +804,12 @@ trx_expiration_time | Long | Transaction expiration time on Unix timestamp in mi
 partner_trx_id | String(255) | Partner unique Transaction ID of a VA
 trx_counter | Int | Transaction counter to limit number of transaction that can be receive by va number, if empty will be use default value -1 for multiple use va, and 1 for single use va. If counter reach zero, va cannot be inquiry or accept payment.
 counter_incoming_payment | Integer | Count total incoming payment of VA
+email | String(255) | If `email` is needed when creating the transaction, the inputted value at creation will be shown here
+full_name | String(255) | If `full_name` is needed when creating the transaction, the inputted value at creation will be shown here
+
+<aside class="warning">
+Note: For permata(013) and cimb(022) VA (and mandiri(008) for some user), the only operation permitted when updating VA is to deactivate it by setting trx_expiration_time as 0.
+</aside>
 
 ## Get list of created VA
 
@@ -975,7 +987,9 @@ print(data.decode("utf-8"))
             "counter_incoming_payment" : 0,
             "trx_expiration_time": 1582802205412,
             "partner_trx_id": "TRX0002",
-            "trx_counter": 0
+            "trx_counter": 0,
+            "email": "budi@gmal.com",
+            "full_name": "budi budiman"
         },
         {
             "id": "de51383f-1557-409c-8542-dcb74ca76375",
@@ -994,7 +1008,9 @@ print(data.decode("utf-8"))
             "counter_incoming_payment" : 0,
             "trx_expiration_time": 1582802205412,
             "partner_trx_id": "TRX0002",
-            "trx_counter": 0
+            "trx_counter": 0,
+            "email": "budi@gmal.com",
+            "full_name": "budi budiman"
         }
     ],
     "status": {
@@ -1018,7 +1034,7 @@ limit | Integer | 10 | max item to fetch, default is 10, if empty will used defa
 Parameter | Type | Description
 --------- | ---- | -----------
 total | Integer | total items
-data  | Array of object | List of Object `{id: <va_id>, amount: <amount>, va_number: <va_number>, bank_code: <bank_code>, bank_name: <bank_name>, is_open: <is_open>, is_single_user: <is_single_user>, expiration_time: <expiration_time>, va_status: <va_status>, username_display: <username_display>, amount_detected: <amount_detected>, partner_user_id: <partner_user_id>, created: <created>, counter_incoming_payment: <counter_incoming_payment>, trx_counter: <trx_counter>}`
+data  | Array of object | List of Object `{id: <va_id>, amount: <amount>, va_number: <va_number>, bank_code: <bank_code>, bank_name: <bank_name>, is_open: <is_open>, is_single_user: <is_single_user>, expiration_time: <expiration_time>, va_status: <va_status>, username_display: <username_display>, amount_detected: <amount_detected>, partner_user_id: <partner_user_id>, created: <created>, counter_incoming_payment: <counter_incoming_payment>, trx_counter: <trx_counter>, email: <email>, full_name: <full_name>}`
 status | Object | Status of response in Object `{code: <status_code>, message: <status_message>}`
 
 
@@ -1962,6 +1978,7 @@ partner_trx_id | String(255) | TRUE | Unique Transaction ID provided by partner
 trx_id | String (255) | FALSE | Unique ID of incoming payment
 settlement_time | Timestamp | FALSE | The timestamp (in UTC+7) indicating when the fund will be settled to partner’s account statement, format `dd/MM/yyyy'T'HH:mm:ss.SSSZZZZ`
 settlement_status | String(255) | FALSE | The status of the settlement
+full_name | String(255) | TRUE | If `full_name` is needed when creating the transaction, the inputted `full_name` value at creation will be shown here
 
 <aside class="warning">
 Note: For payments and inquiries involving a BSI VA using BSI Mobile or Banking Syariah Indonesia Net, please only input the last 12 digits of the va_number (remove 6059 from the va_number with format "6059xxxxxxxxxxxx"). This does not apply to payments and inquiries involving a BSI VA using other methods