xendit-node - npm Package Compare versions

Comparing version 1.21.10 to 1.21.11

package.json

 {
   "name": "xendit-node",
-  "version": "1.21.10",
+  "version": "1.21.11",
   "description": "NodeJS client for Xendit API",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -119,2 +119,16 @@ # Xendit API Node.js Client
     - [Create fee rules](#create-fee-rules)
+  - [Payment Request](#payment-request)
+    - [Create payment request](#create-payment-request)
+    - [List payment requests](#list-payment-requests)
+    - [Get payment request details by ID](#get-payment-request-details-by-id)
+    - [confirm payment request](#confirm-payment-request)
+    - [resend auth for payment request](#resend-auth-for-payment-request)
+  - [Payment Method](#payment-method)
+    - [Create payment method](#create-payment-method)
+    - [List payment methods](#list-payment-methods)
+    - [Get payment method details by ID](#get-payment-method-details-by-id)
+    - [Authorize Payment method](#authorize-payment-method)
+    - [Update Payment method](#update-payment-method)
+    - [Expire Payment method](#expire-payment-method)
+    - [List payments by payment method id](#list-payments-by-payment-method-id)
   - [Refund Services](#refund-services)
@@ -1605,4 +1619,241 @@ - [Create refund](#create-refund-1)
 })
+
 ```
+### Payment Request
 
+Instanitiate Payment Request using constructor that has been injected with Xendit keys
+
+```js
+const { PaymentRequest } = x;
+const r = new PaymentRequest();
+```
+
+Example: Create a Payment Request
+
+```js
+
+
+r.createPaymentRequest({
+      amount: 1500,
+      currency: 'PHP',
+      payment_method: {
+        type: 'EWALLET',
+        ewallet: {
+          channel_code: 'GRABPAY',
+          channel_properties: {
+            success_return_url: 'https://redirect.me/goodstuff',
+            failure_return_url: 'https://redirect.me/badstuff',
+          },
+        },
+        reusability: 'ONE_TIME_USE',
+      }
+}).then(({ id }) => {
+  console.log(`payment request created with ID: ${id}`);
+});
+```
+
+Refer to [Xendit API Reference](https://developers.xendit.co/api-reference/#payment-requests) for more info about methods' parameters
+
+
+#### Create payment request
+
+```ts
+r.createPaymentRequest(data: {
+    currency: PaymentRequestCurrencies;
+    amount: number;
+    reference_id?: string;
+    customer_id?: string;
+    country: PaymentRequestCountries;
+    description?: string;
+    payment_method: object;
+    channel_properties?: PaymentRequestChannelProperties;
+    metadata?: object;
+    idempotency_key?: string;
+    for_user_id?: string;
+})
+```
+
+#### List payment requests
+
+```ts
+r.listpaymentrequests(data: {
+    id?: string;
+    reference_id?: string;
+    customer_id?: string;
+    type?: PaymentRequestType;
+    channel_code?: string;
+    status?: PaymentRequestStatuses;
+    limit?: number;
+    after_id?: string;
+    before_id?: string;
+    for_user_id?: string;
+})
+```
+
+#### Get payment request details by ID
+
+```ts
+r.getPaymentRequestByID(data: {
+    id: string;
+    for_user_id?: string;
+})
+```
+
+#### confirm payment request
+
+```ts
+r.confirmPaymentRequest(data: {
+    id: string;
+    auth_code: string;
+    idempotency_key?: string;
+    for_user_id?: string;
+})
+```
+
+#### resend auth for payment request
+
+```ts
+r.resendAuthForPaymentRequest(data: {
+    id: string;
+    idempotency_key?: string;
+    for_user_id?: string;
+})
+```
+
+
+### Payment Method 
+
+Instanitiate Payment Method using constructor that has been injected with Xendit keys
+
+```js
+const { PaymentMethod } = x;
+const r = new PaymentMethod();
+```
+
+Example: Create a Payment Method
+
+```js
+r.createPaymentMethod({
+      type: 'DIRECT_DEBIT',
+      reusability: 'ONE_TIME_USE',
+      customer_id: '16f72571-9b3a-43dc-b241-5b71f470202f',
+      country: 'ID',
+      direct_debit: {
+        channel_code: 'BRI',
+        channel_properties: {
+          mobile_number: '[phone]',
+          card_last_four: '8888',
+          card_expiry: '10/29',
+          email: '[e-mail]',
+        },
+      },
+}).then(({ id }) => {
+  console.log(`payment method created with ID: ${id}`);
+});
+```
+
+Refer to [Xendit API Reference](https://developers.xendit.co/api-reference/#payment-methods) for more info about methods' parameters
+
+
+#### Create payment method
+
+```ts
+r.createPaymentMethodV2(data: {
+  type: PaymentMethodV2Types;
+  reusability: PaymentMenthodV2Reusabilities;
+  reference_id?: string;
+  customer_id?: string;
+  country?: CreatePaymentMenthodV2Countries;
+  description?: string;
+  billing_information?: BillingInformationItems;
+  metadata?: object;
+  ewallet?: EwalletItems;
+  direct_debit?: DirectDebitItems;
+  card?: CardItems;
+  over_the_counter?: OverTheCounterItems;
+  virtual_account?: VirtualAccountItems;
+  qr_code?: QRISItems;
+  for_user_id?: string;
+  idempotency_key?: string;
+})
+```
+
+#### List payment methods
+
+```ts
+r.listPaymentMethodV2(data: {
+  payment_method_id?: string;
+  payment_method_type?: string;
+  channel_code?: string;
+  limit?: number;
+  after_id?: string;
+  before_id?: string;
+  for_user_id?: string;
+})
+```
+
+#### Get payment method details by ID
+
+```ts
+r.getPaymentMethodByIdV2(data: {
+    id: string;
+    for_user_id?: string;
+})
+```
+
+#### Authorize Payment method
+
+```ts
+r.authorizePaymentMethodV2(data: {
+    id: string;
+    auth_code: string;
+    for_user_id?: string;
+    idempotency_key?: string;
+})
+```
+
+#### Update Payment method
+
+```ts
+r.updatePaymentMethodV2(data: {
+    id: string;
+    reference_id?: string;
+    description?: string;
+    metadata?: object;
+    status?: object;
+    reusability?: PaymentMenthodV2Reusabilities;
+    over_the_counter?: UpdateOverTheCounterItems;
+    virtual_account?: UpdateVirtualAccountItems;
+    for_user_id?: string;
+})
+```
+
+#### Expire Payment method
+
+```ts
+r.expirePaymentMethodV2(data: {
+    id: string;
+    for_user_id?: string;
+    idempotency_key?: string;
+})
+```
+
+#### List payments by payment method id
+
+```ts
+r.listPaymentsByPaymentMethodIdV2(data: {
+    id: string;
+    payment_request_id?: string;
+    reference_id?: string;
+    status?: ListPaymentMethodV2StatusItems;
+    limit?: number;
+    after_id?: string;
+    before_id?: string;
+    created?: string;
+    updated?: string;
+    for_user_id?: string;
+})
+```
+
+
 ### Refund Services
@@ -1642,3 +1893,3 @@
   metadata?: object;
-  idempotencty_key?: string;
+  idempotency_key?: string;
   for_user_id?: string;
@@ -1645,0 +1896,0 @@ })

src/payment_request/payment_request.d.ts

@@ -58,3 +58,3 @@ import { XenditOptions } from '../xendit_opts';
     metadata?: object;
-    idempotencty_key?: string;
+    idempotency_key?: string;
     for_user_id?: string;
@@ -66,9 +66,9 @@ }): Promise<object>;
     auth_code: string;
-    idempotencty_key?: string;
+    idempotency_key?: string;
     for_user_id?: string;
   }): Promise<object>;
 
-  resendPaymentRequest(data: {
+  resendAuthForPaymentRequest(data: {
     id: string;
-    idempotencty_key?: string;
+    idempotency_key?: string;
     for_user_id?: string;
@@ -75,0 +75,0 @@ }): Promise<object>;

src/payment_request/payment_request.js

@@ -96,3 +96,3 @@ const {
 
-PaymentRequest.prototype.resendPaymentRequest = function(data) {
+PaymentRequest.prototype.resendAuthForPaymentRequest = function(data) {
   return promWithJsErr((resolve, reject) => {
@@ -99,0 +99,0 @@ Validate.rejectOnMissingFields(['id'], data, reject);

src/refund/refund.d.ts

@@ -23,3 +23,3 @@ enum RefundReasons {
     metadata?: object;
-    idempotencty_key?: string;
+    idempotency_key?: string;
     for_user_id?: string;
@@ -26,0 +26,0 @@ }): Promise<object>;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

290999

increased by2.9%

Number of package files

215

increased by1.42%

Lines of code

8079

increased by0.96%

Number of lines in readme file

1939

increased by14.87%

No dependency changes