Skip to main content

Update Application Client

note

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

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​

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

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"

redirectUriARRAYrequired

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.

clientIdSTRING

Unique client identifier for the application.

Example: "1647502414730379278"

clientSecretSTRING

Client secret. Keep this confidential.

Example: "dtbDsFgbLDzGhMleKjTFZXGxrDKFnMqe"

clientOBJECT

Application client keys

publicKeySTRING

Application's public key.

Example: (PEM format)

serverOBJECT

RM server keys

publicKeySTRING

RM's server public key.

Example: (PEM format)

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: []

isActiveBOOLEAN

Whether the application is active.

Example: false

redirectUriARRAY

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"

codeSTRING

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

Example: "SUCCESS"