-
Notifications
You must be signed in to change notification settings - Fork 64
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
xendit-devx-bot
committed
Sep 15, 2023
1 parent
9a7e146
commit 98f2b95
Showing
33 changed files
with
211 additions
and
163 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
## Balance | ||
You can use the APIs below to interface with Xendit's `Balance` API. | ||
To start using the API, you need to destruct instantiated Xendit client or directly import the module and set the secret key. | ||
|
||
```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}) | ||
|
||
// At this point, `Balance` and `xenditBalanceClient` will have no usage difference, for example: | ||
// Balance. | ||
// or | ||
// xenditBalanceClient. | ||
``` | ||
## Retrieves balances for a business, default to CASH type | ||
|
||
|
||
### Function Signature | ||
| Name | Value | | ||
|--------------------|:-------------:| | ||
| Function Name | `getBalance` | | ||
| Request Parameters | [GetBalanceRequest](#request-parameters--GetBalanceRequest) | | ||
| Return Type | [Balance](balance_and_transaction/models/Balance.md) | | ||
|
||
### Request Parameters — `GetBalanceRequest` | ||
| Field Name | Required | Type | | ||
|-----------|:----------:|:----------:| | ||
| accountType| | 'CASH' | 'HOLDING' | 'TAX' | | ||
| currency| | string | | ||
| forUserId| | string | | ||
| idempotencyKey| | string | | ||
|
||
### Usage Examples | ||
#### Minimum API Usage | ||
```typescript | ||
import { Balance } from 'xendit-node/balance_and_transaction/models' | ||
|
||
const response: Balance = await xenditBalanceClient.getBalance({ }) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# AlternativeDisplayItem | ||
|
||
An object representing alternative display of a VA. | ||
|
||
## Properties | ||
|
||
| Name | Type | Required | Description | | ||
| ------------ | ------------- | ------------- | ------------- | | ||
| **type** | string | | Represent type of alternative display. | | ||
**value** | string | | Represent value of alternative display value. | | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,4 +34,6 @@ Virtual Account Channel Code | |
|
||
* `Msb` (value: `'MSB'`) | ||
|
||
* `StandardChartered` (value: `'STANDARD_CHARTERED'`) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,4 +34,6 @@ Virtual Account Channel Code | |
|
||
* `Msb` (value: `'MSB'`) | ||
|
||
* `StandardChartered` (value: `'STANDARD_CHARTERED'`) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.