Create Application Client
This endpoint is for merchants with a Partner account. To activate a Partner account, contact us.
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
▾
/v3/partner/merchant/{merchantId}/applicationStep 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.
The user ID associated with this application.
Example: "1647501978916382207"
Name of the application.
Example: "required name"
URL of the application's homepage.
Example: "https://google.com"
URL of the application's logo.
Example: "https://google.com"
URL of the privacy policy page.
Example: "https://google.com"
Allowed redirect URIs for OAuth. Must exactly match URIs registered in the Merchant Portal.
Example: ["https://google.com"]
Your application's RSA public key for JWT authentication. Wrap in PEM format.
Example: "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----"
Whether the application is active. Defaults to true if not provided.
Example: true
Response Parameters
▾
Contains the created application client details including clientId and clientSecret.
Unique client identifier for this application. Use this in your OAuth requests.
Example: "1647502414730379278"
Client secret. Keep this confidential and never expose it in client-side code.
Example: "dtbDsFgbLDzGhMleKjTFZXGxrDKFnMqe"
Application client keys
Your application's public key.
Example: (PEM format)
RM server keys
RM's server public key.
Example: (PEM format)
RM's server private key (for your reference only).
Example: (PEM format)
Application name.
Example: "required name"
Homepage URL.
Example: "https://google.com"
Logo URL.
Example: "https://storage.googleapis.com/rm-sandbox-asset/img/default-application-logo.png"
Privacy policy URL.
Example: "https://google.com"
Merchant ID this application belongs to.
Example: "1647501978894816174"
User ID who created this application.
Example: "1647501978916382207"
OAuth client products.
Example: []
Whether the application is active.
Example: false
Allowed redirect URIs.
Example: ["https://google.com"]
Creation date time of the application.
Example: "2022-03-17T07:33:34Z"
Last update date time of the application.
Example: "2022-03-17T07:36:10Z"
"SUCCESS" if the call succeeded. Otherwise returns an error code object. See Appendix 1: Error Codes.
Example: "SUCCESS"