Create Application Client

POST/v3/partner/merchant/{merchantId}/application

This endpoint is for merchants with a Partner account. To activate a Partner account, contact us.

What is this?

Create a new application client for a merchant under your Partner account. An application client contains the clientId and clientSecret used for OAuth authentication with the RM API.

When to Use

Use this endpoint when:

• A new application needs to be registered for a merchant
• Setting up OAuth credentials for a merchant's integration

---

How to Use

Step 1: Get the Merchant ID

Locate the merchantId for the merchant you want to create an application for. You can get this from the Get Merchants endpoint.

Step 2: Prepare Application Details

Gather the required information:

• Application name
• Homepage URL, logo URL, and privacy policy URL
• Redirect URIs for OAuth
• RSA public key in PEM format

Step 3: Make the POST Request

Send the application details with the merchantId as a path parameter.

Step 4: Store the Credentials

In the response, note the clientId and clientSecret. These are needed for OAuth authentication and cannot be retrieved again later.

---

Request Parameters

Pass the merchantId as a path parameter in the URL.

userIdStringrequired

The user ID associated with this application.

Example: "1647501978916382207"

nameStringrequired

Name of the application.

Example: "required name"

homePageUrlStringrequired

URL of the application's homepage.

Example: "https://google.com"

logoUrlStringrequired

URL of the application's logo.

Example: "https://google.com"

privacyPolicyUrlStringrequired

URL of the privacy policy page.

Example: "https://google.com"

redirectUriArray[String]required

Allowed redirect URIs for OAuth. Must exactly match URIs registered in the Merchant Portal.

Example: ["https://google.com"]

publicKeyStringrequired

Your application's RSA public key for JWT authentication. Wrap in PEM format.

Example: "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----"

isActiveBoolean

Whether the application is active. Defaults to true if not provided.

Example: true

---

Response Parameters

itemObject

Contains the created application client details including clientId and clientSecret.

Example: (See below)

codeString

"SUCCESS" if the call succeeded. Otherwise returns an error code object. See Appendix 1: Error Codes.

Example: "SUCCESS"

---

Application object (item):

clientIdString

Unique client identifier for this application. Use this in your OAuth requests.

Example: "1647502414730379278"

clientSecretString

Client secret. Keep this confidential and never expose it in client-side code.

Example: "dtbDsFgbLDzGhMleKjTFZXGxrDKFnMqe"

client.publicKeyString

Your application's public key.

Example: (PEM format)

server.publicKeyString

RM's server public key.

Example: (PEM format)

server.privateKeyString

RM's server private key (for your reference only).

Example: (PEM format)

nameString

Application name.

Example: "required name"

homePageUrlString

Homepage URL.

Example: "https://google.com"

logoUrlString

Logo URL.

Example: "https://storage.googleapis.com/rm-sandbox-asset/img/default-application-logo.png"

privacyPolicyUrlString

Privacy policy URL.

Example: "https://google.com"

merchantIdString

Merchant ID this application belongs to.

Example: "1647501978894816174"

userIdString

User ID who created this application.

Example: "1647501978916382207"

oAuthClientProductsArray

OAuth client products.

Example: []

isActiveBool

Whether the application is active.

Example: false

redirectUriArray[String]

Allowed redirect URIs.

Example: ["https://google.com"]

createdAtDateTime

Creation date time of the application.

Example: "2022-03-17T07:33:34Z"

updatedAtDateTime

Last update date time of the application.

Example: "2022-03-17T07:36:10Z"