Skip to main content

Get Application Clients

note

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

Retrieve a list of all application clients associated with a specific merchant under your Partner account. Each application client contains credentials used for OAuth authentication.

When to Use

Use this endpoint when:

  • You need to view all application clients for a merchant
  • Retrieving clientId and clientSecret for OAuth flows
  • Auditing which applications are registered for a merchant

How to Use

Endpoint
GET/v3/partner/merchant/{merchantId}/applications

Step 1: Get the Merchant ID

Locate the merchantId for the merchant whose applications you want to retrieve. You can get this from the Get Merchants endpoint.

Step 2: Make the GET Request

Include the merchantId as a path parameter in the URL. No request body is required.

Step 3: Review the Response

The response contains an items array with all application clients. Note the clientId and clientSecret — you will need these for OAuth authentication.


Request Parameters

This is a GET request with no request body. Pass the merchantId as a path parameter in the URL.


Response Parameters

itemsARRAY

List of application clients associated with the merchant.

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"

metaOBJECT

Pagination metadata.

countINTEGER

Total count of application clients.

Example: 1