Update Application Client

PUT/v3/partner/merchant/{merchantId}/application/{clientId}

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

What is this?

Update an existing application client for a merchant under your Partner account. Use this to modify application details such as the name, URLs, redirect URIs, public key, or active status.

When to Use

Use this endpoint when:

• An application's details need to be updated
• You need to change the redirect URIs or public key
• Activating or deactivating an application

---

How to Use

Step 1: Get the Merchant ID and Client ID

Locate the merchantId and clientId for the application you want to update. You can get the clientId from the Get Application Clients endpoint.

Step 2: Prepare the Updated Data

Gather the fields you want to update. Only include the fields that need to be changed.

Step 3: Make the PUT Request

Send the updated application data with merchantId and clientId as path parameters.

Step 4: Review the Response

Check the code field. If "SUCCESS", the application was updated.

---

Request Parameters

Pass merchantId and clientId as path parameters 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.

Example: true

---

Response Parameters

itemObject

Contains the updated application client details.

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 the application.

Example: "1647502414730379278"

clientSecretString

Client secret. Keep this confidential.

Example: "dtbDsFgbLDzGhMleKjTFZXGxrDKFnMqe"

client.publicKeyString

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 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"