Xendit Node

https://github.com/xendit/xendit-node
Admin
The official Xendit Node SDK simplifies integration with Xendit's REST API for Node.js applications,...
Tokens:50,968
Snippets:468
Trust Score:9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Create Customer API Example

Source: https://github.com/xendit/xendit-node/blob/master/docs/Customer.md

Example of how to create a new customer using the `createCustomer` function. This requires the `xenditCustomerClient` to be initialized.

```typescript
import { Customer } from 'xendit-node/customer/models'

const response: Customer = await xenditCustomerClient.createCustomer({ )
```

--------------------------------

### Install Xendit Node SDK

Source: https://github.com/xendit/xendit-node/blob/master/README.md

Install the Xendit Node SDK using npm. Ensure you are using Node.js version 18.0 or later.

```bash
npm install xendit-node@latest --save
```

--------------------------------

### Get Customer by ID API Example

Source: https://github.com/xendit/xendit-node/blob/master/docs/Customer.md

Example of how to retrieve a customer's details using their unique ID with the `getCustomer` function. The `id` parameter is required.

```typescript
import { Customer } from 'xendit-node/customer/models'

const response: Customer = await xenditCustomerClient.getCustomer({
    id: "d290f1ee-6c54-4b01-90e6-d701748f0851",
)
```

--------------------------------

### Update Customer API Example

Source: https://github.com/xendit/xendit-node/blob/master/docs/Customer.md

Example demonstrating how to update an existing customer's information using the `updateCustomer` function. The `id` of the customer to update is a required parameter.

```typescript
import { Customer } from 'xendit-node/customer/models'

const response: Customer = await xenditCustomerClient.updateCustomer({
    id: "d290f1ee-6c54-4b01-90e6-d701748f0851",
)
```

--------------------------------

### Get Customer by Reference ID API Example

Source: https://github.com/xendit/xendit-node/blob/master/docs/Customer.md

Example of how to retrieve customer information using a reference ID with the `getCustomerByReferenceID` function. The `referenceId` parameter is mandatory.

```typescript
import { GetCustomerByReferenceID200Response } from 'xendit-node/customer/models'

const response: GetCustomerByReferenceID200Response = await xenditCustomerClient.getCustomerByReferenceID({
    referenceId: "referenceId_example",
)
```

--------------------------------

### Initialize Xendit Client and Transaction Module

Source: https://github.com/xendit/xendit-node/blob/master/docs/Transaction.md

Demonstrates how to import and instantiate the Xendit client, and access the Transaction module. This setup is required before making any API calls.

```typescript
import { Xendit, Transaction as TransactionClient } from 'xendit-node';

const xenditClient = new Xendit({secretKey: YOUR_SECRET_KEY})
const { Transaction } = xenditClient

const xenditTransactionClient = new TransactionClient({secretKey: YOUR_SECRET_KEY})
```

--------------------------------

### Get All Payment Methods

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentMethod.md

Retrieves all payment methods, with options for filtering.

```APIDOC
## getAllPaymentMethods()

### Description
Get all payment methods by filters.

### Method
GET

### Endpoint
/v2/payment_methods
```

--------------------------------

### Create Fixed Amount Dynamic QR Code Payment Request

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentRequest.md

This example demonstrates creating a payment request for a fixed amount dynamic QR code. It includes metadata for tracking.

```typescript
import { PaymentRequestParameters, PaymentRequest } from 'xendit-node/payment_request/models'

const data: PaymentRequestParameters = {
  "amount" : 15000,
  "metadata" : {
    "sku" : "example-sku-1234"
  },
  "paymentMethod" : {
    "qrCode" : {
      "channelCode" : "“QRIS”"
    },
    "reusability" : "ONE_TIME_USE",
    "type" : "QR_CODE"
  },
  "currency" : "IDR",
  "referenceId" : "example-ref-1234"
}

const response: PaymentRequest = await xenditPaymentRequestClient.createPaymentRequest({
    data
})
```

--------------------------------

### Create Invoice Request

Source: https://github.com/xendit/xendit-node/blob/master/docs/Invoice.md

Provides an example of how to construct and send a request to create a new invoice using the `createInvoice` method. Ensure all required fields in `CreateInvoiceRequest` are populated.

```typescript
import { CreateInvoiceRequest, Invoice } from 'xendit-node/invoice/models'

const data: CreateInvoiceRequest = {
  "amount" : 10000,
  "invoiceDuration" : 172800,
  "externalId" : "test1234",
  "description" : "Test Invoice",
  "currency" : "IDR",
  "reminderTime" : 1
}

const response: Invoice = await xenditInvoiceClient.createInvoice({
    data
})
```

--------------------------------

### Create Subsequent PH Direct Debit Payment Request

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentRequest.md

This example shows how to create a payment request for subsequent Direct Debit payments after account linking. A `paymentMethodId` is required.

```typescript
import { PaymentRequestParameters, PaymentRequest } from 'xendit-node/payment_request/models'

const data: PaymentRequestParameters = {
  "amount" : 1500,
  "metadata" : {
    "sku" : "example-sku-1234"
  },
  "paymentMethodId" : "pm-9685a196-81e9-4c73-8d62-97df5aab2762",
  "currency" : "PHP",
  "referenceId" : "example-ref-1234"
}

const response: PaymentRequest = await xenditPaymentRequestClient.createPaymentRequest({
    data
})
```

--------------------------------

### ChannelPropertiesCardsInstallmentConfigurationAllowedTermsInner Object

Source: https://github.com/xendit/xendit-node/blob/master/docs/invoice/ChannelPropertiesCardsInstallmentConfigurationAllowedTermsInner.md

Represents the configuration for allowed installment terms for a specific card issuer.

```APIDOC
## ChannelPropertiesCardsInstallmentConfigurationAllowedTermsInner

### Description
Represents the configuration for allowed installment terms for a specific card issuer.

### Properties

#### issuer (string)
- **Description**: The bank code of the installment provider / issuer.
- **Required**: No
- **Examples**: "" (empty string)

#### terms (number[])
- **Description**: An array containing a list of installment tenors available to choose.
- **Required**: No
- **Examples**: [] (empty array)
```

--------------------------------

### PaymentMethodCallback Object Example

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentMethod.md

Illustrates the structure of a PaymentMethodCallback object, which is received for events like active or expired E-Wallet or Direct Debit account linking. You do not need to instantiate this object in practice.

```typescript
import { PaymentMethodCallback } from 'xendit-node/payment_method/models'

const paymentMethodCallback = {
  "data" : {
    "country" : "PH",
    "metadata" : null,
    "failureCode" : null,
    "created" : "2022-08-12T13:30:26.579048Z",
    "description" : null,
    "reusability" : "MULTIPLE_USE",
    "type" : "DIRECT_DEBIT",
    "billingInformation" : null,
    "directDebit" : {
      "bankAccount" : {
        "maskedBankAccountNumber" : "XXXXXX1234",
        "bankAccountHash" : "b4dfa99c9b60c77f2e3962b73c098945"
      },
      "channelProperties" : {
        "failureReturnUrl" : "https://your-redirect-website.com/failure",
        "successReturnUrl" : "https://your-redirect-website.com/success"
      },
      "debitCard" : null,
      "type" : "BANK_ACCOUNT",
      "channelCode" : "BPI"
    },
    "referenceId" : "620b9df4-fe69-4bfd-b9d4-5cba6861db8a",
    "ewallet" : null,
    "directBankTransfer" : null,
    "qrCode" : null,
    "overTheCounter" : null,
    "customerId" : "e2878b4c-d57e-4a2c-922d-c0313c2800a3",
    "id" : "pm-6ff0b6f2-f5de-457f-b08f-bc98fbae485a",
    "updated" : "2022-08-12T13:30:58.908220358Z",
    "virtualAccount" : null,
    "card" : null,
    "status" : "ACTIVE"
  },
  "created" : "2022-08-12T13:30:59.074277334Z",
  "businessId" : "5f27a14a9bf05c73dd040bc8",
  "event" : "payment_method.activated"
}
```

--------------------------------

### Handle Refund Callback

Source: https://github.com/xendit/xendit-node/blob/master/docs/Refund.md

Example of how to process a `RefundCallback` object within your webhook or callback handler to perform actions based on refund events.

```typescript
function SimulateRefundCallback(refundCallback: RefundCallback) {
    const { id } = refundCallback
    // do things here with the callback
}
```

--------------------------------

### Handle PaymentMethodCallback in Webhook

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentMethod.md

Example of how to use a PaymentMethodCallback object within a webhook or callback handler to process payment method events.

```typescript
function SimulatePaymentMethodCallback(paymentMethodCallback: PaymentMethodCallback) {
    const { id } = paymentMethodCallback
    // do things here with the callback
}
```

--------------------------------

### Handle Payment Callback

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentRequest.md

Example of how to use the `PaymentCallback` object within a webhook or callback handler function. This demonstrates accessing the payment ID.

```typescript
function SimulatePaymentCallback(paymentCallback: PaymentCallback) {
    const { id } = paymentCallback
    // do things here with the callback
}
```

--------------------------------

### RefundCallback Object Example

Source: https://github.com/xendit/xendit-node/blob/master/docs/Refund.md

Illustrates the structure of a `RefundCallback` object, which Xendit sends for refund events. This object contains details about the refund's status and associated payment.

```typescript
import { RefundCallback } from 'xendit-node/refund/models'

const refundCallback = {
  "data" : {
    "reason" : "CANCELLATION",
    "amount" : 10000,
    "metadata" : null,
    "failureCode" : null,
    "created" : "2020-08-30T09:12:33.001Z",
    "referenceId" : "b2756a1e-e6cd-4352-9a68-0483aa2b6a2",
    "paymentId" : "ddpy-3cd658ae-25b9-4659-aa36-596ae41a809f",
    "refundFeeAmount" : null,
    "invoiceId" : null,
    "currency" : "PHP",
    "id" : "rfd-6f4a377d-a201-437f-9119-f8b00cbbe857",
    "paymentMethodType" : "DIRECT_DEBIT",
    "updated" : "2020-08-30T09:12:33.001Z",
    "channelCode" : "BPI",
    "status" : "SUCCEEDED"
  },
  "created" : "2020-08-29T09:12:33.001Z",
  "businessId" : "5f27a14a9bf05c73dd040bc8",
  "event" : "refund.succeeded"
}
```

--------------------------------

### PaymentCallback Object Example

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentRequest.md

Illustrates the structure of the `PaymentCallback` object received for payment events. This object is used in webhook or callback handlers.

```typescript
import { PaymentCallback } from 'xendit-node/payment_request/models'

const paymentCallback = {
  "apiVersion" : null,
  "data" : {
    "country" : "PH",
    "amount" : 1000,
    "metadata" : {
      "sku" : "ABCDEFGH"
    },
    "failureCode" : null,
    "created" : "2022-08-12T13:30:40.9209Z",
    "paymentRequestId" : "pr-5b26cae1-545b-49e9-855e-f85128f3e705",
    "description" : null,
    "referenceId" : "25cfd0f9-baee-44ca-9a12-6debe03f3c22",
    "paymentDetail" : null,
    "channelProperties" : null,
    "customerId" : "c832697e-a62d-46fa-a383-24930b155e81",
    "paymentMethod" : {
      "metadata" : {
        "sku" : "ABCDEFGH"
      },
      "created" : "2022-08-12T13:30:26.579048Z",
      "description" : null,
      "reusability" : "MULTIPLE_USE",
      "type" : "DIRECT_DEBIT",
      "directDebit" : {
        "bankAccount" : {
          "maskedBankAccountNumber" : "XXXXXX1234",
          "bankAccountHash" : "b4dfa99c9b60c77f2e3962b73c098945"
        },
        "channelProperties" : {
          "failureReturnUrl" : "https://your-redirect-website.com/failure",
          "successReturnUrl" : "https://your-redirect-website.com/success"
        },
        "debitCard" : null,
        "type" : "BANK_ACCOUNT",
        "channelCode" : "BPI"
      },
      "referenceId" : "620b9df4-fe69-4bfd-b9d4-5cba6861db8a",
      "ewallet" : null,
      "directBankTransfer" : null,
      "qrCode" : null,
      "overTheCounter" : null,
      "id" : "pm-951b1ad9-1fbb-4724-a744-8956ab6ed17f",
      "updated" : "2022-08-12T13:30:40.221525Z",
      "virtualAccount" : null,
      "card" : null,
      "status" : "ACTIVE"
    },
    "currency" : "PHP",
    "id" : "ddpy-3cd658ae-25b9-4659-aa36-596ae41a809f",
    "updated" : "2022-08-12T13:30:58.729373Z",
    "status" : "SUCCEEDED"
  },
  "created" : "2022-08-12T13:30:58.986Z",
  "businessId" : "5f27a14a9bf05c73dd040bc8",
  "event" : "payment.succeeded"
}
```

--------------------------------

### Get Balance Information

Source: https://github.com/xendit/xendit-node/blob/master/docs/Balance.md

Retrieve balances for a business, defaulting to the CASH account type. You can specify account type, currency, timestamp, or target user ID.

```typescript
import { Balance } from 'xendit-node/balance_and_transaction/models'

const response: Balance = await xenditBalanceClient.getBalance({ )
```

--------------------------------

### Get All Payment Methods

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentMethod.md

Retrieve a list of all payment methods associated with your account. Supports filtering by user ID, IDs, types, status, reusability, customer ID, reference ID, and pagination.

```typescript
import { PaymentMethodList } from 'xendit-node/payment_method/models'

const response: PaymentMethodList = await xenditPaymentMethodClient.getAllPaymentMethods({ )
```

--------------------------------

### Initialize Xendit Client and PaymentRequest

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentRequest.md

Import and instantiate the Xendit client, then access the PaymentRequest module. Alternatively, instantiate the PaymentRequest client directly. Both methods yield functionally identical clients.

```typescript
import { Xendit, PaymentRequest as PaymentRequestClient } from 'xendit-node';

const xenditClient = new Xendit({secretKey: YOUR_SECRET_KEY})
const { PaymentRequest } = xenditClient

const xenditPaymentRequestClient = new PaymentRequestClient({secretKey: YOUR_SECRET_KEY})

// At this point, `PaymentRequest` and `xenditPaymentRequestClient` will have no usage difference, for example:
// PaymentRequest.
// or
// xenditPaymentRequestClient.

```

--------------------------------

### Initialize Xendit Client and PaymentMethod Module

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentMethod.md

Import and instantiate the Xendit client, then access the PaymentMethod module. Alternatively, instantiate the PaymentMethod client directly. Both approaches yield functionally identical clients.

```typescript
import { Xendit, PaymentMethod as PaymentMethodClient } from 'xendit-node';

const xenditClient = new Xendit({secretKey: YOUR_SECRET_KEY})
const { PaymentMethod } = xenditClient

const xenditPaymentMethodClient = new PaymentMethodClient({secretKey: YOUR_SECRET_KEY})
```

--------------------------------

### Initialize Xendit Client and Customer Module

Source: https://github.com/xendit/xendit-node/blob/master/docs/Customer.md

Demonstrates how to initialize the Xendit client and access the Customer module using either the destructured client or a direct import. Ensure your secret key is correctly set.

```typescript
import { Xendit, Customer as CustomerClient } from 'xendit-node';

const xenditClient = new Xendit({secretKey: YOUR_SECRET_KEY})
const { Customer } = xenditClient

const xenditCustomerClient = new CustomerClient({secretKey: YOUR_SECRET_KEY})

// At this point, `Customer` and `xenditCustomerClient` will have no usage difference, for example:
// Customer.
// or
// xenditCustomerClient.
```

--------------------------------

### Initialize Xendit Client and Invoice Module

Source: https://github.com/xendit/xendit-node/blob/master/docs/Invoice.md

Demonstrates how to instantiate the Xendit client and access the Invoice module. Both methods shown provide equivalent functionality for interacting with the Invoice API.

```typescript
import { Xendit, Invoice as InvoiceClient } from 'xendit-node';

const xenditClient = new Xendit({secretKey: YOUR_SECRET_KEY})
const { Invoice } = xenditClient

const xenditInvoiceClient = new InvoiceClient({secretKey: YOUR_SECRET_KEY})
```

--------------------------------

### Get All Refunds

Source: https://github.com/xendit/xendit-node/blob/master/docs/Refund.md

Retrieves a list of all refunds associated with the account.

```APIDOC
## GET /refunds

### Description
Retrieves a list of all refunds.

### Method
GET

### Endpoint
/refunds
```

--------------------------------

### Get All Transactions

Source: https://github.com/xendit/xendit-node/blob/master/docs/Transaction.md

Retrieves a list of transactions with various filtering options.

```APIDOC
## GET /transactions

### Description
Get a list of transactions

### Method
GET

### Endpoint
/transactions

### Parameters
#### Query Parameters
- **forUserId** (string) - Optional - Filter transactions for a specific user ID.
- **types** (TransactionTypes[]) - Optional - Filter by transaction types.
- **statuses** (TransactionStatuses[]) - Optional - Filter by transaction statuses.
- **channelCategories** (ChannelsCategories[]) - Optional - Filter by channel categories.
- **referenceId** (string) - Optional - Filter by reference ID.
- **productId** (string) - Optional - Filter by product ID.
- **accountIdentifier** (string) - Optional - Filter by account identifier.
- **amount** (number) - Optional - Filter by transaction amount.
- **currency** (Currency) - Optional - Filter by currency.
- **created** (DateRangeFilter) - Optional - Filter by creation date range.
- **updated** (DateRangeFilter) - Optional - Filter by update date range.
- **limit** (number) - Optional - The maximum number of transactions to return.
- **afterId** (string) - Optional - Returns transactions after a specific transaction ID.
- **beforeId** (string) - Optional - Returns transactions before a specific transaction ID.

### Request Example
```typescript
import { TransactionsResponse } from 'xendit-node/balance_and_transaction/models'

const response: TransactionsResponse = await xenditTransactionClient.getAllTransactions({ )
```

### Response
#### Success Response (200)
- **TransactionsResponse** - A list of transactions matching the criteria.
```

--------------------------------

### Instantiate Xendit Client and Refund Module

Source: https://github.com/xendit/xendit-node/blob/master/docs/Refund.md

Import and instantiate the Xendit client, then destructure the Refund module. Alternatively, directly import the Refund client and set the secret key. Both methods provide equivalent functionality for refund operations.

```typescript
import { Xendit, Refund as RefundClient } from 'xendit-node';

const xenditClient = new Xendit({secretKey: YOUR_SECRET_KEY})
const { Refund } = xenditClient

const xenditRefundClient = new RefundClient({secretKey: YOUR_SECRET_KEY})
```

--------------------------------

### Initialize Xendit Client for Payouts

Source: https://github.com/xendit/xendit-node/blob/master/docs/Payout.md

Demonstrates how to initialize the Xendit client and access the Payout module. You can either destruct the instantiated client or directly import and set the secret key.

```typescript
import { Xendit, Payout as PayoutClient } from 'xendit-node';

const xenditClient = new Xendit({secretKey: YOUR_SECRET_KEY})
const { Payout } = xenditClient

const xenditPayoutClient = new PayoutClient({secretKey: YOUR_SECRET_KEY})

// At this point, `Payout` and `xenditPayoutClient` will have no usage difference, for example:
// Payout.
// or
// xenditPayoutClient.

```

--------------------------------

### Get All Payment Requests

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentRequest.md

Retrieves a list of all payment requests, with filtering options.

```APIDOC
## GET /payment_requests

### Description
Get all payment requests by filter

### Method
GET

### Endpoint
/payment_requests
```

--------------------------------

### Get Payment Request By ID

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentRequest.md

Retrieves a specific payment request by its ID.

```APIDOC
## GET /payment_requests/{paymentRequestId}

### Description
Get payment request by ID

### Method
GET

### Endpoint
/payment_requests/{paymentRequestId}
```

--------------------------------

### Initialize Xendit Client and Balance Module

Source: https://github.com/xendit/xendit-node/blob/master/docs/Balance.md

Instantiate the Xendit client with your secret key and destructure the Balance module for use. Both the destructured module and a directly instantiated Balance client are interchangeable.

```typescript
import { Xendit, Balance as BalanceClient } from 'xendit-node';

const xenditClient = new Xendit({secretKey: YOUR_SECRET_KEY})
const { Balance } = xenditClient

const xenditBalanceClient = new BalanceClient({secretKey: YOUR_SECRET_KEY})
```

--------------------------------

### createCustomer()

Source: https://github.com/xendit/xendit-node/blob/master/docs/Customer.md

Creates a new customer resource.

```APIDOC
## POST /customers

### Description
Create Customer

### Method
POST

### Endpoint
/customers

### Parameters
#### Request Body
- **idempotencyKey** (string) - Optional
- **forUserId** (string) - Optional
- **data** ([CustomerRequest](customer/CustomerRequest.md)) - Optional

### Request Example
```typescript
import { Customer } from 'xendit-node/customer/models'

const response: Customer = await xenditCustomerClient.createCustomer({ )
```
```

--------------------------------

### Get All Refunds

Source: https://github.com/xendit/xendit-node/blob/master/docs/Refund.md

Retrieves a list of refunds based on various filtering criteria.

```APIDOC
## `getAllRefunds()` Function

### Description
Retrieves a list of refunds, with options to filter by user ID, payment request, invoice ID, payment method type, channel code, and pagination.

### Function Signature
`getAllRefunds(request: GetAllRefundsRequest): Promise<RefundList>`

### Request Parameters - GetAllRefundsRequest
| Field Name | Type | Required | Default | Description |
|---|---|---|---|---|
| **forUserId** | **string** | | | The ID of the user whose refunds are to be retrieved. |
| **paymentRequestId** | **string** | | | Filters refunds associated with a specific payment request ID. |
| **invoiceId** | **string** | | | Filters refunds associated with a specific invoice ID. |
| **paymentMethodType** | **string** | | | Filters refunds by the type of payment method used. |
| **channelCode** | **string** | | | Filters refunds by the specific payment channel code. |
| **limit** | **number** | | | Limits the number of refunds returned in the response. |
| **afterId** | **string** | | | Returns refunds created after the specified refund ID (for pagination). |
| **beforeId** | **string** | | | Returns refunds created before the specified refund ID (for pagination). |

### Response Type
[RefundList](refund/RefundList.md)

### Usage Example
```typescript
import { RefundList } from 'xendit-node/refund/models'

const response: RefundList = await xenditRefundClient.getAllRefunds({ })
```
```

--------------------------------

### Get a Specific Refund

Source: https://github.com/xendit/xendit-node/blob/master/docs/Refund.md

Retrieves the details of a specific refund using its ID.

```APIDOC
## `getRefund()` Function

### Description
Retrieves the details of a specific refund using its unique identifier.

### Function Signature
`getRefund(request: GetRefundRequest): Promise<Refund>`

### Request Parameters - GetRefundRequest
| Field Name | Type | Required | Description |
|---|---|---|---|
| **refundID** | **string** | ☑️ | The unique identifier of the refund to retrieve. |
| **idempotencyKey** | **string** | | Used to ensure that the request is processed only once. |
| **forUserId** | **string** | | The ID of the user for whom the refund is being retrieved. |

### Response Type
[Refund](refund/Refund.md)

### Usage Example
```typescript
import { Refund } from 'xendit-node/refund/models'

const response: Refund = await xenditRefundClient.getRefund({
    refundID: "rfd-1fdaf346-dd2e-4b6c-b938-124c7167a822",
)
```
```

--------------------------------

### Get Transaction By ID

Source: https://github.com/xendit/xendit-node/blob/master/docs/Transaction.md

Retrieves a specific transaction using its unique identifier.

```APIDOC
## GET /transactions/{id}

### Description
Get a transaction based on its id

### Method
GET

### Endpoint
/transactions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the transaction.
- **forUserId** (string) - Optional - Used to retrieve transactions for a specific user ID.

### Request Example
```typescript
import { TransactionResponse } from 'xendit-node/balance_and_transaction/models'

const response: TransactionResponse = await xenditTransactionClient.getTransactionByID({
    id: "id_example",
)
```

### Response
#### Success Response (200)
- **TransactionResponse** - Details of the transaction.
```

--------------------------------

### Get Payment Request Captures

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentRequest.md

Retrieves all capture transactions associated with a payment request.

```APIDOC
## GET /payment_requests/{paymentRequestId}/captures

### Description
Get Payment Request Capture

### Method
GET

### Endpoint
/payment_requests/{paymentRequestId}/captures
```

--------------------------------

### Get Payment Method By ID

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentMethod.md

Retrieves a specific payment method by its unique identifier.

```APIDOC
## `getPaymentMethodByID()` Function

### Description
Retrieves a specific payment method by its unique identifier.

### Function Signature
`getPaymentMethodByID(request: GetPaymentMethodByIDRequest): Promise<PaymentMethod>`

### Request Parameters - GetPaymentMethodByIDRequest
- **paymentMethodId** (string) - Required - The ID of the payment method to retrieve.
- **forUserId** (string) - Optional - The user ID to associate the request with.

### Response
- **Success Response** - Returns a `PaymentMethod` object.

### Usage Example
```typescript
const response: PaymentMethod = await xenditPaymentMethodClient.getPaymentMethodByID({
    paymentMethodId: "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822"
})
```
```

--------------------------------

### Get Refund by ID

Source: https://github.com/xendit/xendit-node/blob/master/docs/Refund.md

Retrieves the details of a specific refund using its unique ID.

```APIDOC
## GET /refunds/{refundID}

### Description
Retrieves the details of a specific refund.

### Method
GET

### Endpoint
/refunds/{refundID}

### Parameters
#### Path Parameters
- **refundID** (string) - Required - The ID of the refund to retrieve.
```

--------------------------------

### GetCustomerByReferenceID400Response Schema

Source: https://github.com/xendit/xendit-node/blob/master/docs/customer/GetCustomerByReferenceId400Response.md

The response schema for a 400 error when getting a customer by reference ID.

```APIDOC
## GetCustomerByReferenceID400Response

### Description
This object represents a 400 Bad Request response when a customer cannot be retrieved using the provided reference ID. It includes details about the error.

### Response Body

- **errorCode** (string) - Required - A unique code identifying the type of error.
- **message** (any) - Required - A human-readable message describing the error.
- **errors** (object[]) - Optional - An array of detailed error objects, providing more specific information about the failure.

### Response Example
```json
{
  "errorCode": "INVALID_PARAMETER",
  "message": "Customer not found with the provided reference ID.",
  "errors": [
    {
      "field": "reference_id",
      "description": "The provided reference ID does not match any existing customer."
    }
  ]
}
```
```

--------------------------------

### Instantiate Xendit Client

Source: https://github.com/xendit/xendit-node/blob/master/README.md

Instantiate the Xendit client with your secret API key. This client is used to make API requests.

```typescript
import { Xendit } from 'xendit-node';

const xenditClient = new Xendit({ secretKey: SECRET_API_KEY, })
```

--------------------------------

### Create Refund API Usage

Source: https://github.com/xendit/xendit-node/blob/master/docs/Refund.md

Use the `createRefund` method on the instantiated refund client to initiate a refund. Ensure the necessary models are imported for type safety.

```typescript
import { Refund } from 'xendit-node/refund/models'

const response: Refund = await xenditRefundClient.createRefund({ )
```

--------------------------------

### Get Balance

Source: https://github.com/xendit/xendit-node/blob/master/docs/Balance.md

Retrieves balances for a business. Defaults to CASH account type if not specified.

```APIDOC
## GET /balance

### Description
Retrieves balances for a business, defaulting to the CASH account type.

### Method
GET

### Endpoint
/balance

### Query Parameters
- **accountType** (string) - Optional - Allowed values: CASH, HOLDING, TAX. Defaults to 'CASH'.
- **currency** (string) - Optional - The currency for which to retrieve the balance.
- **atTimestamp** (Date) - Optional - Retrieves balance information as of a specific timestamp.
- **forUserId** (string) - Optional - Retrieves balance information for a specific user ID.

### Response
#### Success Response (200)
- **balance** (object) - Contains balance details.
  - **type** (string) - The type of account (e.g., CASH, HOLDING, TAX).
  - **currency** (string) - The currency of the balance.
  - **amount** (number) - The balance amount.

### Request Example
```typescript
const response = await xenditBalanceClient.getBalance({ accountType: 'CASH', currency: 'IDR' })
```

### Response Example
```json
{
  "balance": [
    {
      "type": "CASH",
      "currency": "IDR",
      "amount": 1000000.00
    }
  ]
}
```
```

--------------------------------

### createPayout()

Source: https://github.com/xendit/xendit-node/blob/master/docs/Payout.md

API to send money at scale to bank accounts & eWallets.

```APIDOC
## POST /v2/payouts

### Description
API to send money at scale to bank accounts & eWallets.

### Method
POST

### Endpoint
/v2/payouts

### Request Body
- **amount** (number) - Required - The amount to be paid out.
- **destination_account_id** (string) - Required - The ID of the destination account.
- **currency** (string) - Required - The currency of the payout (e.g., 'IDR').
- **reference_id** (string) - Optional - A unique reference ID for the payout.
- **description** (string) - Optional - A description for the payout.
- **metadata** (object) - Optional - Additional metadata for the payout.
```

--------------------------------

### Get Payment Request By ID

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentRequest.md

Retrieves a specific payment request using its unique identifier.

```APIDOC
## `getPaymentRequestByID()` Function

### Description
Retrieves a specific payment request using its unique identifier.

### Function Signature
`getPaymentRequestByID(request: GetPaymentRequestByIDRequest): Promise<PaymentRequest>`

### Request Parameters - GetPaymentRequestByIDRequest
- **paymentRequestId** (string) - Required - The ID of the payment request.
- **forUserId** (string) - Optional - The ID of the user for whom the request is being made.

### Usage Example
```typescript
import { PaymentRequest } from 'xendit-node/payment_request/models'

const response: PaymentRequest = await xenditPaymentRequestClient.getPaymentRequestByID({
    paymentRequestId: "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822",
})
```
```

--------------------------------

### Get Payment Method By ID

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentMethod.md

Retrieves a specific payment method using its unique identifier.

```APIDOC
## getPaymentMethodByID()

### Description
Get payment method by ID.

### Method
GET

### Endpoint
/v2/payment_methods/{paymentMethodId}
```

--------------------------------

### Get Payments By Payment Method ID

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentMethod.md

Retrieves a list of payments associated with a specific payment method.

```APIDOC
## `getPaymentsByPaymentMethodId()` Function

### Description
Retrieves a list of payments associated with a specific payment method.

### Function Signature
`getPaymentsByPaymentMethodId(request: GetPaymentsByPaymentMethodIdRequest): Promise<object>`

### Request Parameters - GetPaymentsByPaymentMethodIdRequest
- **paymentMethodId** (string) - Required - The ID of the payment method.
- **forUserId** (string) - Optional - The user ID to associate the request with.
- **paymentRequestId** (string[]) - Optional - Filter by payment request IDs.
- **paymentMethodId2** (string[]) - Optional - Filter by payment method IDs.
- **referenceId** (string[]) - Optional - Filter by reference IDs.
- **paymentMethodType** (PaymentMethodType[]) - Optional - Filter by payment method types.
- **channelCode** (string[]) - Optional - Filter by channel codes.
- **status** (string[]) - Optional - Filter by payment status.
- **currency** (string[]) - Optional - Filter by currency.
- **createdGte** (Date) - Optional - Filter by creation date greater than or equal to.
- **createdLte** (Date) - Optional - Filter by creation date less than or equal to.
- **updatedGte** (Date) - Optional - Filter by update date greater than or equal to.
- **updatedLte** (Date) - Optional - Filter by update date less than or equal to.
- **limit** (number) - Optional - The maximum number of results to return.

### Response
- **Success Response** - Returns an object containing payment information.

### Usage Example
```typescript
const response: object = await xenditPaymentMethodClient.getPaymentsByPaymentMethodId({
    paymentMethodId: "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822"
})
```
```

--------------------------------

### CreateRefund404Response

Source: https://github.com/xendit/xendit-node/blob/master/docs/refund/CreateRefund404Response.md

This is the structure for a 404 Not Found response when attempting to create a refund.

```APIDOC
## CreateRefund404Response

This object represents a 404 Not Found error response for the Create Refund API.

### Properties

| Name | Type | Required | Description | Examples |
|---|---|---|---|---|
| **errorCode** | string | No | A unique error code. | |
| **message** | string | No | A human-readable error message. | |
```

--------------------------------

### getCustomer()

Source: https://github.com/xendit/xendit-node/blob/master/docs/Customer.md

Retrieves a customer by their unique ID.

```APIDOC
## GET /customers/{id}

### Description
Get Customer By ID

### Method
GET

### Endpoint
/customers/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the customer.
#### Query Parameters
- **forUserId** (string) - Optional

### Request Example
```typescript
import { Customer } from 'xendit-node/customer/models'

const response: Customer = await xenditCustomerClient.getCustomer({
    id: "d290f1ee-6c54-4b01-90e6-d701748f0851",
)
```
```

--------------------------------

### Get Payment Request by ID - TypeScript

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentRequest.md

Retrieves a specific payment request by its ID. Ensure the paymentRequestId is valid.

```typescript
import { PaymentRequest } from 'xendit-node/payment_request/models'

const response: PaymentRequest = await xenditPaymentRequestClient.getPaymentRequestByID({
    paymentRequestId: "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822",
)
```

--------------------------------

### Instantiate Xendit Client with Custom URL

Source: https://github.com/xendit/xendit-node/blob/master/README.md

Instantiate the Xendit client with a custom Xendit API URL. This is useful for testing with mock servers or using alternative endpoints.

```typescript
const xenditClient = new Xendit({
  secretKey: SECRET_API_KEY,
  xenditURL: 'https://mock-server.localhost:3000',
})
```

--------------------------------

### Get Payments By Payment Method ID

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentMethod.md

Returns a list of payments associated with a specific payment method ID.

```APIDOC
## getPaymentsByPaymentMethodId()

### Description
Returns payments with matching PaymentMethodID.

### Method
GET

### Endpoint
/v2/payment_methods/{paymentMethodId}/payments
```

--------------------------------

### Get Payouts

Source: https://github.com/xendit/xendit-node/blob/master/docs/Payout.md

Retrieve a list of payouts. This function supports filtering by referenceId, limit, afterId, beforeId, and forUserId.

```typescript
import { GetPayouts200Response } from 'xendit-node/payout/models'

const response: GetPayouts200Response = await xenditPayoutClient.getPayouts({ 
    referenceId: "DISB-123",
)
```

--------------------------------

### createInvoice()

Source: https://github.com/xendit/xendit-node/blob/master/docs/Invoice.md

Creates a new invoice with the specified details. It allows for setting the amount, duration, external ID, description, currency, and reminder time.

```APIDOC
## POST /v2/invoices/

### Description
Creates a new invoice.

### Method
POST

### Endpoint
/v2/invoices/

### Parameters
#### Request Body
- **data** (CreateInvoiceRequest) - Required - The invoice details.
- **forUserId** (string) - Optional - The user ID for whom the invoice is created.

### Request Example
```json
{
  "data": {
    "amount": 10000,
    "invoiceDuration": 172800,
    "externalId": "test1234",
    "description": "Test Invoice",
    "currency": "IDR",
    "reminderTime": 1
  }
}
```

### Response
#### Success Response (200)
- **Invoice** (Invoice) - The created invoice object.
```

--------------------------------

### Get Payment Request Captures - TypeScript

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentRequest.md

Retrieves a list of captures associated with a specific payment request. The paymentRequestId is required.

```typescript
import { CaptureListResponse } from 'xendit-node/payment_request/models'

const response: CaptureListResponse = await xenditPaymentRequestClient.getPaymentRequestCaptures({
    paymentRequestId: "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822",
)
```

--------------------------------

### Create Refund

Source: https://github.com/xendit/xendit-node/blob/master/docs/refund/CreateRefund.md

Initiates a refund for a payment.

```APIDOC
## Create Refund

### Description
Initiates a refund for a payment.

### Method
POST

### Endpoint
/v1/refunds

### Request Body
- **paymentRequestId** (string) - Optional - The ID of the payment request to refund.
- **invoiceId** (string) - Optional - The ID of the invoice associated with the payment to refund.
- **referenceId** (string) - Optional - Your own reference ID for the refund.
- **amount** (number) - Optional - The amount to refund. If not provided, the full amount of the payment will be refunded.
- **currency** (string) - Optional - The currency of the refund amount (e.g., "IDR", "PHP").
- **reason** (string) - Optional - The reason for the refund.
- **metadata** (object) - Optional - Additional information to be included in the refund.
```

--------------------------------

### Create Payment Method

Source: https://github.com/xendit/xendit-node/blob/master/docs/PaymentMethod.md

Creates a new payment method. This allows users to set up a payment method for future use.

```APIDOC
## createPaymentMethod()

### Description
Creates payment method.

### Method
POST

### Endpoint
/v2/payment_methods
```
Tokens:
Raw