diff --git a/README.md b/README.md index f8a305e6..0fd721c9 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,17 @@ `docker-compose logs -f` 4. Open the application in your web browser by visiting `http://localhost:4567/` +> [!NOTE] +> If Build Docker Image Failed, you can try like this +> 1. In file `Dockerfile` change ruby from `2.6-slim` to `3.0-slim` And command this line `COPY Gemfile.lock .` +> 2. In file `Gemfile` change this line `ruby '~> 2.5'` to `ruby '~> 3.0'` +> 3. **Don't forget** to change back again when you will push the code + +> [!NOTE] +> If Error when you try to run local, you can try like this +> 1. In file `layout.erb` delete style tag with body content in line 34 to line 36 who has contain ```Rouge::Themes::OyTheme.render``` +> 3. **Don't forget** to change back again when you will push the code + **Features** ------------ diff --git a/source/includes/_api_account_linking.md b/source/includes/_api_account_linking.md index 876fd833..c3b9e9a7 100644 --- a/source/includes/_api_account_linking.md +++ b/source/includes/_api_account_linking.md @@ -226,13 +226,13 @@ print(data.decode("utf-8")) ### Response Parameters -|Parameter |Type |Description | -|--- |--- |--- | -|success |Boolean |Will be `true` if the account linking process is successful and vice versa | -|error |Object |Error detail of the account linking process in Object `{code: , message: }`. This value is not null if the value of field `success` is `false` | -|data |Object |Account linking data, the detail will be explained in the next section | -|reason |String(255) |Will be filled with error reason if the linking status is failed | -|status_code |Integer |Will be `200` if the account linking process is success and will be the same as error code if the linking process is failed | +|Parameter |Type | Nullable |Description | +|--- |--- | ----- |--- | +|success |Boolean | FALSE |Will be `true` if the account linking process is successful and vice versa | +|error |Object | TRUE |Error detail of the account linking process in Object `{code: , message: }`. This value is not null if the value of field `success` is `false` | +|data |Object | TRUE |Account linking data, the detail will be explained in the next section. This value is not null if the value of field success is false | +|reason |String(255) | TRUE |Will be filled with error reason if the linking status is failed | +|status_code |Integer | FALSE |Will be `200` if the account linking process is success and will be the same as error code if the linking process is failed | ### Account Linking Response Data @@ -463,13 +463,13 @@ print(data.decode("utf-8")) ### Response Parameters -|Parameter |Type |Description | -|--- |--- |--- | -|success |Boolean |Will be `true` if the account linking process is successful and vice versa | -|error |Object |Error detail of the account linking process in Object `{code: , message: }`. This value is not null if the value of field `success` is `false` | -|data |Object |Account linking data, the detail will be explained in the next section | -|reason |String(255) |Will be filled with error reason if the linking status is failed | -|status_code |Integer |Will be `200` if the account linking process is success and will be the same as error code if the linking process is failed | +|Parameter |Type | Nullable |Description | +|--- |--- | ----- |--- | +|success |Boolean | FALSE |Will be `true` if the account linking process is successful and vice versa | +|error |Object | TRUE |Error detail of the account linking process in Object `{code: , message: }`. This value is not null if the value of field `success` is `false` | +|data |Object | TRUE |Account linking data, the detail will be explained in the next section. This value is not null if the value of field success is false | +|reason |String(255) | TRUE |Will be filled with error reason if the linking status is failed | +|status_code |Integer | FALSE |Will be `200` if the account linking process is success and will be the same as error code if the linking process is failed | ### Account Linking Response Data @@ -508,15 +508,15 @@ EWALLET | shopeepay_ewallet | Send Callback | - ### Callback Parameters -Parameter | Type | Description ---------- | ---- | ----------- -username | String | Partner username -partner_user_id | String | ID generated by Partner for a specific user/customer -payment_method | String | The payment method type that user want to linked to (Currently only support `EWALLET`. In the future we will have another payment method type, such as `CARDS`) -channel_code | String | The payment channel type that user want to linked to (Currently support `dana_ewallet` and `shopeepay_ewallet`) -phone_number |String | The user phone number (format 08xxxxxxxxxx) -status | String | User's account linking status -expiration_time | String | User's account linking expiration time (example: `01/02/2020T15:00:00.000+0000`) +Parameter | Type | Nullable | Description +--------- | ---- | ----- | ----------- +username | String | FALSE | Partner username +partner_user_id | String | FALSE | ID generated by Partner for a specific user/customer +payment_method | String | FALSE | The payment method type that user want to linked to (Currently only support `EWALLET`. In the future we will have another payment method type, such as `CARDS`) +channel_code | String | FALSE | The payment channel type that user want to linked to (Currently support `dana_ewallet` and `shopeepay_ewallet`) +phone_number |String | FALSE | The user phone number (format 08xxxxxxxxxx) +status | String | FALSE | User's account linking status +expiration_time | String | FALSE | User's account linking expiration time (example: `01/02/2020T15:00:00.000+0000`) - Other than that, at the end of account linking process, we will redirect the user to your redirect page with `partner_user_id` and result status embedded in your redirect URL. You could set your redirect url on your [dashboard](https://desktop-business.oyindonesia.com/settings/developer-options) on tab `Redirect URL`. Below are the example of redirect url result. @@ -734,12 +734,12 @@ print(data.decode("utf-8")) ### Response Parameters -|Parameter |Type |Description | -|--- |--- |--- | -|status |Object |Status of response in Object `{code: , message: }`. | -|partner_user_id |String(255) |ID generated by Partner for a specific user/customer | -|channel_code |String(255) |The payment channel type (Currently support `dana_ewallet` and `shopeepay_ewallet`) | -|amount |BigDecimal |User e-wallet balance amount | +|Parameter |Type | Nullable |Description | +|--- |--- | ----- |--- | +|status |Object | FALSE |Status of response in Object `{code: , message: }`. | +|partner_user_id |String(255) | FALSE |ID generated by Partner for a specific user/customer | +|channel_code |String(255) | FALSE |The payment channel type (Currently support `dana_ewallet` and `shopeepay_ewallet`) | +|amount |BigDecimal | TRUE |User e-wallet balance amount. This value is not null if the value of field success is false | ## Response Codes diff --git a/source/includes/_e_wallet.md b/source/includes/_e_wallet.md index c47e6a63..791f95be 100644 --- a/source/includes/_e_wallet.md +++ b/source/includes/_e_wallet.md @@ -259,17 +259,17 @@ expiration_time | Long | FALSE | Maximum expiration time (in minutes) for each e ### Response Parameters -Parameter | Type | Description ---------- | ---- | -------- | -status | Object | Status of response in Object `{code: , message: }`. See table "Response Code" for more details -ewallet_trx_status | String(20) | Always filled with WAITING_PAYMENT if a transaction is successfully created -trx_id | String(255) | Filled with a unique transaction identifier from OY -ref_number | String(255) | Filled with a unique transaction identifier from OY, can also be used to mock callback in staging environment -customer_id | String(255) | ID generated by Partner for a specific user/customer -partner_trx_id | String(255) | ID generated by Partner for a specific transaction -amount | String(255) | Transaction amount | -ewallet_code | String(255) | The ewallet issuer that the customer will use to pay. Refer to this for the list of available ewallet codes -ewallet_url | String(255) | EWallet URL generated by the the e-wallet issuers to be used for payment purposes +Parameter | Type | Nullable | Description +--------- | ---- | ----- | -------- | +status | Object | FALSE | Status of response in Object `{code: , message: }`. See table "Response Code" for more details +ewallet_trx_status | String(20) | TRUE | Always filled with WAITING_PAYMENT if a transaction is successfully created +trx_id | String(255) | TRUE | Filled with a unique transaction identifier from OY +ref_number | String(255) | TRUE | Filled with a unique transaction identifier from OY, can also be used to mock callback in staging environment +customer_id | String(255) | TRUE | ID generated by Partner for a specific user/customer +partner_trx_id | String(255) | TRUE | ID generated by Partner for a specific transaction +amount | String(255) | TRUE | Transaction amount | +ewallet_code | String(255) | TRUE | The ewallet issuer that the customer will use to pay. Refer to this for the list of available ewallet codes +ewallet_url | String(255) | TRUE | EWallet URL generated by the the e-wallet issuers to be used for payment purposes ## E-Wallet Transaction Callback @@ -303,19 +303,19 @@ If your settlement is non-real time, for every transaction whose payment method } ``` -Parameter | Type | Description ---------- | ---- | -------- | -success | boolean | The status of the payment and it is always set to to true -partner_trx_id | String(255) | ID generated by Partner for a specific transaction -trx_id | String(255) | Filled with a unique transaction identifier from OY -ref_number | String(255) | Filled with a unique transaction identifier from OY, can also be used to mock callback in staging environment -customer_id | String(255) | ID generated by Partner for a specific user/customer -amount | BigDecimal | Transaction amount -ewallet_code | String(255) | The ewallet issuer that the customer used to pay. Refer to this for the list of available ewallet codes -mobile_number | String(255) | Customer mobile number -success_redirect_url | String(255) | Indicates the URL of your environment (to redirect the customers back once payment has been completed in e-wallet issuers.) -settlement_time | Timestamp | 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) | Status of the settlement (e.g. success/waiting) +Parameter | Type | Nullable | Description +--------- | ---- | ----- | -------- | +success | boolean | FALSE | The status of the payment and it is always set to to true +partner_trx_id | String(255) | FALSE | ID generated by Partner for a specific transaction +trx_id | String(255) | FALSE | Filled with a unique transaction identifier from OY +ref_number | String(255) | FALSE | Filled with a unique transaction identifier from OY, can also be used to mock callback in staging environment +customer_id | String(255) | FALSE | ID generated by Partner for a specific user/customer +amount | BigDecimal | FALSE | Transaction amount +ewallet_code | String(255) | FALSE | The ewallet issuer that the customer used to pay. Refer to this for the list of available ewallet codes +mobile_number | String(255) | FALSE | Customer mobile number +success_redirect_url | String(255) | FALSE | Indicates the URL of your environment (to redirect the customers back once payment has been completed in e-wallet issuers.) +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 | Status of the settlement (e.g. success/waiting) ## Check E-Wallet Transaction Status Use this API to check the status of an e-wallet transaction. @@ -527,17 +527,17 @@ partner_trx_id | String(255) | TRUE | - | ID generated by Partner for a specific ### Response Parameters -Parameter | Type | Description ---------- | ---- | -------- | -status | Object | Status of response in Object `{code: , message: }` -ewallet_trx_status | String(20) | Current transaction status, refer to "E-Wallet Transaction Status" for more details -trx_id | String(255) | Filled with a unique transaction identifier from OY -customer_id | String(255) | ID generated by Partner for a specific user/customer -partner_trx_id | String(255) | ID generated by Partner for a specific transaction -amount | String(255) | Transaction Amount -ewallet_code | String(255) | The ewallet issuer that the customer will use to pay. -ewallet_url | String(255) | EWallet URL passed from the e-wallet issuers to be used for payment purposes -reason | String(255) | Reason for the status given +Parameter | Type | Nullable | Description +--------- | ---- | ----- | -------- | +status | Object | FALSE | Status of response in Object `{code: , message: }` +ewallet_trx_status | String(20) | TRUE | Current transaction status, refer to "E-Wallet Transaction Status" for more details. Will not be sent if request is failed. +trx_id | String(255) | TRUE | Filled with a unique transaction identifier from OY. Will not be sent if request is failed. +customer_id | String(255) | TRUE | ID generated by Partner for a specific user/customer. Will not be sent if request is failed. +partner_trx_id | String(255) | TRUE | ID generated by Partner for a specific transaction. Will not be sent if request is failed. +amount | String(255) | FALSE | Transaction Amount +ewallet_code | String(255) | TRUE | The ewallet issuer that the customer will use to pay. Will not be sent if request is failed. +ewallet_url | String(255) | TRUE | EWallet URL passed from the e-wallet issuers to be used for payment purposes. Empty for all ovo transaction. Also empty for other ewallet if request is failed. +reason | String(255) | TRUE | Reason for the status given. Will not be sent if request is failed. ## Refund E-Wallet Transaction Use this API to refund an e-wallet transaction that has been completed. Please refer to table [E-wallet Details](#e-wallet-details-api-e-wallet-aggregator) to see refund capability of each e-wallet vendor. @@ -752,14 +752,14 @@ refund_amount | BigDecimal | TRUE | - | Amount to be refunded, must be greater t ### Response Parameters -Parameter | Type | Description ---------- | ---- | -------- | -status | Object | Status of response in Object `{code: , message: }`. See table "Response Code" for more details -refund_id | String(255) | Filled with a unique refund identifier from OY. You will get refund ID if your request is successfully passed to e-wallet vendor. This can be used as a request parameter to call get refund status API -trx_id | String(255) | Filled with a unique transaction identifier from OY -partner_trx_id | String(255) | ID generated by Partner for a specific transaction -refund_amount | BigDecimal | Requested refund amount | -refund_status | String(255) | Filled with status of refund request, refer to "E-Wallet Refund Status" for more details +Parameter | Type | Nullable | Description +--------- | ---- | ----- | -------- | +status | Object | FALSE | Status of response in Object `{code: , message: }`. See table "Response Code" for more details +refund_id | String(255) | TRUE | Filled with a unique refund identifier from OY. You will get refund ID if your request is successfully passed to e-wallet vendor. This can be used as a request parameter to call get refund status API +trx_id | String(255) | TRUE | Filled with a unique transaction identifier from OY. Will not be sent if request is failed. +partner_trx_id | String(255) | TRUE | ID generated by Partner for a specific transaction. Will not be sent if request is failed. +refund_amount | BigDecimal | TRUE | Requested refund amount. Will not be sent if request is failed. | +refund_status | String(255) | TRUE | Filled with status of refund request, refer to "E-Wallet Refund Status" for more details. Will not be sent if request is failed. ## E-Wallet Refund Callback @@ -780,12 +780,12 @@ You will receive the callback when you request to refund an e-wallet transaction } ``` -Parameter | Type | Description ---------- | ---- | -------- | -success | boolean | Filled with true if refund is successfully processed by e-wallet vendor, and false if otherwise -refund_id | String(255) | Filled with a unique refund identifier from OY -refund_status | String(255) | Status of refund request, refer to "E-Wallet Refund Status" for more details -refund_amount | BigDecimal | Requested refund amount +Parameter | Type | Nullable | Description +--------- | ---- | ----- | -------- | +success | boolean | FALSE | Filled with true if refund is successfully processed by e-wallet vendor, and false if otherwise +refund_id | String(255) | FALSE | Filled with a unique refund identifier from OY +refund_status | String(255) | FALSE | Status of refund request, refer to "E-Wallet Refund Status" for more details +refund_amount | BigDecimal | FALSE | Requested refund amount ## Get E-Wallet Refund Status @@ -973,12 +973,12 @@ refund_id | String(255) | TRUE | - | Unique refund ID, you can get this once you ### Response Parameters -Parameter | Type | Description ---------- | ---- | -------- | -status | Object | Status of response in Object `{code: , message: }`. See table "Response Code" for more details -refund_id | String(255) | Requested e-wallet refund ID -refund_status | String(255) | Status of refund request, refer to "E-Wallet Refund Status" for more details -refund_amount | BigDecimal | Requested refund amount +Parameter | Type | Nullable | Description +--------- | ---- | ----- | -------- | +status | Object | FALSE | Status of response in Object `{code: , message: }`. See table "Response Code" for more details +refund_id | String(255) | TRUE | Requested e-wallet refund ID. Will not be sent if request is failed. +refund_status | String(255) | TRUE | Status of refund request, refer to "E-Wallet Refund Status" for more details. Will not be sent if request is failed. +refund_amount | BigDecimal | TRUE | Requested refund amount. Will not be sent if request is failed. ## Get List of E-Wallet Refund @@ -1176,11 +1176,11 @@ partner_trx_id | String(255) | TRUE | - | ID generated by Partner for a specific ### Response Parameters -Parameter | Type | Description ---------- | ---- | -------- | -status | Object | Status of response in Object `{code: , message: }`. See table "Response Code" for more details -total | Integer | Total items -data | Array of object | List of Object `{refund_id: , refund_status: , refund_amount: }` +Parameter | Type | Nullable | Description +--------- | ---- | ----- | -------- | +status | Object | FALSE | Status of response in Object `{code: , message: }`. See table "Response Code" for more details +total | Integer | TRUE | Total items. Will not be sent if request is failed. +data | Array of object | TRUE | List of Object `{refund_id: , refund_status: , refund_amount: }` Will not be sent if request is failed. ## E-Wallet Details diff --git a/source/includes/_fund_acceptance.md b/source/includes/_fund_acceptance.md index b864e2b4..6fac0c5e 100644 --- a/source/includes/_fund_acceptance.md +++ b/source/includes/_fund_acceptance.md @@ -292,14 +292,14 @@ va_display_name | String | FALSE | Optional parameter, name to display on Bank T ### Response Parameters -Parameter | Type | Description ----- | ---- | ---- -status | Boolean | true / false -url | String | Payment link which used for payment -payment_link_id | String | A unique transaction ID provided by partner -child_balance | String | Applicable for MAM transaction. To be filled with the username of child account. If you do not pass the parameter in request, we will not pass this parameter in response. -message | String | Message response -email_status | String | email status +Parameter | Type | Nullable | Description +---- | ---- | ----- | ---- +status | Boolean | FALSE | true / false +url | String | TRUE | Payment link which used for payment. Only filled if payment checkout successfully created. +payment_link_id | String | TRUE | A unique transaction ID provided by partner. Only filled if payment checkout successfully created. +child_balance | String | TRUE | Applicable for MAM transaction. To be filled with the username of child account. If you do not pass the parameter in request, we will not pass this parameter in response. Only applicable for MAM transaction. +message | String | FALSE | Message response +email_status | String | TRUE | email status. Only filled if payment checkout successfully created. ## API Create (Invoicing) @@ -649,13 +649,13 @@ invoice_items | List | List of items to be invoiced that can be generated via AP attachment | - | Upload attachment (string base 64 pdf) and can be downloaded via the webview | There is a maximum limit of 1 PDF attachment (maximum 2 MB) to be uploaded per URL ### Response Parameters -Parameter | Type | Description ----- | ---- | ---- -status | Boolean | true / false -url | String | Payment link which used for payment -message | String | Message response -payment_link_id | String | A unique payment link transaction ID -email_status | String | email status +Parameter | Type | Nullable | Description +---- | ---- | ----- | ---- +status | Boolean | FALSE | true / false +url | String | TRUE | Payment link which used for payment. Only filled if payment checkout successfully created. +message | String | FALSE | Message response +payment_link_id | String | TRUE | A unique payment link transaction ID. Only filled if payment checkout successfully created. +email_status | String | TRUE | email status. Only filled if payment checkout successfully created. ## API Create (Recurring Invoice) (Coming soon) @@ -751,38 +751,38 @@ curl -X POST \ ``` -Parameter | Type | Description ---------- | ---- | ----------- -partner_tx_id | String | A unique transaction ID provided by partner -child_balance | String | Applicable for MAM transaction. To be filled with the username of child account. If you do not pass the parameter in request, we will not pass this parameter in Callback -tx_ref_number | String | OY's internal unique transaction ID -amount | BigDecimal | The amount of a transaction that is paid -sender_name | String | Name of a payer for a transaction -sender_phone | String | Phone number of a payer for a transaction -sender_note | String | Additional notes from a payer for a transaction -status | String | The status of a transaction (e.g. success/failed/processing) -sender_bank | String | The bank code used by a payer to do payment -payment_method | String | The payment method used by user to complete a payment. -settlement_type | String | Indicate if a transaction will be settled in realtime/non-realtime -created | DateTime | The timestamp which indicates the creation time of a payment link -updated | DateTime | The timestamp which indicates the latest updated time of a payment link due to status update -payment_received_time | DateTime | Indicates the time when payment routing is marked as COMPLETE (this parameter will only be sent once status of the payment link is set to ‘COMPLETE’). -is_invoice | Boolean | The invoice which indicates the transaction is invoice or not -description | String | The description of the payment link/invoice link. -payment_reference_number| String | Identifier of a payment attempt when the end user successfully completes the payment. The reference number is also stated in the end user’s receipt/proof of transaction. Note that if a QRIS transaction is paid using OVO, the payment reference number is only the first 12 characters from the given transaction code. Available for: QRIS -expiration | DateTime | The expiration time of the payment link/invoice link -due_date | DateTime | The transaction due date of the payment link/invoice -email | String | The email addresses for the payment link/invoice link to be sent. You can add up to 3 emails separated by ";" -paid_amount | BigDecimal | The total amount that a user has paid -settlement_time | DateTime | The timestamp (in UTC+7) indicating when the fund will be settled to partner’s account statement -settlement_status | String | Status of the settlement (e.g. success/waiting) +Parameter | Type | Nullable | Description +--------- | ---- | ----- | ----------- +partner_tx_id | String | FALSE | A unique transaction ID provided by partner. +child_balance | String | TRUE | Applicable for MAM transaction. To be filled with the username of child account. If you do not pass the parameter in request, we will not pass this parameter in Callback. +tx_ref_number | String | FALSE | OY's internal unique transaction ID. +amount | BigDecimal | FALSE | The amount of a transaction that is paid. +sender_name | String | FALSE | Name of a payer for a transaction. +sender_phone | String | TRUE | Phone number of a payer for a transaction. This parameter will only be sent if end user fill the data. +sender_note | String | TRUE | Additional notes from a payer for a transaction. This parameter will only be sent if end user fill the data. +status | String | FALSE | The status of a transaction (e.g. success/failed/processing). +sender_bank | String | FALSE | The bank code used by a payer to do payment. +payment_method | String | FALSE | The payment method used by user to complete a payment. +settlement_type | String | FALSE | Indicate if a transaction will be settled in realtime/non-realtime. +created | DateTime | FALSE | The timestamp which indicates the creation time of a payment link. +updated | DateTime | FALSE | The timestamp which indicates the latest updated time of a payment link due to status update. +payment_received_time | DateTime | TRUE | Indicates the time when payment routing is marked as COMPLETE (this parameter will only be sent once status of the payment link is set to ‘COMPLETE’). +is_invoice | Boolean | FALSE | The invoice which indicates the transaction is invoice or not. +description | String | FALSE | The description of the payment link/invoice link. +payment_reference_number| String | TRUE | Identifier of a payment attempt when the end user successfully completes the payment. The reference number is also stated in the end user’s receipt/proof of transaction. Note that if a QRIS transaction is paid using OVO, the payment reference number is only the first 12 characters from the given transaction code. Available for: QRIS. +expiration | DateTime | FALSE | The expiration time of the payment link/invoice link. +due_date | DateTime | FALSE | The transaction due date of the payment link/invoice. +email | String | FALSE | The email addresses for the payment link/invoice link to be sent. You can add up to 3 emails separated by ";". +paid_amount | BigDecimal | FALSE | The total amount that a user has paid. +settlement_time | DateTime | TRUE | The timestamp (in UTC+7) indicating when the fund will be settled to partner’s account statement. This parameter will only be sent once status of the payment link is set to 'COMPLETE'. +settlement_status | String | TRUE | Status of the settlement (e.g. success/waiting). This parameter will only be sent once status of the payment link is set to 'COMPLETE'. Additional data on the callback if invoice = true -Parameter | Type | Description ---------- | ---- | ----------- -invoice_ID | String | The invoice id. -full_name | String | The full name. +Parameter | Type | Nullable | Description +--------- | ---- | ----- | ----------- +invoice_ID | String | FALSE | The invoice id. +full_name | String | FALSE | The full name. ## Payment Link Status @@ -993,31 +993,31 @@ Note: All requests made must contain "partner_trx_id" or "payment_reference_numb ### Response Parameters -Parameter | Type | Description ----- | ---- | ---- -partner_tx_id | String | A unique transaction ID provided by partner -child_balance | String | Applicable for MAM transaction. To be filled with the username of child account. If you do not pass the parameter in request Create Payment Link, we will not pass this parameter in the response -tx_ref_number | String | OY's internal unique transaction ID -amount | BigDecimal | The amount of a transaction that is paid -sender_name | String | Name of a payer for a transaction -sender_phone | String | Phone number of a payer for a transaction -sender_note | String | Additional notes from a payer for a transaction -status | String | The status of a payment link -payment_received_time | String | Indicates the time when payment routing is marked as COMPLETE (this parameter will only be sent once status of the payment link is set to ‘COMPLETE’). -settlement_type | String | Indicate if a transaction will be settled in realtime/non-realtime -sender_bank | String | The bank code used by a payer to do payment -payment_method | String | The payment method used in a transaction. Choices are: CC (Cards), QRIS, EWALLET (shopeepay_ewallet, dana_ewallet, linkaja_ewallet, ovo_ewallet), VA (Virtual Account), or BANK_TRANSFER (Unique Code) -created | String | The timestamp which indicates the creation time of a payment link -description | String | Description of the payment link. -payment_reference_number | String | Identifier of a payment attempt when the end user successfully completes the payment. The reference number is also stated in the end user’s receipt/proof of transaction. Note that if a QRIS transaction is paid using OVO, the payment reference number is only the first 12 characters from the given transaction code. Available for: QRIS -paid_amount | BigDecimal | the total amount that a user has paid. -expiration | String | To set the expiration of the payment link (yyyy-MM-dd HH:mm:ss) -due_date | String | To set the transaction due date of the payment (yyyy-MM-dd HH:mm:ss) -is_invoice | Boolean | The invoice which indicates the transaction is invoice or not. -updated | String | The timestamp which indicates the latest updated time of a payment link due to status update -email | String | The email addresses where the payment link will be sent to. You can add up to 3 emails separated by ";" -settlement_time | String | The timestamp (in UTC+7) indicating when the fund will be settled to partner’s account statement (this parameter will only be sent once status of the payment link is set to ‘COMPLETE’) -settlement_status | String | The status of the settlement (this parameter will only be sent once status of the payment link is set to ‘COMPLETE’) +Parameter | Type | Nullable | Description +---- | ---- | ----- | ---- +partner_tx_id | String | FALSE | A unique transaction ID provided by partner. +child_balance | String | FALSE | Applicable for MAM transaction. To be filled with the username of child account. If you do not pass the parameter in request Create Payment Link, we will not pass this parameter in the response. +tx_ref_number | String | FALSE | OY's internal unique transaction ID. +amount | BigDecimal | FALSE | The amount of a transaction that is paid. +sender_name | String | FALSE | Name of a payer for a transaction. +sender_phone | String | FALSE | Phone number of a payer for a transaction. +sender_note | String | FALSE | Additional notes from a payer for a transaction. +status | String | FALSE | The status of a payment link. +payment_received_time | String | TRUE | Indicates the time when payment routing is marked as COMPLETE (this parameter will only be sent once status of the payment link is set to ‘COMPLETE’). +settlement_type | String | FALSE | Indicate if a transaction will be settled in realtime/non-realtime. +sender_bank | String | FALSE | The bank code used by a payer to do payment. +payment_method | String | FALSE | The payment method used in a transaction. Choices are: CC (Cards), QRIS, EWALLET (shopeepay_ewallet, dana_ewallet, linkaja_ewallet, ovo_ewallet), VA (Virtual Account), or BANK_TRANSFER (Unique Code). +created | String | FALSE | The timestamp which indicates the creation time of a payment link. +description | String | FALSE | Description of the payment link. +payment_reference_number | String | FALSE | Identifier of a payment attempt when the end user successfully completes the payment. The reference number is also stated in the end user’s receipt/proof of transaction. Note that if a QRIS transaction is paid using OVO, the payment reference number is only the first 12 characters from the given transaction code. Available for: QRIS. +paid_amount | BigDecimal | FALSE | the total amount that a user has paid. +expiration | String | FALSE | To set the expiration of the payment link (yyyy-MM-dd HH:mm:ss). +due_date | String | FALSE | To set the transaction due date of the payment (yyyy-MM-dd HH:mm:ss). +is_invoice | Boolean | FALSE | The invoice which indicates the transaction is invoice or not. +updated | String | FALSE | The timestamp which indicates the latest updated time of a payment link due to status update. +email | String | FALSE | The email addresses where the payment link will be sent to. You can add up to 3 emails separated by ";". +settlement_time | String | FALSE | The timestamp (in UTC+7) indicating when the fund will be settled to partner’s account statement (this parameter will only be sent once status of the payment link is set to ‘COMPLETE’). +settlement_status | String | FALSE | The status of the settlement (this parameter will only be sent once status of the payment link is set to ‘COMPLETE’). ## API Delete @@ -1184,11 +1184,11 @@ payment_link_id_or_partner_tx_id | String | payment_link_id or partner_tx_id in ### Response Parameters -Parameters | Type | Description ----- | ---- | ------ -status | Boolean | TRUE if delete is successful and FALSE otherwise -message | String | Return message -child_balance | String | Applicable for MAM transaction. To be filled with the username of child account. If you do not pass the parameter in request, we will not pass this parameter in Callback +Parameters | Type | Nullable | Description +---- | ---- | -----| ------ +status | Boolean | FALSE | TRUE if delete is successful and FALSE otherwise. +message | String | FALSE | Return message. +child_balance | String | TRUE | Applicable for MAM transaction. To be filled with the username of child account. If you do not pass the parameter in request, we will not pass this parameter in Callback. ### Return Message @@ -1399,29 +1399,29 @@ payment_link_id_or_partner_tx_id | String | payment_link_id or partner_tx_id in ### Payment Response Parameters -Parameters | Type | Description | Example Value ----- | ---- | ------ | ------- -partnerTxId | String | Payment Partner Tx Id | abc123 -child_balance | String | Applicable for MAM transaction. To be filled with the username of child account. If you do not pass the parameter in request, we will not pass this parameter in Callback | child123 -paymentLinkId | String | Payment Link Id | 35281815-4784-4f55-9a61-090f5c17a191 -amount | Integer | Payment Amount | 30000 -username | String | Partner Username | johndoe -senderName | String | Payment Sender Name | Budi -senderPhoneNumber | String | Payment Sender Phone Number | 081234567890 -senderNotes | String | Payment Notes / Subject | Cicilan Mobil - 5 -status | String | Payment Status | COMPLETE -txRefNumber | String | Payment Transaction Reference Number | GTY67JJU -description | String | Payment Description | Tagihan Cicilan Mobil -isOpen | Boolean | Payment Editable Amount Capability | true -notes | String | Payment Notes / Subject | Cicilan Mobil - 5 -email | String | Payment Sender Email(s).You can add up to 3 emails separated by ";" | johndoe@gmail.com;jane@gmail.com -senderPhoneNumber | String | Payment Sender Phone Number | 081234567890 -includeAdminFee | Boolean | Admin fee bills destination between partner or user | true -listDisabledPaymentMethods | String | List Of Disable Payment Method. -listEnabledBanks | String | Payment Method List Enable Bank for VA or Unique Code Payment Method | 002,008 -expirationTime | String | Payment Expiration Date and Time | "2020-08-12 00:00:00" -due_date | String | Transaction Due Date | "2020-08-11 12:00:00" -invoiceData | Invoice | Data For Invoice Payment will be null | CREDIT_CARD)** | null +Parameters | Type | Nullable | Description | Example Value +---- | ---- | ----- | ------ | ------- +partnerTxId | String | FALSE | Payment Partner Tx Id | abc123 +child_balance | String | TRUE | Applicable for MAM transaction. To be filled with the username of child account. If you do not pass the parameter in request, we will not pass this parameter in Callback | child123 +paymentLinkId | String | FALSE | Payment Link Id | 35281815-4784-4f55-9a61-090f5c17a191 +amount | Integer | FALSE | Payment Amount | 30000 +username | String | FALSE | Partner Username | johndoe +senderName | String | FALSE | Payment Sender Name | Budi +senderPhoneNumber | String | TRUE | Payment Sender Phone Number. This parameter will only be sent if end user fill the data | 081234567890 +senderNotes | String | TRUE | Payment Notes / Subject. This parameter will only be sent if end user fill the data | Cicilan Mobil - 5 +status | String | FALSE | Payment Status | COMPLETE +txRefNumber | String | FALSE | Payment Transaction Reference Number | GTY67JJU +description | String | FALSE | Payment Description | Tagihan Cicilan Mobil +isOpen | Boolean | FALSE | Payment Editable Amount Capability | true +notes | String | FALSE | Payment Notes / Subject | Cicilan Mobil - 5 +email | String | FALSE | Payment Sender Email(s).You can add up to 3 emails separated by ";" | johndoe@gmail.com;jane@gmail.com +senderPhoneNumber | String | FALSE | Payment Sender Phone Number | 081234567890 +includeAdminFee | Boolean | FALSE | Admin fee bills destination between partner or user | true +listDisabledPaymentMethods | String | FALSE | List Of Disable Payment Method. +listEnabledBanks | String | FALSE | Payment Method List Enable Bank for VA or Unique Code Payment Method | 002,008 +expirationTime | String | FALSE | Payment Expiration Date and Time | "2020-08-12 00:00:00" +due_date | String | FALSE | Transaction Due Date | "2020-08-11 12:00:00" +invoiceData | Invoice | TRUE | Data For Invoice Payment will be null | CREDIT_CARD)** | null ### Invoice Response Parameters diff --git a/source/includes/_payment_routing.md b/source/includes/_payment_routing.md index 86541172..4ee4bc9c 100644 --- a/source/includes/_payment_routing.md +++ b/source/includes/_payment_routing.md @@ -310,27 +310,27 @@ Endpoint: | recipient_email | String | TRUE | - | Email for disbursement notification, email can be up to 5, seperated by a whitespace| ### Response Parameters -| Parameter | Type | Description | -| ------------- |:-------------:| :----------: | -|status|Object|Status of response in Object| -|trx_id|String|Payment Routing ID defined by OY!| -|partner_user_id|String|Partner user ID that you defined in the request parameter| -|use_linked_account|Boolean|Applicable for EWallet with `need_frontend: false`. If `true`, the transaction created is an EWallet Direct Payment transaction (ShopeePay only). Else, it is a regular EWallet transaction.| -|partner_trx_id|String|Partner transaction ID that you defined in the request parameter| -|receive_amount|Numeric|amount to be received. If you use unique code BCA, this number will contain the amount to be received subtracted by 3 digits generated unique code.| -|trx_expiration_time|Date string; yyyy-MM-dd HH:mm:ss format|Transaction Expiration Time| -|payment_method | String | Only exist if request need_frontend is FALSE. The payment method used by user to complete a payment. Refer to Payment Method on [List of Allowed Payment Methods and SOF](#list-of-allowed-payment-methods-and-sof-create-and-update-payment-routing) | -|sender_bank | String | Only exist if request need_frontend is FALSE. The bank code used by a payer to do payment. Refer to SOF on [List of Allowed Payment Methods and SOF](#list-of-allowed-payment-methods-and-sof-create-and-update-payment-routing) | -|payment_info|Object|Payment info object| -|payment_checkout_url|String|generated url for payment link; conditional, only exist if request need_frontend is TRUE| -|account_number|String|Generated VA number if you use VA or account number destination if you use unique code BCA; conditional, only exist if request need_frontend is FALSE and payment_method is BANK_TRANSFER| -|account_name|String|VA display name if you use VA or bank account's owner name if you use unique code BCA; conditional, only exist if request need_frontend is FALSE and payment_method is BANK_TRANSFER| -|bank_code|String|Bank code for the destination VA number or bank account; conditional, only exist if request need_frontend is FALSE and payment_method is BANK_TRANSFER| -|qris_url|String|the URL of QR image; conditional, only exist if request need_frontend is FALSE and payment_method is QRIS. This returned URL can only be accessed for 5 minutes after initial response was received, and is independent to the actual QRIS validity / expiration time.| -|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 | If `full_name` is needed when creating the transaction, the inputted `full_name` value at creation will be shown here.| +| Parameter | Type | Nullable | Description | +| ------------- |:-------------:| ----- | :----------: | +|status|Object| FALSE |Status of response in Object| +|trx_id|String| FALSE |Payment Routing ID defined by OY!| +|partner_user_id|String| TRUE |Partner user ID that you defined in the request parameter. Only available for reusable VA or direct payment| +|use_linked_account|Boolean| FALSE |Applicable for EWallet with `need_frontend: false`. If `true`, the transaction created is an EWallet Direct Payment transaction (ShopeePay only). Else, it is a regular EWallet transaction.| +|partner_trx_id|String| FALSE |Partner transaction ID that you defined in the request parameter| +|receive_amount|Numeric| FALSE |amount to be received. If you use unique code BCA, this number will contain the amount to be received subtracted by 3 digits generated unique code.| +|trx_expiration_time|Date string; yyyy-MM-dd HH:mm:ss format| FALSE |Transaction Expiration Time| +|payment_method | String | TRUE | Only exist if request need_frontend is FALSE. The payment method used by user to complete a payment. Refer to Payment Method on [List of Allowed Payment Methods and SOF](#list-of-allowed-payment-methods-and-sof-create-and-update-payment-routing) | +|sender_bank | String | TRUE | Only exist if request need_frontend is FALSE. The bank code used by a payer to do payment. Refer to SOF on [List of Allowed Payment Methods and SOF](#list-of-allowed-payment-methods-and-sof-create-and-update-payment-routing) | +|payment_info|Object| FALSE |Payment info object| +|payment_checkout_url|String| TRUE |generated url for payment link; conditional, only exist if request need_frontend is TRUE| +|account_number|String| TRUE |Generated VA number if you use VA or account number destination if you use unique code BCA; conditional, only exist if request need_frontend is FALSE and payment_method is BANK_TRANSFER| +|account_name|String| TRUE |VA display name if you use VA or bank account's owner name if you use unique code BCA; conditional, only exist if request need_frontend is FALSE and payment_method is BANK_TRANSFER| +|bank_code|String| TRUE |Bank code for the destination VA number or bank account; conditional, only exist if request need_frontend is FALSE and payment_method is BANK_TRANSFER| +|qris_url|String| TRUE |the URL of QR image; conditional, only exist if request need_frontend is FALSE and payment_method is QRIS. This returned URL can only be accessed for 5 minutes after initial response was received, and is independent to the actual QRIS validity / expiration time.| +|ewallet_url|String| TRUE | 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| TRUE | 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| TRUE |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 | FALSE | If `full_name` is needed when creating the transaction, the inputted `full_name` value at creation will be shown here.|