feat: add partner's api's #351

ankitdas13 · 2023-06-13T06:56:16Z

Links for api reference you can also check this doc for more details

Account : https://razorpay.com/docs/api/partners/account-onboarding

Stakeholder : https://razorpay.com/docs/api/partners/stakeholder

Product configuration : https://razorpay.com/docs/api/partners/product-configuration

Webhook : https://razorpay.com/docs/api/partners/webhooks/#create-a-webhook

Terms & condition : https://razorpay.com/docs/api/partners/terms-conditions

Linked accont : https://razorpay.com/docs/partners/route/linked-accounts

Token Sharing : https://razorpay.com/docs/partners/aggregators/partner-auth/token-sharing

Documents:https://razorpay.com/docs/api/partners/upload-document/

Iin validation : https://razorpay.com/docs/payments/payment-methods/cards/token-hq/merchant-requestor-with-network-tokens/iin-validation

Card fingerprints : https://razorpay.com/docs/api/payments/cards/fingerprints#using-card-number

codecov-commenter · 2023-06-13T06:57:55Z

Codecov Report

Merging #351 (c0bbe20) into master (69edcbc) will decrease coverage by 1.58%.
The diff coverage is 80.00%.

@@            Coverage Diff             @@
##           master     #351      +/-   ##
==========================================
- Coverage   93.02%   91.44%   -1.58%     
==========================================
  Files          21       27       +6     
  Lines         961     1076     +115     
==========================================
+ Hits          894      984      +90     
- Misses         67       92      +25

Impacted Files	Coverage Δ
lib/resources/webhooks.js	`40.62% <40.62%> (ø)`
lib/resources/tokens.js	`92.30% <92.30%> (ø)`
lib/resources/products.js	`94.11% <94.11%> (ø)`
lib/resources/accounts.js	`94.44% <94.44%> (ø)`
lib/resources/stakeholders.js	`96.77% <96.77%> (ø)`
lib/resources/iins.js	`100.00% <100.00%> (ø)`

... and 5 files with indirect coverage changes

lib/razorpay.js

1995navinkumar · 2023-06-22T08:49:39Z

lib/resources/accounts.js

+    return {
+        create(params, callback) {
+            let { notes, ...rest } = params
+            let data = Object.assign(rest, normalizeNotes(notes));


What does this normalizeNotes do? I saw the implementation, it just adds notes to every key? The curl request didn't have this in req body.

var data = { "phone": "9000090000" } ; // gets converted to var normalised = { "notes[phone]" : "9000090000" } ;

@1995navinkumar i had checked this one, but notes are not working without normalizeNotes.

sending notes without normalizeNotes , its throw error

sending notes with normalizeNotes.

@ankitdas13 How did you test this? Using a test account? Also, can you share the request payload before and after normalizeNotes?

@1995navinkumar Yes, I have a test key, instead of creating a new object by Object.assign, I pass the params to data and it's working without normalizeNotes

create(params, callback) { return api.post({ version: 'v2', url: `${BASE_URL}`, data: params }, callback); },

payload

{ url: '/v2/accounts', form: { email: 'gauriagain.kum@examples.org', phone: '9000090000', legal_business_name: 'Acme Corp', business_type: 'partnership', customer_facing_business_name: 'Example', profile: { category: 'healthcare', subcategory: 'clinic', description: 'Healthcare E-commerce platform', addresses: [Object], business_model: 'Online Clothing ( men, women, ethnic, modern ) fashion and lifestyle, accessories, t-shirt, shirt, track pant, shoes.' }, legal_info: { pan: 'AAACL1234C', gst: '18AABCU9603R1ZM' }, brand: { color: 'FFFFFF' }, notes: { internal_ref_id: '123123' }, contact_name: 'Gaurav Kumar', contact_info: { chargeback: [Object], refund: [Object], support: [Object] }, apps: { websites: [Array], android: [Array], ios: [Array] } } }

Should I remove the normalizeNotes from other methods after testing?

@1995navinkumar reverted previous changes except client validation

1995navinkumar · 2023-06-22T08:56:16Z

lib/resources/accounts.js

+        uploadAccountDoc(accountId, params, callback) {
+
+            if (!accountId) {
+                return Promise.reject("Account Id is mandatroy");


Question : Do we usually validate params in client? Why do we have validation only for this method?

@1995navinkumar We only validate the id, Is this the right way to do it or should we remove it ?

Wouldn't the API return an error if account id is not passed? If yes, should we just throw the error which API returns?

Also, I don't see the account ID check in other functions in this file. Account id should be mandatory in all cases right?

@dhwanilvyas yes its manadatory in all also if the account id is not passed then api throw The requested URL was not found on the server.

lib/resources/iins.js

lib/resources/products.js

dhwanilvyas · 2023-06-23T06:51:10Z

lib/resources/orders.js

      let { amount, currency, receipt, partial_payment,payment_capture, notes, method,
            ...otherParams } = params
      currency = currency || 'INR'

-      if(params.hasOwnProperty("first_payment_min_amount")){


question: is this param first_payment_min_amount removed from api request?

@dhwanilvyas earlier if the param has first_payment_min_amount property then we had to send the data in body otherwise it's not working. for your reference.

but know it is working without this check, even the param has first_payment_min_amount

dhwanilvyas · 2023-06-23T06:55:13Z

lib/resources/subscriptions.js

@@ -305,7 +305,7 @@ module.exports = function subscriptionsApi (api) {
      }, normalizeNotes(notes))

      return api.post({
-        url: 'subscription_registration/auth_links',
+        url: '/subscription_registration/auth_links',


Please test this before merging if double slash goes in request, it might fail

Yes, I checked this and there is no double slash.

attach url screenshot

1995navinkumar · 2023-06-27T04:25:31Z

test/resources/accounts.spec.js

+      method: 'POST'
+    })
+
+    rzpInstance.accounts.create(mockRequest).then((response) => {


@ankitdas13 What exactly are we testing here? If we are testing for response, then we should not Mock it. It defeats the purpose of API testing.

@1995navinkumar We are only testing API methods here by checking the URL and methods with mock url and method and we are following this in all API entity test cases.

Got it. But IMO, since we are integration something, we would also need to ensure the integration actually works instead of just testing the implementation details.
We can just write test cases for happy flows and check whether we get status 200 for all requests. We can take this up as a separate discussion as well.

lib/types/cards.d.ts

1995navinkumar

LGTM. Just added one opinion.Take final approval from Dhwanil.

ankitdas13 · 2023-06-28T08:52:53Z

lib/types/accounts.d.ts

+        };
+        document_type: string;
+    }
+


@1995navinkumar added form-data params type check for document upload api

ankitdas13 · 2023-06-28T09:02:05Z

lib/types/stakeholders.d.ts

@@ -47,7 +48,7 @@ export declare namespace Stakeholders {

    interface RazorpayStakeholderCreateRequestBody extends RazorpayStakeholderBaseRequestBody { }

-    interface RazorpayStakeholderUpdateRequestBody extends Omit<RazorpayStakeholderBaseRequestBody, 'email'> { }
+    interface RazorpayStakeholderUpdateRequestBody extends Partial<Omit<RazorpayStakeholderBaseRequestBody, 'email'>> { }


@1995navinkumar added partial because all params is optional , also checked with empty objects as well in postmen.

for your reference

1995navinkumar

LGTM. Do create separate task for using correct Content-Type for request and for testing the integration with a test account instead of mocking.

ankitdas13 added 2 commits February 22, 2023 19:30

version bump

a35e37a

update docs & api

fde71a3

ankitdas13 requested review from dhwanilvyas and 1995navinkumar June 13, 2023 08:29

ankitdas13 and others added 5 commits June 13, 2023 14:00

Merge branch 'master' into add_partner_endpoint

966bdc8

made corrections

d95616a

made corrections

5e9e780

made corrections

42da2ec

Update package-lock.json

0035d3e

ankitdas13 self-assigned this Jun 15, 2023

1995navinkumar reviewed Jun 22, 2023

View reviewed changes

lib/razorpay.js Show resolved Hide resolved

1995navinkumar reviewed Jun 22, 2023

View reviewed changes

lib/resources/iins.js Outdated Show resolved Hide resolved

1995navinkumar reviewed Jun 22, 2023

View reviewed changes

lib/resources/products.js Outdated Show resolved Hide resolved

dhwanilvyas reviewed Jun 23, 2023

View reviewed changes

ankitdas13 added 3 commits June 23, 2023 16:32

resolve pr comments

c1996d1

resolve pr comments

c22bda2

update package.json

4fa14d7

ankitdas13 requested review from dhwanilvyas and 1995navinkumar June 26, 2023 05:17

1995navinkumar reviewed Jun 27, 2023

View reviewed changes

lib/types/cards.d.ts Show resolved Hide resolved

1995navinkumar reviewed Jun 27, 2023

View reviewed changes

ankitdas13 changed the title ~~Add partner endpoint~~ feat: add partner's api's Jun 27, 2023

ankitdas13 added 2 commits June 28, 2023 11:50

remove normalizenote & clientside validation

b3f2666

revert last changes & add fileupload type

821d9e0

ankitdas13 commented Jun 28, 2023

View reviewed changes

ankitdas13 requested a review from 1995navinkumar June 28, 2023 09:02

1995navinkumar approved these changes Jun 30, 2023

View reviewed changes

Update card.md

c0bbe20

ankitdas13 added the Tested label Jun 30, 2023

ankitdas13 merged commit 69dd174 into master Jun 30, 2023
14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add partner's api's #351

feat: add partner's api's #351

ankitdas13 commented Jun 13, 2023 •

edited

codecov-commenter commented Jun 13, 2023 •

edited

1995navinkumar Jun 22, 2023 •

edited

ankitdas13 Jun 26, 2023

1995navinkumar Jun 27, 2023

ankitdas13 Jun 27, 2023

ankitdas13 Jun 28, 2023

1995navinkumar Jun 22, 2023

ankitdas13 Jun 22, 2023

dhwanilvyas Jun 23, 2023 •

edited

ankitdas13 Jun 23, 2023

dhwanilvyas Jun 23, 2023

ankitdas13 Jun 23, 2023

dhwanilvyas Jun 23, 2023

ankitdas13 Jun 23, 2023

1995navinkumar Jun 27, 2023 •

edited

ankitdas13 Jun 27, 2023

1995navinkumar Jun 27, 2023

1995navinkumar left a comment

ankitdas13 Jun 28, 2023

ankitdas13 Jun 28, 2023

1995navinkumar left a comment

feat: add partner's api's #351

feat: add partner's api's #351

Conversation

ankitdas13 commented Jun 13, 2023 • edited

codecov-commenter commented Jun 13, 2023 • edited

Codecov Report

1995navinkumar Jun 22, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dhwanilvyas Jun 23, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1995navinkumar Jun 27, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1995navinkumar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1995navinkumar left a comment

Choose a reason for hiding this comment

ankitdas13 commented Jun 13, 2023 •

edited

codecov-commenter commented Jun 13, 2023 •

edited

1995navinkumar Jun 22, 2023 •

edited

dhwanilvyas Jun 23, 2023 •

edited

1995navinkumar Jun 27, 2023 •

edited