MidtransNode | Midtrans Node

Hierarchy

MidtransNode

Constructors

constructor

new MidtransNode(isProduction: boolean, authKey: string): MidtransNode

- Defined in index.ts:92
Parameters
- isProduction: boolean
  
  Are you ready to production?
- authKey: string
  
  Your midtrans server-key
Returns MidtransNode

Properties

config

config: IConfig

Methods

approvePayouts

approvePayouts(args: IPayoutApproveRequest): Promise<undefined | IPayoutSuccessAct>

- Defined in index.ts:461
description
Use this API for Apporver to approve multiple payout request. More info: https://iris-docs.midtrans.com/#approve-payouts

Parameters
- args: IPayoutApproveRequest
  
  Payout approve request object
Returns Promise<undefined | IPayoutSuccessAct>

approveTransaction

approveTransaction(orderID: string): Promise<ITransaction | ITransactionFail>

- Defined in index.ts:151
description
Approve method can be triggered to accept card payment transaction in which fraud_status is challenge. More info: https://api-docs.midtrans.com/#approve-transaction

Parameters
- orderID: string
  
  Transaction ID given by Midtrans
Returns Promise<ITransaction | ITransactionFail>

bankAccounts

bankAccounts(): Promise<undefined | BankAccount[]>

- Defined in index.ts:514
description
Show list of registered bank accounts for facilitator partner. More info: https://iris-docs.midtrans.com/#bank-accounts-facilitator

Returns Promise<undefined | BankAccount[]>

cancelTransaction

cancelTransaction(orderID: string): Promise<ITransaction | ITransactionFail>

- Defined in index.ts:138
description
More info: https://api-docs.midtrans.com/#cancel-transaction

Parameters
- orderID: string
  
  Transaction ID given by Midtrans
Returns Promise<ITransaction | ITransactionFail>

captureTransaction

captureTransaction(orderID: string, grossAmount?: number): Promise<ITransaction | ITransactionFail>

- Defined in index.ts:123
description
This method is used to capture transaction balance when transaction_status is authorize. Transaction with status authorize is only available after Pre Authorization Credit Card transaction. More info: https://api-docs.midtrans.com/#capture-transaction

Parameters
- orderID: string
  
  Transaction id from charge response
- Optional grossAmount: number
  
  Amount to be captured. By default will capture whole transaction amount. NOTE: Cannot be decimal
Returns Promise<ITransaction | ITransactionFail>

chargeTransaction

chargeTransaction(args: IChargeTransactionArgs): Promise<undefined | IChargeTransactionResult>

- Defined in index.ts:558
Charge transaction.

Parameters
- args: IChargeTransactionArgs
  
  Charge transaction arguments/
Returns Promise<undefined | IChargeTransactionResult>

checkBankBalance

checkBankBalance(bankAccountID: string): Promise<undefined | ICheckBalanceBank>

- Defined in index.ts:521
description
For Facilitator Partner, use this API is to get current balance information of your registered bank account. More info: https://iris-docs.midtrans.com/#check-balance-facilitator

Parameters
- bankAccountID: string
  
  Bank account ID to be used when creating payouts
Returns Promise<undefined | ICheckBalanceBank>

createBeneficiaries

createBeneficiaries(args: IBeneficiaries): Promise<undefined | ISuccessBeneficiaries>

- Defined in index.ts:410
description
Use this API to create a new beneficiary information for quick access on the payout page in Iris Portal. More info: https://iris-docs.midtrans.com/#create-beneficiaries

Parameters
- args: IBeneficiaries
  
  Beneficiaries request object
Returns Promise<undefined | ISuccessBeneficiaries>

createPayAccount

createPayAccount(args: ICreatePayAccount): Promise<undefined | ICreatePayAccountResponse>

- Defined in index.ts:284
description
More info: https://api-docs.midtrans.com/#create-pay-account

Parameters
- args: ICreatePayAccount
  
  Pay Account Request Object
Returns Promise<undefined | ICreatePayAccountResponse>

createPayouts

createPayouts(args: IPayoutRequest): Promise<undefined | IPayoutCreateResponse>

- Defined in index.ts:452
description
This API is for Creator to create a payout. It can be used for single payout and also multiple payouts. More info: https://iris-docs.midtrans.com/#create-payouts

Parameters
- args: IPayoutRequest
  
  Payout request object.
Returns Promise<undefined | IPayoutCreateResponse>

createSubscription

createSubscription(args: ICreateSubcription): Promise<undefined | ISubcription>

- Defined in index.ts:336
description
Create subscription that contains all details for creating transaction. More info: https://api-docs.midtrans.com/#create-subscription

Parameters
- args: ICreateSubcription
  
  Subscription Request object.
Returns Promise<undefined | ISubcription>

createTransaction

createTransaction(args: SnapTransaction): Promise<undefined | { redirect_url: string; token: string }>

- Defined in index.ts:113
description
More info: https://snap-docs.midtrans.com

Parameters
- args: SnapTransaction
  
  Create Transaction Arguments.
Returns Promise<undefined | { redirect_url: string; token: string }>

denyTransaction

denyTransaction(orderID: string): Promise<ITransaction | ITransactionFail>

- Defined in index.ts:164
description
Deny method can be triggered to immediately deny card payment transaction in which fraud_status is challenge. More info: https://api-docs.midtrans.com/#deny-transaction

Parameters
- orderID: string
  
  Transaction ID given by Midtrans
Returns Promise<ITransaction | ITransactionFail>

directRefundTransaction

directRefundTransaction(orderID: string): Promise<ITransactionFail | IRefundObj>

- Defined in index.ts:193
description
More info: https://api-docs.midtrans.com/#direct-refund-transaction

Parameters
- orderID: string
  
  Transaction ID given by Midtrans
Returns Promise<ITransactionFail | IRefundObj>

disableSubscription

disableSubscription(subscriptionId: string): Promise<undefined | { status_message: string }>

- Defined in index.ts:378
description
Make the subscription inactive (the subscription will not create transaction anymore). More info: https://api-docs.midtrans.com/#disable-subscription

Parameters
- subscriptionId: string
  
  Subscription ID given by Midtrans
Returns Promise<undefined | { status_message: string }>

enableSubscription

enableSubscription(subscriptionId: string): Promise<undefined | { status_message: string }>

- Defined in index.ts:391
description
Make the subscription active (the subscription will create periodic transaction). More info: https://api-docs.midtrans.com/#enable-subscription

Parameters
- subscriptionId: string
  
  Subscription ID given by Midtrans
Returns Promise<undefined | { status_message: string }>

expireTransaction

expireTransaction(orderID: string): Promise<ITransaction | ITransactionFail>

- Defined in index.ts:270
description
More info: https://api-docs.midtrans.com/#expire-transaction

Parameters
- orderID: string
  
  Transaction ID given by Midtrans
Returns Promise<ITransaction | ITransactionFail>

getBin

getBin(binNumber: number): Promise<undefined | BinApiResponse>

- Defined in index.ts:323
description
Midtrans API provide Bin Lookup API to get metadata for a particular bin, such as card type (Debit/Credit) or the card brand (ex. Visa, Master). More info: https://api-docs.midtrans.com/#bin-api

Parameters
- binNumber: number
  
  Bin ID want to check.
Returns Promise<undefined | BinApiResponse>

getPayAccount

getPayAccount(accountID: string): Promise<undefined | IPayAccount>

- Defined in index.ts:297
description
More info: https://api-docs.midtrans.com/#get-pay-account

Parameters
- accountID: string
  
  Pay Account ID
Returns Promise<undefined | IPayAccount>

getPayoutDetails

getPayoutDetails(refNo: string): Promise<undefined | IPayout>

- Defined in index.ts:479
description
Get details of a single payout. More info: https://iris-docs.midtrans.com/#get-payout-details

Parameters
- refNo: string
  
  Unique reference_no of a payout
Returns Promise<undefined | IPayout>

getSubscription

getSubscription(subscriptionId: string): Promise<undefined | ISubcription>

- Defined in index.ts:349
description
Find subscription by id to see the subscription details. More info: https://api-docs.midtrans.com/#get-subscription

Parameters
- subscriptionId: string
  
  Subscription ID given by Midtrans
Returns Promise<undefined | ISubcription>

historyTransaction

historyTransaction(fromDate?: IStatementDate, toDate?: IStatementDate): Promise<undefined | IStatementResult[]>

- Defined in index.ts:493
description
List all transactions history for a month. You can specified start date and also end date for range transaction history. More info: https://iris-docs.midtrans.com/#transaction-history

Parameters
- Optional fromDate: IStatementDate
  
  start date range for payouts (YYYY-MM-DD)
- Optional toDate: IStatementDate
  
  end date range for payouts (YYYY-MM-DD)
Returns Promise<undefined | IStatementResult[]>

listBanks

listBanks(): Promise<undefined | BeneficiaryBank[]>

- Defined in index.ts:533
description
- Show list of supported banks in IRIS. More info: https://iris-docs.midtrans.com/#list-banks
Returns Promise<undefined | BeneficiaryBank[]>

listBeneficiaries

listBeneficiaries(limit?: number): Promise<undefined | IBeneficiaries[]>

- Defined in index.ts:439
description
Use this API to fetch list of all beneficiaries saved in Iris Portal. More info: https://iris-docs.midtrans.com/#list-beneficiaries

Parameters
- limit: number = 10
  
  Limit data beneficiaries.
Returns Promise<undefined | IBeneficiaries[]>

ping

ping(): Promise<undefined | string>

- Defined in index.ts:403
description
Returns pong message for monitoring purpose

Returns Promise<undefined | string>

pointInquiry

pointInquiry(tokenId: string, grossAmount?: number): Promise<undefined | IPointInquiry>

- Defined in index.ts:255
description
More info: https://api-docs.midtrans.com/#point-inquiry

Parameters
- tokenId: string
  
  Card Token
- Optional grossAmount: number
  
  The volume of the following transaction. This number can decide the remaining point balance amount which can be used on the response. NOTE: Needed for Mandiri Point.
Returns Promise<undefined | IPointInquiry>

refundTransaction

refundTransaction(orderID: string, args: IRefundObjRequest): Promise<ITransactionFail | IRefundObj>

- Defined in index.ts:178
description
As opposed to previous refund API, this is used to directly send the refund request to bank or payment provider (third party). This API is useful to skip the standard operation process which may take 1 or 2 days after the initial refund request. The status of corresponding transaction will immediately be updated following the refund result received from third party. It will send HTTP notification only if the refund succeeded. More info: https://api-docs.midtrans.com/#refund-transaction

Parameters
- orderID: string
  
  Transaction ID given by Midtrans
- args: IRefundObjRequest
  
  Request Refund Object includes refund_key,amount,and reason.
Returns Promise<ITransactionFail | IRefundObj>

registerCard

registerCard(args: IRegisterCardRequest): Promise<undefined | IRegisterCardResponse>

- Defined in index.ts:245
description
More info: https://api-docs.midtrans.com/#register-card

Parameters
- args: IRegisterCardRequest
  
  Request Register Card Object includes card_number,card_exp_month,card_exp_year,client_key,callback.
Returns Promise<undefined | IRegisterCardResponse>

rejectPayouts

rejectPayouts(args: IPayoutRejectRequest): Promise<undefined | IPayoutSuccessAct>

- Defined in index.ts:470
description
Use this API for Apporver to reject multiple payout request. More info: https://iris-docs.midtrans.com/#reject-payouts

Parameters
- args: IPayoutRejectRequest
  
  Payout reject request object
Returns Promise<undefined | IPayoutSuccessAct>

setOverrideNotificationURL

setOverrideNotificationURL(urls: string | string[]): MidtransNode

- Defined in index.ts:104
Set override notification url.

Parameters
- urls: string | string[]
  
  Website URL(s)
Returns MidtransNode

statusTransaction

statusTransaction(orderID: string): Promise<ITransactionFail | ITransactionStatus>

- Defined in index.ts:206
description
Transaction status can be obtained by triggering the Get Status Method. More info: https://api-docs.midtrans.com/#get-transaction-status

Parameters
- orderID: string
  
  Transaction ID given by Midtrans
Returns Promise<ITransactionFail | ITransactionStatus>

statusb2bTransaction

statusb2bTransaction(orderID: string, page?: undefined | number, perPage?: undefined | number): Promise<undefined | { status_code: string; status_message: string; transactions: ITransaction[] }>

- Defined in index.ts:221
description
Transaction status for all B2B transactions related to an order_id can be obtained by triggering the Get Status B2B Method. More info: https://api-docs.midtrans.com/#get-transaction-status-b2b

Parameters
- orderID: string
  
  Transaction ID given by Midtrans
- page: undefined | number = 0
  
  Index of the search. Default is 0.
- perPage: undefined | number = 10
  
  Number of transactions which is presented. Default is 10.
Returns Promise<undefined | { status_code: string; status_message: string; transactions: ITransaction[] }>

topupChannels

topupChannels(): Promise<undefined | ITopupAggreratorChannel[]>

- Defined in index.ts:507
description
Provide top up information channel for Aggregator Partner

Returns Promise<undefined | ITopupAggreratorChannel[]>

unbindPayAccount

unbindPayAccount(accountID: string): Promise<undefined | IPayAccountUnBind>

- Defined in index.ts:310
description
More info: https://api-docs.midtrans.com/#unbind-pay-account

Parameters
- accountID: string
  
  Pay Account ID
Returns Promise<undefined | IPayAccountUnBind>

updateBeneficiaries

updateBeneficiaries(aliasName: string, args: IBeneficiaries): Promise<undefined | ISuccessBeneficiaries>

- Defined in index.ts:424
description
Use this API to update an existing beneficiary identified by its alias_name. More info: https://iris-docs.midtrans.com/#update-beneficiaries

Parameters
- aliasName: string
  
  Identifier name.
- args: IBeneficiaries
  
  Beneficiaries request object
Returns Promise<undefined | ISuccessBeneficiaries>

updateSubscription

updateSubscription(subscriptionId: string, args: IUpdateSubcription): Promise<undefined | ISubcription>

- Defined in index.ts:363
description
https://api-docs.midtrans.com/#update-subscription

Parameters
- subscriptionId: string
  
  Subscription ID given by Midtrans
- args: IUpdateSubcription
  
  Subscription request object
Returns Promise<undefined | ISubcription>

validateBankAccount

validateBankAccount(bankName: string, accountID: string): Promise<undefined | IValidateBankResult>

- Defined in index.ts:541
description
Check if an account is valid, if valid return account information. More info: https://iris-docs.midtrans.com/#validate-bank-account

Parameters
- bankName: string
  
  Bank code
- accountID: string
  
  Account number
Returns Promise<undefined | IValidateBankResult>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

isProduction: boolean

authKey: string

Returns MidtransNode

Properties

config

Methods

approvePayouts

Parameters

args: IPayoutApproveRequest

Returns Promise<undefined | IPayoutSuccessAct>

approveTransaction

Parameters

orderID: string

Returns Promise<ITransaction | ITransactionFail>

bankAccounts

Returns Promise<undefined | BankAccount[]>

cancelTransaction

Parameters

orderID: string

Returns Promise<ITransaction | ITransactionFail>

captureTransaction

Parameters

orderID: string

Optional grossAmount: number

Returns Promise<ITransaction | ITransactionFail>

chargeTransaction

Parameters

args: IChargeTransactionArgs

Returns Promise<undefined | IChargeTransactionResult>

checkBankBalance

Parameters

bankAccountID: string

Returns Promise<undefined | ICheckBalanceBank>

createBeneficiaries

Parameters

args: IBeneficiaries

Returns Promise<undefined | ISuccessBeneficiaries>

createPayAccount

Parameters

args: ICreatePayAccount

Returns Promise<undefined | ICreatePayAccountResponse>

createPayouts

Parameters

args: IPayoutRequest

Returns Promise<undefined | IPayoutCreateResponse>

createSubscription

Parameters

args: ICreateSubcription

Returns Promise<undefined | ISubcription>

createTransaction

Parameters

args: SnapTransaction

Returns Promise<undefined | { redirect_url: string; token: string }>

denyTransaction

Parameters

orderID: string

Returns Promise<ITransaction | ITransactionFail>

directRefundTransaction

Parameters

orderID: string

Returns Promise<ITransactionFail | IRefundObj>

disableSubscription

Parameters

subscriptionId: string

Returns Promise<undefined | { status_message: string }>

enableSubscription

Parameters

subscriptionId: string

Returns Promise<undefined | { status_message: string }>

expireTransaction

Parameters

orderID: string