-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add full name params to request/response of some api (#280)
* Add full name params to request/response of some api * fix some inconsistencies * add only when * naming fix
- Loading branch information
Showing
2 changed files
with
32 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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": "[email protected]", | ||
"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": "[email protected]", | ||
"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": "[email protected]", | ||
"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>}` | ||
|
||
|
||
|
@@ -1245,7 +1261,7 @@ POST <%= config[:endpoint_prod] %>/api/custom-va | |
"partner_user_id":"51200021", | ||
"bank_code": "002", | ||
"amount": 10000, | ||
"is_open": false, | ||
"is_open": false, | ||
"username_display": "va name", | ||
"email": "[email protected]", | ||
"trx_expiration_time": 5, | ||
|
@@ -1265,7 +1281,7 @@ request.body = json.encode({ | |
"partner_user_id":"51200021", | ||
"bank_code": "002", | ||
"amount": 10000, | ||
"is_open": false, | ||
"is_open": false, | ||
"username_display": "va name", | ||
"email": "[email protected]", | ||
"trx_expiration_time": 5, | ||
|
@@ -1303,7 +1319,7 @@ func main() { | |
"partner_user_id":"51200021", | ||
"bank_code": "002", | ||
"amount": 10000, | ||
"is_open": false, | ||
"is_open": false, | ||
"username_display": "va name", | ||
"email": "[email protected]", | ||
"trx_expiration_time": 5, | ||
|
@@ -1359,7 +1375,7 @@ var data = JSON.stringify({ | |
"partner_user_id":"51200021", | ||
"bank_code": "002", | ||
"amount": 10000, | ||
"is_open": false, | ||
"is_open": false, | ||
"username_display": "va name", | ||
"email": "[email protected]", | ||
"trx_expiration_time": 5, | ||
|
@@ -1423,7 +1439,7 @@ payload = json.dumps({ | |
"partner_user_id":"51200021", | ||
"bank_code": "002", | ||
"amount": 10000, | ||
"is_open": false, | ||
"is_open": false, | ||
"username_display": "va name", | ||
"email": "[email protected]", | ||
"trx_expiration_time": 5, | ||
|
@@ -1743,9 +1759,9 @@ partner_user_id | String(255) | Partner unique ID for specific user | |
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 | ||
|
||
## Deactivate Customized VA | ||
## Deactivate Customized VA | ||
|
||
Use this API to deactivate an existing customized VA using unique VA id. | ||
Use this API to deactivate an existing customized VA using unique VA id. | ||
|
||
|
||
```shell | ||
|
@@ -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 | ||
|