Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Merchant Cannot Do Integration-401] Add section how switch to production mode #87

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open

[Merchant Cannot Do Integration-401] Add section how switch to production mode #87

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
db8f078
add image assets (prod key & payment active list)
Jul 15, 2022
6e7aa6c
Update going live page to be more descriptive
Jul 15, 2022
68dfd43
add switch to production section on snap
Jul 15, 2022
28ab7c1
add switch to production section on emoney
Jul 15, 2022
a53f7c9
add switch to production section direct debit
Jul 15, 2022
0915570
add switch to production section on CC
Jul 15, 2022
64d1373
add switch to production section on CS
Jul 15, 2022
9b79d7d
add switch to production section on Cardless
Jul 15, 2022
7467881
add switch to production section on BT
Jul 15, 2022
19a8400
Merge branch 'master' into master
Jul 15, 2022
8f90db1
optimize image size
Jul 18, 2022
2272f9f
Merge branch 'master' of https://github.com/Xaxxis/technical-document…
Jul 18, 2022
00af539
Fix wording for going live section
Aug 2, 2022
6552142
fix wording and add alternative to check payment methods active, remo…
Aug 2, 2022
8415198
add image illustration
Aug 2, 2022
22c5d88
add link page how to fix 401 error code
Aug 2, 2022
88759e8
add page how to troubleshooting 401 error code page
Aug 2, 2022
9b867d5
fix consistent wording error code
Aug 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added asset/image/active-payment-methods.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added asset/image/production-access-key.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions en/core-api/bank-transfer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -523,6 +523,20 @@ To configure the Payment Notification URL, follow the steps given below.
#### [HTTP(S) Notification/Webhooks](/en/after-payment/http-notification.md)
</div>


## 4. Switching to Production Mode
In this section, you will learn how switching from Sandbox environment to Production environment, in order to start accepting real world payment for your business. This is also known as "Going Live".

<br>

<div class="my-card">

#### [Going Live](/en/technical-reference/going-live.md)
Best practices to build a production-ready

</div>


#### Transaction Status Description
The description of `transaction_status` value for *Bank Transfer* payment method is given below.

Expand Down
15 changes: 11 additions & 4 deletions en/core-api/cardless-credit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,10 +256,17 @@ The sample HTTP notification request received at merchant backend for Akulaku *C
#### [HTTP(S) Notification/Webhooks](/en/after-payment/http-notification.md)
</div>

## Switching to Production Environment
Follow the steps given below to switch to Midtrans *Production* environment and to accept real payments from real customers.
1. Change API domain URL from `api.sandbox.midtrans.com` to `api.midtrans.com`.
2. Use *Client Key* and *Server Key* for *Production* environment. For more details, refer to [Retrieving API Access Keys](/en/midtrans-account/overview.md#retrieving-api-access-keys).
### 5. Switching to Production Mode
In this section, you will learn how switching from Sandbox environment to Production environment, in order to start accepting real world payment for your business. This is also known as "Going Live".

<br>

<div class="my-card">

#### [Going Live](/en/technical-reference/going-live.md)
Best practices to build a production-ready

</div>

## Next Step:
<br>
Expand Down
15 changes: 11 additions & 4 deletions en/core-api/convenience-store.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,10 +324,17 @@ The sample HTTP notification request received at merchant backend for *Over the
#### [HTTP(S) Notification/Webhooks](/en/after-payment/http-notification.md)
</div>

## Switching to Production Environment
Follow the steps given below to switch to Midtrans *Production* environment and to accept real payments from real customers.
1. Change API domain URL from `api.sandbox.midtrans.com` to `api.midtrans.com`.
2. Use *Client Key* and *Server Key* for *Production* environment. For more details, refer to [Retrieving API Access Keys](/en/midtrans-account/overview.md#retrieving-api-access-keys).
### 4. Switching to Production Mode
In this section, you will learn how switching from Sandbox environment to Production environment, in order to start accepting real world payment for your business. This is also known as "Going Live".

<br>

<div class="my-card">

#### [Going Live](/en/technical-reference/going-live.md)
Best practices to build a production-ready

</div>

## Next Step:
<br>
Expand Down
12 changes: 12 additions & 0 deletions en/core-api/credit-card.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -671,6 +671,18 @@ The table given below, describes the `transaction_status`.

For more details, refer to [Midtrans Transaction Status Cycle Description](/en/after-payment/status-cycle.md).

## 5. Switching to Production Mode
In this section, you will learn how switching from Sandbox environment to Production environment, in order to start accepting real world payment for your business. This is also known as "Going Live".

<br>

<div class="my-card">

#### [Going Live](/en/technical-reference/going-live.md)
Best practices to build a production-ready

</div>

## Next Step:
<br>

Expand Down
15 changes: 11 additions & 4 deletions en/core-api/direct-debit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -518,10 +518,17 @@ The sample HTTP notification request received at merchant backend for *Direct De
#### [HTTP(S) Notification/Webhooks](/en/after-payment/http-notification.md)
</div>

## Switching to Production Environment
Follow the steps given below to switch to Midtrans *Production* environment and to accept real payments from real customers.
1. Change API domain URL from `api.sandbox.midtrans.com` to `api.midtrans.com`.
2. Use *Client Key* and *Server Key* for *Production* environment. For more details, refer to [Retrieving API Access Keys](/en/midtrans-account/overview.md#retrieving-api-access-keys).
### 5. Switching to Production Mode
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why change heading structure from ## to ### 5. ? IMO it shouldn't be part of integration step's sub heading, as it would seems that the integration steps is now longer.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback Da. I get the details from Yana, about the merchant that facing 401. They claim they weren't found the information in the integration steps and that they should change the environment to production before going live. That's why I put the section going live, into integration steps. But I will let you decide what the best to choose ya.

Thank you

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm I think make sense, please proceed with your approach for now 👌 we can re-evaluate sometimes later if we need to.

In this section, you will learn how switching from Sandbox environment to Production environment, in order to start accepting real world payment for your business. This is also known as "Going Live".
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how switching from Sandbox environment

bad grammar. Have you use any tool to check grammar? use tool, at least jsut paste to a google docs, it will auto detect grammar mistakes.

OR just use the original wording:

to switch to Midtrans Production environment and to accept real payments from real customers.


<br>

<div class="my-card">

#### [Going Live](/en/technical-reference/going-live.md)
Best practices to build a production-ready
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to build a production-ready

hmm the wording doesn't quite make sense. try something else

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about

Steps to take before going live

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use the page description as reference:

... switching from Sandbox environment to Production environment, in order to start accepting real world payment

Simplified to:

Learn how to switch from Sandbox to Production environment, to start accepting real payment


</div>

## Note & Limitation

Expand Down
13 changes: 13 additions & 0 deletions en/core-api/e-wallet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,6 +451,19 @@ To configure the Payment Notification URL, follow the steps given below.
#### [HTTP(S) Notification/Webhooks](/en/after-payment/http-notification.md)
</div>

## 4. Switching to Production Mode
In this section, you will learn how switching from Sandbox environment to Production environment, in order to start accepting real world payment for your business. This is also known as "Going Live".

<br>

<div class="my-card">

#### [Going Live](/en/technical-reference/going-live.md)
Best practices to build a production-ready

</div>


#### Transaction Status Description
The table given below explains `transaction_status` values for Ewallet transaction.

Expand Down
12 changes: 12 additions & 0 deletions en/snap/integration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -557,6 +557,18 @@ The URL is updated and a confirmation message is displayed.
#### [HTTP(S) Notification/Webhooks](/en/after-payment/http-notification.md)
</div>

## 5. Switching to Production Mode
In this section, you will learn how switching from Sandbox environment to Production environment, in order to start accepting real world payment for your business. This is also known as "Going Live".

<br>

<div class="my-card">

#### [Going Live](/en/technical-reference/going-live.md)
Best practices to build a production-ready

</div>

## Next Step
<br>

Expand Down
69 changes: 38 additions & 31 deletions en/technical-reference/going-live.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,37 @@

This document is designed to assist you in switching from *Sandbox* environment to *Production* environment, in order to start accepting real world payment for your business. This is also known as "Going Live".

?>Make sure you have already completed the test payment using our [Payment Simulator](/en/technical-reference/sandbox-test.md) in the Sandbox environment to ensure that your implementation is working fine.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

better:

Make sure you have already performed some successful payment testing in the Sandbox environment, to ensure that your implementation is working properly.

## 1. Login to Your Midtrans Production Environment Dashboard
## 1. Checking Your Production Account
To make sure your payment channels on Production account is already active, follow the steps given below.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

payment channels

Is an internal wording. to talk with external audience we use Payment Methods. The term has been used all over the docs too, so you should just need to be consistent with the term.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

better wording:

To make sure that your Midtrans account already has activated payment method(s) on Production Environment mode, follow the steps given below.


To login to your Midtrans *Production* environment, follow the steps given below.
1. Login to your Midtrans Administrative Portal using *Production* environment at https://dashboard.midtrans.com/login.

1. Login to your account at https://account.midtrans.com.
- refer to [Access Midtrans Administration Portal](/en/midtrans-account/overview.md#accessing-midtrans-administration-portal) for more details.
2. Select **Production** Environment from top-left environment switcher dropdown.
- refer to [Switching Environment](/en/midtrans-account/overview.md#switching-environment) for more details.
2. To make sure your payment channels on Production account is active.
- Go to menu **PAYMENT METHODS** from the dashboard page
- *Active Payment Methods* page is displayed.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is all merchants confirmed to have access to this page? AFAIK based on pilar issues, some manually onboarded merchant etc was unable to access this page.

  • maybe need confirmation to CMP?
  • or maybe add notes to skip this step if they are unable to see the page?
  • or maybe ask them to check snap payment method list?

- Then you can find a list of active payment methods ready in a production environment

## 2. Checking Your Production Account
![Active Payment Method](./../../asset/image/active-payment-methods.png)
<br>

?>refer to [Access Midtrans Administration Portal](/en/midtrans-account/overview.md#accessing-midtrans-administration-portal) for more details.

## 2. Retrieving Production Server Key and Client Key
To switch from Sandbox to Production environment, Client Key and Server Key production are required.

To get access to the Client Key and Server Key, follow the steps given below.

To make sure your production account is active, follow the steps given below.
1. Login to your MAP account.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I personally prefer to avoid using MAP terms as not all merchants maybe familiar with the terms, and would use your Midtrans Account as it is more straight forward to understand.

1. On the home page, go to **SETTINGS > SNAP PREFERENCES**.
- *SNAP Preferences* page is displayed.
2. Select **Payment Channels** tab.
- A list of active payment methods is displayed.
2. On the *Dashboard*, go to **Settings > Access Keys**.

## 3. Retrieving Server Key and Client Key
*Access Keys* page is displayed.

Go to **SETTINGS > ACCESS KEYS**. Server Key and Client Key for *Production* environment and *Sandbox* environment are different. For more information, refer to [Retrieving API access keys](/en/midtrans-account/overview.md#retrieving-api-access-keys).
![Production Access Key](./../../asset/image/production-access-key.png)

## 4. Configuring the Integration
## 3. Configuring the Integration

Please select which one of integration method you are using:

Expand All @@ -37,7 +44,7 @@ If you are using Language Libraries provided by Midtrans (Midtrans PHP, Midtrans
#### On Backend

1. Replace `isProduction` variable on Backend with value `true`.
2. Replace `ServerKey` variable value on the Backend with the *Server Key* retrieved from [Step 3 above](#_3-retrieving-server-key-and-client-key).
2. Replace `ServerKey` variable value on the Backend with the *Server Key* retrieved from [Step 2 above](#_2-retrieving-production-server-key-and-client-key).

#### On Frontend
<details open>
Expand Down Expand Up @@ -80,7 +87,7 @@ If you are directly integrating by direct API call/request:
#### On Backend
1. Replace API domain destination to Production API on Backend by removing `.sandbox` from the domain.
- For example, change the API domain from `app.sandbox.midtrans.com/` to `app.midtrans.com/`.
2. Replace the `ServerKey` variable value used for API auth on the Backend with the *Server Key* retrieved from [Step 3 above](#_3-retrieving-server-key-and-client-key).
2. Replace the `ServerKey` variable value used for API auth on the Backend with the *Server Key* retrieved from [Step 2 above](#_2-retrieving-production-server-key-and-client-key).

#### On Frontend
<details open>
Expand Down Expand Up @@ -124,8 +131,8 @@ Find where you include midtrans-new-3ds.min.js script tag:
3. Go to **Settings > Payment**.
4. Select **Production** from Environment drop-down list.
5. Enter the **Merchant Key**.
6. Enter **Client Key** with the *Client Key* retrieved from [Step 3 above](#_3-retrieving-server-key-and-client-key).
7. Enter **Server Key** with the *Server Key* retrieved from [Step 3 above](#_3-retrieving-server-key-and-client-key).
6. Enter **Client Key** with the *Client Key* retrieved from [Step 2 above](#_2-retrieving-production-server-key-and-client-key).
7. Enter **Server Key** with the *Server Key* retrieved from [Step 2 above](#_2-retrieving-production-server-key-and-client-key).

Your website is now integrated with Midtrans. For more information, refer to [Configuring WooCommerce Plugin Notification](/en/snap/with-plugins.md).

Expand All @@ -137,8 +144,8 @@ Your website is now integrated with Midtrans. For more information, refer to [Co
4. Select **Production** from Environment drop-down list.
5. Enter **Sandbox Client Key**.
6. Enter **Sandbox Server Key.**
7. Enter **Production Server Key** with the *Server Key* retrieved from [Step 3 above](#_3-retrieving-server-key-and-client-key).
8. Enter **Production Client Key** with the *Client Key* retrieved from [Step 3 above](#_3-retrieving-server-key-and-client-key).
7. Enter **Production Server Key** with the *Server Key* retrieved from [Step 2 above](#_2-retrieving-production-server-key-and-client-key).
8. Enter **Production Client Key** with the *Client Key* retrieved from [Step 2 above](#_2-retrieving-production-server-key-and-client-key).

Your website is now integrated with Midtrans. For more information, refer to [Configuring Magento CMS Notification](/en/snap/with-plugins.md).

Expand All @@ -148,8 +155,8 @@ Your website is now integrated with Midtrans. For more information, refer to [Co
2. Go to the Midtrans plugin configuration page.
3. Select **Production** from Environment drop-down list.
4. Enter the **Merchant ID**.
5. Enter **Client Key** with the *Client Key* retrieved from [Step 3 above](#_3-retrieving-server-key-and-client-key).
6. Enter **Server Key** with the *Server Key* retrieved from [Step 3 above](#_3-retrieving-server-key-and-client-key).
5. Enter **Client Key** with the *Client Key* retrieved from [Step 2 above](#_2-retrieving-production-server-key-and-client-key).
6. Enter **Server Key** with the *Server Key* retrieved from [Step 2 above](#_2-retrieving-production-server-key-and-client-key).

Your website is now integrated with Midtrans. For more information, refer to [Configuring PrestaShop CMS Notification](/en/snap/with-plugins.md).

Expand All @@ -159,8 +166,8 @@ Your website is now integrated with Midtrans. For more information, refer to [Co
2. Go to the Midtrans plugin configuration page.
3. Enter the **Merchant Id**.
4. Select **Production** from Environment drop-down list.
5. Enter **Client Key** with the *Client Key* retrieved from [Step 3 above](#_3-retrieving-server-key-and-client-key).
6. Enter **Server Key** with the *Server Key* retrieved from [Step 3 above](#_3-retrieving-server-key-and-client-key).
5. Enter **Client Key** with the *Client Key* retrieved from [Step 2 above](#_2-retrieving-production-server-key-and-client-key).
6. Enter **Server Key** with the *Server Key* retrieved from [Step 2 above](#_2-retrieving-production-server-key-and-client-key).

Your website is now integrated with Midtrans. For more information, refer to [Configuring OpenCart CMS Notification](/en/snap/with-plugins.md).

Expand All @@ -170,8 +177,8 @@ Your website is now integrated with Midtrans. For more information, refer to [Co
2. Go to the Midtrans plugin configuration page.
3. Go to **Settings > Payment Gateway > General**.
4. Enter the **Merchant ID**.
5. Enter **Production Server Key** with the *Server Key* retrieved from [Step 3 above](#_3-retrieving-server-key-and-client-key).
6. Enter **Production Client Key** with the *Client Key* retrieved from [Step 3 above](#_3-retrieving-server-key-and-client-key).
5. Enter **Production Server Key** with the *Server Key* retrieved from [Step 2 above](#_2-retrieving-production-server-key-and-client-key).
6. Enter **Production Client Key** with the *Client Key* retrieved from [Step 2 above](#_2-retrieving-production-server-key-and-client-key).
7. Enter **Sandbox Server Key.**
8. Enter **Sandbox Client Key**.

Expand All @@ -181,8 +188,8 @@ Your website is now integrated with Midtrans. For more information, refer to [Co

1. Login to your website as an administrator.
2. Go to the Midtrans plugin configuration page.
3. Enter **Midtrans Client Key** with the *Client Key* retrieved from [Step 3 above](#_3-retrieving-server-key-and-client-key).
4. Enter **Midtrans Server Key** with the *Server Key* retrieved from [Step 3 above](#_3-retrieving-server-key-and-client-key).
3. Enter **Midtrans Client Key** with the *Client Key* retrieved from [Step 2 above](#_2-retrieving-production-server-key-and-client-key).
4. Enter **Midtrans Server Key** with the *Server Key* retrieved from [Step 2 above](#_2-retrieving-production-server-key-and-client-key).
5. Select **Production Mode** checkbox.
6. Click **Save Changes**.

Expand All @@ -195,8 +202,8 @@ Your website is now integrated with Midtrans. For more information, refer to [Co
3. Enter **name** this text appears on the button displayed to the customer.
4. Click **Midtrans** *Plugin* option button.
5. Click **Production** *Mode* option button.
6. Enter **Server key** with the *Server Key* retrieved from [Step 3 above](#_3-retrieving-server-key-and-client-key).
7. Enter **Client key** with the *Client Key* retrieved from [Step 3 above](#_3-retrieving-server-key-and-client-key).
6. Enter **Server key** with the *Server Key* retrieved from [Step 2 above](#_2-retrieving-production-server-key-and-client-key).
7. Enter **Client key** with the *Client Key* retrieved from [Step 2 above](#_2-retrieving-production-server-key-and-client-key).
8. Click **Save**.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also please replace contact email on bottom of this page with Contact Us web page URL

Your website is now integrated with Midtrans. For more information, refer to [Configuring Drupal CMS Notification](/en/snap/with-plugins.md#drupal-plugin-notification-configuration).
Expand Down