PayerMax

https://docs.payermax.com/en
Admin
PayerMax is a global payment platform that supports 350+ payment methods across 50+ regions,...
Tokens:234,608
Snippets:1,825
Trust Score:8.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Initialize PayerMax Integration

Source: https://docs.payermax.com/en

Initial boilerplate for starting a PayerMax integration.

```java
public S|
```

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

### Public Key File Content

Source: https://docs.payermax.com/en/202606-version/developer/signature-rules.md

Example output of the generated public key file.

```text
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzN6tx98b4KZB1uqEuT7P
/nWHrYqFdiy+Kzs9KZ6JtSQWb3b45loOsdUxFeaCAt+ZJ0+fNJRDnwc7AiKOlgbw
0HT93WRVZXP6cwQV1Bg1XybBxtQE4OcEq+Uzzmd7RoBkQuNmjIUgDYtWPBSekSpZ
AhWkk4dh8Nd7Qv2BvJNNOISVFcROFgMgbGz80v6WofR4nnTEdTB+j4pR/Q4dhnIR
OlaWrai+hBPn95sahQ+Ujf7LZgLyhpyQeS+/xsLv29lDI6D+8neR1tsOYdOp8f8Q
NwDkOroMlzxkQeYsJDLpLG8p58zHSdcLOsopVe2u41uzdrQ8qjhw4FU9eBOmFite
iwIDAQAB
-----END PUBLIC KEY-----
```

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

### Payment Result Inquiry Example

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/advanced-capabilities-integration/tokenization/cash-payment-integration.md

Example of a query request to check order status and the corresponding JSON response.

```js
curl --request POST \
  --url https://pay-gate-uat.payermax.com/aggregate-pay/api/gateway/orderQuery \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'sign: FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A==' \
  --data '{
  "version": "1.4",
  "keyVersion": "1",
  "requestTime": "2022-01-17T07:51:15.597+00:00",
  "appId": "a0dddd1f622243cb9aa11234e808b5f8",
  "merchantNo": "02021382716699",
  "data": {
    "outTradeNo": "P164241068068119384" # Merchant order number
  }
}'
```

```json
{
  "msg": "Success.",
  "code": "APPLY_SUCCESS",
  "data": {
    "reference": "reference查询和回调返回",
    "country": "SA",
    "totalAmount": 10,
    "outTradeNo": "P164241068068119384",
    "currency": "SAR",
    "channelNo": "DMCP000000000177005",
    "thirdChannelNo": "4ikqJ6ktEqyRawE1dvqb9c",
    "paymentCode": "2312121212",
    "tradeToken": "T2024062702289232000001",
    "completeTime": "2023-10-20T03:28:23.092Z",
    "paymentDetails": [
      {
        "cardInfo": {
          "cardOrg": "VISA",
          "country": "SA",
          "cardIdentifierNo": "400555******0001",
          "cardIdentifierName": "**ngwei"
        },
        "paymentMethodType": "CARD",
        "paymentTokenID": "PMTOKEN20230424072005899168200035002", //This field is returned only when Token is paid
        "payAmount": 10,
        "exchangeRate": "1",
        "paymentMethod": "CARD",
        "payCurrency": "SAR"
      }
    ],
    "status": "SUCCESS",
    "resultMsg": ""
  }
}
```

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

### Direct API Response Example

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/subscription-and-auto-debit/merchants-manage-subscription-plans/card.md

The response contains a 'redirectUrl' which must be used to guide the user through the 3DS challenge process.

```json
{
    "msg": "Success.",
    "code": "APPLY_SUCCESS",
    "data": {
        // 3ds Challenge page address
        "redirectUrl": "https://cashier-n-uat.payermax.com/static/processApiV2.html?tradeToken=T2025042306527802000033&integrate=DIRECT_API&country=UN&payRequestNo=20250423060120EP4366527897000250005&merchantId=010213834784554&merchantAppId=6666c8b036a24579974497c2f9a33333&token=902170aeaadb4621af8d9530398d0efa&orderLan=en&countryLan=en&strategyLan=LUBCO&pmaxLinkV=1",
        "outTradeNo": "APIFOXDEV1745388079422",
        "tradeToken": "T2025042306527802000033",
        "status": "PENDING"
    }
}
```

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

### Create Trial Subscription Plan Request

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/subscription-and-auto-debit/payermax-manage-subscription-plans/apm.md

Example JSON request body for creating a subscription plan with a 7-day trial period configuration.

```json
{
    "version": "1.5",
    "keyVersion": "1",
    "requestTime": "2025-02-26T05:00:00+00:00",
    "appId": "6666c8b036a24579974497c2f9a33333",
    "merchantNo": "010213834784554",
    "data": {
        "subscriptionRequestId": "subscription100000000000001", // Required, merchant's unique ID for creating the subscription plan
        "userId": "test10001", // Required, user ID
        "language": "en", // Optional, language
        "callbackUrl": "http://***.com/notifyUrl/subscription",  // Required, notification URL for subscription and payment results
        "subscriptionPlan": { // Required, subscription plan information
            "subject": "subject", // Required, title
            "description": "PMMAX First Periodic Payment", // Optional, description
            "totalPeriods": 24, // Required, total number of periods
            "periodRule": { // Required, payment rule
                "periodUnit": "M", // Required, payment frequency: Monthly (M), Daily (D), Weekly (W), Yearly (Y)
                "periodCount": 2 // Required, payment every 2 months
            },
             // Amount per payment period
            "periodAmount": { // Required
                "amount": 10.0, // Required, subscription amount
                "currency": "KRW" // Required, subscription currency
            },
            // Trial period parameters, optional. If `trialConfig` is included, the fields below are required.
            "trialConfig": {
                "trialAmount": { // Trial period amount
                    "amount": 4, // Amount must be >= 0. amount=0 indicates a free trial, amount>0 indicates a low-price trial.
                    "currency": "KRW"
                },
                "trialDays": 7 // Trial days, must be greater than 0
            }
        }
    }
}
```

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

### Create Promotional Subscription Plan

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/subscription-and-auto-debit/payermax-manage-subscription-plans/apm.md

Example request structure for creating a subscription plan with a promotional trial period.

```APIDOC
## Create Subscription Plan

### Description
Creates a new subscription plan with an optional promotional trial period configuration.

### Request Body
- **version** (string) - Required - API version
- **keyVersion** (string) - Required - Key version
- **requestTime** (string) - Required - ISO 8601 timestamp
- **appId** (string) - Required - Application ID
- **merchantNo** (string) - Required - Merchant number
- **data** (object) - Required - Subscription request data
  - **subscriptionRequestId** (string) - Required - Merchant's unique ID for the subscription plan
  - **userId** (string) - Required - User ID
  - **language** (string) - Optional - Language code
  - **callbackUrl** (string) - Required - Notification URL
  - **subscriptionPlan** (object) - Required - Plan details
    - **subject** (string) - Required - Plan title
    - **description** (string) - Optional - Plan description
    - **totalPeriods** (integer) - Required - Total number of periods
    - **periodRule** (object) - Required - Payment frequency rules
      - **periodUnit** (string) - Required - M, D, W, or Y
      - **periodCount** (integer) - Required - Frequency count
    - **periodAmount** (object) - Required - Standard payment amount
      - **amount** (number) - Required - Amount value
      - **currency** (string) - Required - Currency code
    - **trialPeriodConfig** (object) - Optional - Promotional period configuration
      - **trialPeriodCount** (integer) - Required - Number of promotional periods
      - **trialPeriodAmount** (object) - Required - Promotional amount
        - **amount** (number) - Required - Promotional amount value
        - **currency** (string) - Required - Currency code

### Request Example
{
    "version": "1.5",
    "keyVersion": "1",
    "requestTime": "2025-02-26T05:00:00+00:00",
    "appId": "6666c8b036a24579974497c2f9a33333",
    "merchantNo": "010213834784554",
    "data": {
        "subscriptionRequestId": "subscription100000000000001",
        "userId": "test10001",
        "language": "en",
        "callbackUrl": "http://***.com/notifyUrl/subscription",
        "subscriptionPlan": {
            "subject": "subject",
            "description": "PMMAX First Periodic Payment",
            "totalPeriods": 24,
            "periodRule": {
                "periodUnit": "M",
                "periodCount": 2
            },
            "periodAmount": {
                "amount": 10.0,
                "currency": "KRW"
            },
            "trialPeriodConfig": {
                "trialPeriodCount": 2,
                "trialPeriodAmount": {
                    "amount": 3.0,
                    "currency": "KRW"
                }
            }
        }
    }
}
```

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

### Create First n Periods Promotional Subscription Plan

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/subscription-and-auto-debit/payermax-manage-subscription-plans/googlepay.md

Configures a subscription plan with a promotional price for the first n periods using the trialPeriodConfig object.

```APIDOC
## Create First n Periods Promotional Subscription Plan

### Description
Configures a subscription plan that includes a promotional price for the initial periods defined by trialPeriodConfig.

### Request Body
- **subscriptionRequestId** (string) - Required - Merchant's unique ID for creating the subscription plan
- **userId** (string) - Required - User ID
- **language** (string) - Optional - Language
- **callbackUrl** (string) - Required - Notification URL for subscription and payment results
- **subscriptionPlan** (object) - Required - Subscription plan information
  - **subject** (string) - Required - Title
  - **description** (string) - Optional - Description
  - **totalPeriods** (integer) - Required - Total number of periods
  - **periodRule** (object) - Required - Payment frequency rules
  - **periodAmount** (object) - Required - Standard amount per period
  - **trialPeriodConfig** (object) - Optional - Promotional period configuration
    - **trialPeriodCount** (integer) - Required - Number of promotional periods
    - **trialPeriodAmount** (object) - Required - Promotional period payment amount

### Request Example
{
    "version": "1.5",
    "keyVersion": "1",
    "requestTime": "2025-02-26T05:00:00+00:00",
    "appId": "6666c8b036a24579974497c2f9a33333",
    "merchantNo": "010213834784554",
    "data": {
        "subscriptionRequestId": "subscription100000000000001",
        "userId": "test10001",
        "language": "en",
        "callbackUrl": "http://***.com/notifyUrl/subscription",
        "subscriptionPlan": {
            "subject": "subject",
            "description": "PMMAX First Periodic Payment",
            "totalPeriods": 24,
            "periodRule": {
                "periodUnit": "M",
                "periodCount": 2
            },
            "periodAmount": {
                "amount": 10.0,
                "currency": "USD"
            },
            "trialPeriodConfig": {
                "trialPeriodCount": 2,
                "trialPeriodAmount": {
                    "amount": 3.0,
                    "currency": "USD"
                }
            }
        }
    }
}
```

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

### Payment Result Notification Example

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/advanced-capabilities-integration/tokenization/cash-payment-integration.md

Example of a POST request for a token payment notification and the required merchant response.

```js
curl --request POST \
  --url https://pay-gate-uat.payermax.com/collectResultNotifyUrl \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'sign: FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A==' \
  --data '{
    "appId": "ff4f0273d212386sdxxxxxxxxx",
    "code": "APPLY_SUCCESS",
    "data": {
        "country": "UN",
        "totalAmount": 9.99,
        "channelNo": "PPC8xxxx017516227301xxxx",
        "outTradeNo": "ORDxxxx51006xx",
        "completeTime": "2025-07-04T09:52:11.249Z",
        "currency": "USD",
        "tradeToken": "T20xxx704098xxxx349xx",
        "paymentDetails": [
            {
                "cardInfo": {
                    "cardOrg": "VISA",
                    "country": "NZ",
                    "cardIdentifierNo": "123456******1234",
                    "cardIdentifierName": "Z**************"
                },
                "paymentTokenID": "PMTOKEN20230424072005899168200035002", //This field is returned only when Token is paid
                "paymentMethodType": "CARD"
            }
        ],
        "thirdChannelNo": "151764",
        "status": "SUCCESS"
    },
    "keyVersion": "1",
    "merchantNo": "P01010118640464",
    "msg": "Success.",
    "notifyTime": "2025-07-04T09:52:11.280Z",
    "notifyType": "PAYMENT"
}'
```

```json
{
  "msg": "Success",
  "code": "SUCCESS"
}
```

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

### Capture Result Notification Example

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/advanced-capabilities-integration/auth-capture.md

Example of the JSON payload received by the merchant server when the capture status is updated.

```json
{
"keyVersion": "1",
"appId": "5f843bfc8cec49c2b8e9e99847325548",
"merchantNo": "P01010114418097",
"notifyTime": "2023-07-23T00:00:01 +0000",
"notifyType": "CAPTURE", // Type of payment request
"data": {
"captureNo": "20230806235954ED7856775040587834005", // paymermax unique payment request number
"requestId":"xxxxx", // requestId accepted for this request
"outTradeNo":"xxxxxxxx",
"status": "SUCCESS", // SUCCESS FAILED
"isFinal": true,
"createdTime": "2023-08-06T23:50:59 +0000",
"succeededTime": "2023-08-06T23:50:59 +0000", // Success time
"failedTime": null, // Failure time
"errorCode": null, // Failure reason
"errorMsg": null
}
}
```

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

### PMdropin.create

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/payment-acceptance/drop-in/card.md

Initializes a card component instance with the specified configuration options.

```APIDOC
## PMdropin.create(ComponentName, Options)

### Description
Initializes a component instance. Use 'Card' as the ComponentName.

### Parameters
- **ComponentName** (String) - Required - The name of the component to instantiate (e.g., 'Card').
- **Options** (Object) - Required - Configuration object containing clientKey, sessionKey, and optional UI/behavior settings.
```

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

### Authorization Notification JSON Example

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/advanced-capabilities-integration/auth-capture.md

Example payload received via the AuthResultNotifyUrl API, containing captureMode and authorizationType fields.

```json
{
  "code": "APPLY_SUCCESS",
  "msg": "",
  "keyVersion": "1",
  "appId": "3b242b56a8b64274bcc37dac281120e3",
  "merchantNo": "020213827212251",
  "notifyTime": "2022-01-17T09:33:54.540+00:00",
  "notifyType": "PAYMENT",
  "data": {
    "outTradeNo": "P1642410680681",
    "tradeToken": "T2024062702289232000001",
    "totalAmount": 10000,
    "captureMode":"MANUAL",
    "authorizationType":"FINAL_AUTH",
    "currency": "IDR",
    "country": "ID",
    "status": "SUCCESS",
    "completeTime": "2023-10-20T03:28:23.092Z",
    "paymentDetails": [
      {
        "paymentMethodType": "CARD"
      }
    ],
    "reference": "020213827524152"
  }
}
```

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

### PMdropin.create

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/payment-acceptance/drop-in/googlepay.md

Initializes a payment component instance with the specified configuration options.

```APIDOC
## PMdropin.create(ComponentName, Options)

### Description
Initializes a new payment component instance.

### Parameters
- **ComponentName** (string) - Required - The name of the component (e.g., 'applepay').
- **Options** (object) - Required - Configuration object:
  - **clientKey** (string) - Required - Client key.
  - **sessionKey** (string) - Required - Session key.
  - **sandbox** (boolean) - Optional - Whether to use sandbox mode (default: false).
  - **theme** (string) - Optional - UI theme (default: 'light').
  - **payButtonStyle** (string) - Optional - Style for the payment button.
```

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

### Initialize and Mount GooglePay

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/payment-acceptance/drop-in/googlepay.md

Create the Google Pay instance using the keys obtained from the session API and mount it to the specified DOM element.

```js
const googlePay = PMdropin.create('googlepay', {
    clientKey: "8eef820ecbd443b7a608c2e0863750eb",
    sessionKey: "0fdde7eda5fe4cc28ca8fdc759e28dc1",
    sandbox: true,
    payButtonConfig: {   
        buttonRadius: "12",
        buttonColor: "white",
        buttonType: "order",
        buttonLocale: "en",
        width: "240px",
        height: "40px"
    }
});
//Mount the button
googlePay.mount('.frame-googlepay');
```

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

### Capture API Request and Response Examples

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/advanced-capabilities-integration/auth-capture.md

Examples of the JSON payload for initiating a capture request and the corresponding response from the PayerMax API.

```js
{
    "version": "1.4",
    "keyVersion": "1",
    "requestTime": "2024-11-06T11:56:13.000+08:00",
    "appId": "8f8b0895b60f41abbdb05405052971c8",
    "merchantNo": "P01010114178824",
    "data": {
        "requestId": "xxxxx",
        "outTradeNo": "xxxxxxxx",
        "currency": "USD",
        "amount": 100
    }
}
```

```js
{
"msg": "Success.",
"code": "APPLY_SUCCESS",
"data": {
"captureNo": "20230806235954ED7856775040587834005", // PayerMax unique payment request number
"requestId":"xxxxx", // requestId accepted for this request
"outTradeNo":"xxxxxxxx",
"amount":10,
"currency":"SAR"
"status": "PENDING", // SUCCESS FAILED
"isFinal": true,
"createdTime": "2023-08-06T23:50:59 +0000",
"succeededTime": null, // Success time
"failedTime": null, // Failure time
"errorCode": null, // Failure reason
"errorMsg": null
}
}
```

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

### Query Subscription Response Parameters

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/subscription-and-auto-debit/payermax-manage-subscription-plans/applepay.md

Example response containing subscription status and payment details for multiple periods.

```json
{
    "msg": "Success.",
    "code": "APPLY_SUCCESS",
    "data": {
        "subscriptionRequestId": "requestMWRkgX5iHaTmf45ePdEP",
        "merchantNo": "P01010113865434",
        "userId": "10003",
        "subscriptionPlan": {
            "subscriptionNo": "SUB20221212174716894496912",
            "subscriptionStatus": "ACTIVE" // Subscription status
        },
        "subscriptionPaymentDetails": [
            {
                "subscriptionIndex": 0, // Number of deduction periods: the first period
                "paymentStatus": "SUCCESS", // Order status for this period
                "periodStartTime": "2025-01-13T15:59:59+0000", // Start time of this period
                "periodEndTime": "2025-02-13T15:59:59+0000", // End time of this period
                "payAmount": { // Payment amount
                    "amount": 100,
                    "currency": "SAR"
                },
                "paymentMethodType": "APPLEPAY",
                "cardOrg": "VISA",
                "lastPaymentInfo": { 
                    "tradeToken": "T20221212174800970116912", // Payment order number. The tradeToken can be used for refund.
                    "lastPaymentStatus": "SUCCESS", // Latest deduction result
                    "payTime": "2025-01-12T15:59:59+0000" // Payment time
                }
            },
            {
                "subscriptionIndex": 1, // Number of deduction periods: the second period
                "paymentStatus": "PENDING", // Order status for this period
                "periodStartTime": "2025-02-13T15:59:59+0000", // Start time of this period
                "periodEndTime": "2025-03-13T15:59:59+0000", // End time of this period
                "payAmount": { // Payment amount
                    "amount": 100,
                    "currency": "SAR"
                },
                "paymentMethodType": "CARD",
                "cardOrg": "VISA",
                "lastPaymentInfo": { 
                    "tradeToken": "T20221212174800970116912", // Payment order number. The tradeToken can be used for refund.
                    "lastPaymentStatus": "FAILED", // Latest deduction result
                    "payTime": "2025-02-12T15:59:59+0000", // Payment time
                    "errorCode": "xxxx", // Error code for deduction failure
                    "errorMsg": "xxxx" // Reason for deduction failure
                }
            }
        ]
    }
}
```

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

### Private Key File Content

Source: https://docs.payermax.com/en/202606-version/developer/signature-rules.md

Example output of the generated private key file in PKCS#8 format.

```text
-----BEGIN PRIVATE KEY-----
MIIEwAIBADANBgkqhkiG9w0BAQEFAASCBKowggSmAgEAAoIBAQDM3q3H3xvgpkHW
6oS5Ps/+dYetioV2LL4rOz0pnom1JBZvdvjmWg6x1TEV5oIC35knT580lEOfBzsC
Io6WBvDQdP3dZFVlc/pzBBXUGDVfJsHG1ATg5wSr5TPOZ3tGgGRC42aMhSANi1Y8
FJ6RKlkCFaSTh2Hw13tC/YG8k004hJUVxE4WAyBsbPzS/pah9HiedMR1MH6PilH9
Dh2GchE6VpatqL6EE+f3mxqFD5SN/stmAvKGnJB5L7/Gwu/b2UMjoP7yd5HW2w5h
06nx/xA3AOQ6ugyXPGRB5iwkMuksbynnzMdJ1ws6yilV7a7jW7N2tDyqOHDgVT14
E6YWK16LAgMBAAECggEBAKFLC8yZdixHGPzohHgH4N94jsptjae9kDcfG4dB3y8y
60r0gv9wlbMiotOYOHGkssKFaFWQCTESEz4aEOJDMqMcCKaeELGgPuUAqWLjcFmq
fNNaJ0EeAMqI2GG/jQmzmbwjpqApS1P+iHUi0rh9e7gta/YOl2hzbgMO7W6XFivQ
pMIQZQE0WpmpK8cNgev/Xog8ZnHFC6XGUgK+mDVvJMYwmywUPIfLw2fvAZ29Qogt
qiGeFCJSwAL1VkxryXSjJJBKuoc3cXEcq/hjhz6G9rvd50Lj2kCWMd8iqm/dtFyh
DnT5WSFYNPIH0Up9qtqeP+TqgI/SrztAVHgUXVB2ABkCgYEA9cSeHG04Pj3p9ZCe
Cc6qb6L2kFphb62BhmUSHZ50p6X1KsSMw4wnzbrgrvcSe97iWZNLC536eQVHE5gL
4ZjIxylYkp+FuuPHMIDseASR2pNmY2sJ83iTB4C9Y+37+64wBceFiXWBERdJA1t2
MnzWLR8ijFfmHQ4KX3DJOhR05qUCgYEA1WYroahttPyvMFHdmcCphF9jhF3U6SGu
VndwTtqaGLHzCmSvHxLFyd8ziw/F344IGIn8fIbOqhFAijyliD53kGMiKSUqMH4Q
eP2RfxGrZqek3f6pvyUtxfjXAh6+7pfL46u0AzmyvcpaGXqQToecCF43MCdbxh7Z
3CViGfBcWW8CgYEAvJRcufU4ddHuJoYMLfxNHRIPXV5sa1PYEjaVevKuEkGuaF2e
oSF3HU4qvzZIEZJJXnA94jEbEydwjWFapIUmcmOQWhlbdLb4jYgvajwfanc11k04
uoAnWVd4eygN9OWIZbbeCUaHfYS/ensAq+bMNJ0yVjvQDzVJ0kfpr84okR0CgYEA
mBroNKTx9ZQ6Zu2jT2lVKuY27+1VygpY0ob1xS7psXp9asYTUMm3s0ll2tQWTV9W
g+8uya/o9K2xXBcYQgGMhZ0zhzJXXRMuOJ88qt70VgpeaGGRqo4cj0TsNDWoEDag
fJoxiC8DKWZnTEvhOihM3mYRXkBfmNr6nIEE6Mo7eP8CgYEA8KqzIk+5On3xmeES
fQcLPYiaO9Hlttc7flyIpUL52Og7S1T/ekdiBVIDlePpjRx5H0iCtANyWmQq0Xbf
SseQ9SFJ/4DLvDMawhvolmxHs98PNa8xZ9KdXgUNc7RcewUVhK2aLkxUQKNO0lww
GGDGWfvePWzlVotJd0bM+a/X4qg=
-----END PRIVATE KEY-----
```

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

### Response for removePaymentToken

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/subscription-and-auto-debit/merchants-manage-subscription-plans/apm.md

Example response indicating the successful deletion of the payment token.

```json
{
  "code": "APPLY_SUCCESS",
  "msg": "Success",
  "data": {
    "paymentTokenID": "PMTOKEN20230424072005899168200035002",
    "userId": "Test",
    "paymentTokenStatus": "Deleted"
  }
}
```

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

### Create n-Day Trial Subscription Plan Request

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/subscription-and-auto-debit/payermax-manage-subscription-plans/applepay.md

JSON request body for creating a subscription plan that includes a trial period configuration.

```json
{
    "version": "1.5",
    "keyVersion": "1",
    "requestTime": "2025-02-26T05:00:00+00:00",
    "appId": "6666c8b036a24579974497c2f9a33333",
    "merchantNo": "010213834784554",
    "data": {
        "subscriptionRequestId": "subscription100000000000001", // Required, merchant's unique ID for creating the subscription plan
        "userId": "test10001", // Required, user ID
        "language": "en", // Optional, language
        "callbackUrl": "http://***.com/notifyUrl/subscription",  // Required, notification URL for subscription and payment results
        "subscriptionPlan": { // Required, subscription plan information
            "subject": "subject", // Required, title
            "description": "PMMAX First Periodic Payment", // Optional, description
            "totalPeriods": 24, // Required, total number of periods
            "periodRule": { // Required, payment rule
                "periodUnit": "M", // Required, payment frequency: Monthly (M), Daily (D), Weekly (W), Yearly (Y)
                "periodCount": 2 // Required, payment every 2 months
            },
             // Amount per payment period
            "periodAmount": { // Required
                "amount": 10.0, // Required, subscription amount
                "currency": "USD" // Required, subscription currency
            },
            // Trial period parameters, optional. If `trialConfig` is included, the fields below are required.
            "trialConfig": {
                "trialAmount": { // Trial period amount
                    "amount": 4, // Amount must be >= 0. amount=0 indicates a free trial, amount>0 indicates a low-price trial.
                    "currency": "USD"
                },
                "trialDays": 7 // Trial days, must be greater than 0
            }
        }
    }
}
```

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

### Refund Inquiry Request

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/related-capabilities-integration/refund-integration.md

Example of a request to query the status of a specific refund.

```json
curl --request POST \
  --url https://pay-gate-uat.payermax.com/aggregate-pay/api/gateway/refundQuery \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'sign: FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A==' \
  --data '{
  "version": "1.4",
  "keyVersion": "1",
  "requestTime": "2022-01-17T07:01:23.737+00:00",
  "appId": "a0dddd1f622243cb9aa1b676e808b5f8",
  "merchantNo": "02021382719993",
  "data": {
    "outRefundNo": "R1642411016202"
  }
}'
```

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

### Payment API Response

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/advanced-capabilities-integration/auth-capture/direct-api-integration.md

Example of a successful response returned by the orderAndPay interface.

```json
{
    "msg": "Success.",
    "code": "APPLY_SUCCESS",
    "data": {
        "outTradeNo": "test598684645",
        "tradeToken": "T20290323107917693601854",
        "status": "SUCCESS"
    }
}
```

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

### Create Subscription Plan Request

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/subscription-and-auto-debit/payermax-manage-subscription-plans/card.md

JSON request body for defining a subscription plan with trial days and promotional period configurations.

```json
{
    "version": "1.5",
    "keyVersion": "1",
    "requestTime": "2025-02-26T05:00:00+00:00",
    "appId": "6666c8b036a24579974497c2f9a33333",
    "merchantNo": "010213834784554",
    "data": {
        "subscriptionRequestId": "subscription100000000000001", // Required, merchant's unique ID for creating the subscription plan
        "userId": "test10001", // Required, user ID
        "language": "en", // Optional, language
        "callbackUrl": "http://***.com/notifyUrl/subscription",  // Required, notification URL for subscription and payment results
        "subscriptionPlan": { // Required, subscription plan information
            "subject": "subject", // Required, title
            "description": "PMMAX First Periodic Payment", // Optional, description
            "totalPeriods": 24, // Required, total number of periods
            "periodRule": { // Required, payment rule
                "periodUnit": "M", // Required, payment frequency: Monthly (M), Daily (D), Weekly (W), Yearly (Y)
                "periodCount": 2 // Required, payment every 2 months
            },
             // Formal period payment amount
            "periodAmount": { // Required
                "amount": 10.0, // Required, subscription amount
                "currency": "USD" // Required, subscription currency
            },
            // Promotional period configuration
            "trialPeriodConfig": { // Optional, promotional period configuration
                "trialPeriodCount": 2, // Number of promotional periods
                "trialPeriodAmount": { // Promotional period payment amount
                    "amount": 3.0, // Promotional period payment amount. An amount of 0 indicates the promotional period is free.
                    "currency": "USD" // Promotional period payment currency
                }
            },
            // Trial days parameters, optional. If `trialConfig` is included, the fields below are required.
            "trialConfig": {
                "trialAmount": { // Trial period amount
                    "amount": 0.99, // Amount must be >= 0. amount=0 indicates a free trial, amount>0 indicates a low-price trial.
                    "currency": "USD"
                },
                "trialDays": 7 // Trial days, must be greater than 0
            }
        }
    }
}
```

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

### Apply Drop-in Session Request Parameters

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/subscription-and-auto-debit/merchants-manage-subscription-plans/googlepay.md

Example JSON structure for the applyDropinSession request.

```json
{
  "version": "1.5",
  "keyVersion": "1",
  "requestTime": "2022-01-17T09:05:52.194+00:00",
  "appId": "3b242b56a8b64274bcc37dac281120e3",
  "merchantNo": "020213827212251",
  "data": {
    "totalAmount": "10", // Direct debit amount
    "mitType": "SCHEDULED", // Required, value is SCHEDULED or UNSCHEDULED
    "currency": "USD", // Required
    "country": "SA", // Not required
    "userId": "U10001", // Required, user ID
    "componentList": [ // Required, payment methods supported by the component
      "GOOGLEPAY"
    ]
  }
}
```

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

### PMdropin.create

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/payment-acceptance/drop-in/applepay.md

Initializes the ApplePay component with the specified configuration options.

```APIDOC
## PMdropin.create(ComponentName, Options)

### Description
Initializes the ApplePay component instance.

### Parameters
- **ComponentName** (string) - Required - Must be 'applepay'.
- **Options** (object) - Required - Configuration object.
  - **clientKey** (string) - Required - The client key.
  - **sessionKey** (string) - Required - The session key.
  - **sandbox** (boolean) - Optional - Whether to use sandbox mode (default: false).
  - **theme** (string) - Optional - UI theme (default: 'light').
  - **payButtonStyle** (string) - Optional - Style configuration for the ApplePay button.
```

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

### PAN_ONLY Response Parameters

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/subscription-and-auto-debit/merchants-manage-subscription-plans/googlepay.md

Example JSON response structure for a successful PAN_ONLY request.

```json
// PAN_ONLY Response Parameters
{
    "msg": "Success.",
    "code": "APPLY_SUCCESS",
    "data": {
        // 3ds address
        "redirectUrl": "https://cashier-n.payermax.com/index.html#/cashier/home?merchantId=020213827212251&merchantAppId=3b242b56a8b64274bcc37dac281120e3&country=ID&tradeToken=TOKEN20220117091121294138752&language=en&token=IHjqkZ8%2F%2FFcnfDPxWTvJFOrulUAKfXFUkxHJSiTdlnjnX1G6AOuTiSl6%2BN05EzxTaJkcSsSyGh5a1q%2FACwWN0sDD%2FgwY5YdWu3ghDcH2wqm%2BJIcEh0qZqo%2BQFnXp65bvkLZnY7VO7HwZGzyrpMBlPhfRCQxwBbc6lJcSYuPf%2Fe8%3D&amount=10000¤cy=IDR&frontCallbackUrl=https%3A%2F%2Fwww.payermax.com",
        "outTradeNo": "APIFOXDEV1745388079422",
        "tradeToken": "T2025042306527802000033",
        "status": "SUCCESS"
    }
}
```

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

### Create Subscription Plan Request

Source: https://docs.payermax.com/en/202606-version/acquiring/start-integration/subscription-and-auto-debit/payermax-manage-subscription-plans/applepay.md

JSON request body for defining a subscription plan with a 7-day trial and tiered promotional pricing.

```json
{
    "version": "1.5",
    "keyVersion": "1",
    "requestTime": "2025-02-26T05:00:00+00:00",
    "appId": "6666c8b036a24579974497c2f9a33333",
    "merchantNo": "010213834784554",
    "data": {
        "subscriptionRequestId": "subscription100000000000001", // Required, merchant's unique ID for creating the subscription plan
        "userId": "test10001", // Required, user ID
        "language": "en", // Optional, language
        "callbackUrl": "http://***.com/notifyUrl/subscription",  // Required, notification URL for subscription and payment results
        "subscriptionPlan": { // Required, subscription plan information
            "subject": "subject", // Required, title
            "description": "PMMAX First Periodic Payment", // Optional, description
            "totalPeriods": 24, // Required, total number of periods
            "periodRule": { // Required, payment rule
                "periodUnit": "M", // Required, payment frequency: Monthly (M), Daily (D), Weekly (W), Yearly (Y)
                "periodCount": 2 // Required, payment every 2 months
            },
             // Formal period payment amount
            "periodAmount": { // Required
                "amount": 10.0, // Required, subscription amount
                "currency": "USD" // Required, subscription currency
            },
            // Promotional period configuration
            "trialPeriodConfig": { // Optional, promotional period configuration
                "trialPeriodCount": 2, // Number of promotional periods
                "trialPeriodAmount": { // Promotional period payment amount
                    "amount": 3.0, // Promotional period payment amount. An amount of 0 indicates the promotional period is free.
                    "currency": "USD" // Promotional period payment currency
                }
            },
            // Trial period parameters, optional. If `trialConfig` is included, the fields below are required.
            "trialConfig": {
                "trialAmount": { // Trial period amount
                    "amount": 0.99, // Amount must be >= 0. amount=0 indicates a free trial, amount>0 indicates a low-price trial.
                    "currency": "USD"
                },
                "trialDays": 7 // Trial days, must be greater than 0
            }
        }
    }
}
```
Tokens:
Raw