Class Cryptomus

Hierarchy

Cryptomus

Index

Constructors

Properties

Methods

blockStaticWallet createPayment createStaticWallet genQr getPayment makeSignatue refundFromBlockedWallet refundPayment request resendWebhook testPaymentWebhook testPayoutWebhook verifySignatue

Constructors

constructor

new Cryptomus(merchant, paymentToken, payoutToken): Cryptomus
Parameters
- merchant: string
- paymentToken: string
- payoutToken: string
Returns Cryptomus

Properties

`Private` `Readonly` merchant

merchant: string

`Private` `Readonly` paymentToken

paymentToken: string

`Private` `Readonly` payoutToken

payoutToken: string

Methods

blockStaticWallet

blockStaticWallet(options): Promise<I_BLOCK_STATIC_WALLET_RESPONSE>
Blocks a static wallet.
Parameters
- options: I_BLOCK_STATIC_WALLET_REQUEST
  
  The options for blocking the wallet.
Returns Promise<I_BLOCK_STATIC_WALLET_RESPONSE>
- A promise that resolves to the response of the blocking operation.

createPayment

createPayment(options): Promise<I_CREATE_PAYMENT_RESPONSE>
Creates a payment.
Parameters
- options: I_CREATE_PAYMENT_REQUEST
  
  The payment options.
Returns Promise<I_CREATE_PAYMENT_RESPONSE>
The response of creating a payment.

createStaticWallet

createStaticWallet(options): Promise<I_CREATE_STATIC_WALLET_RESPONSE>
Creates a static wallet.
Parameters
- options: I_CREATE_STATIC_WALLET_REQUEST
  
  The options for creating the static wallet.
Returns Promise<I_CREATE_STATIC_WALLET_RESPONSE>
A promise that resolves with the response of creating the static wallet.

genQr

genQr(options): Promise<I_GEN_QR_RESPONSE>
Generates a QR code based on the provided options.
Parameters
- options: I_GEN_QR_REQUEST
  
  The options for generating the QR code.
Returns Promise<I_GEN_QR_RESPONSE>
- A promise that resolves to the generated QR code response.

getPayment

getPayment(options): Promise<I_PAYMENT_INFO_RESPONSE>
Retrieves the payment information based on the provided options.
Parameters
- options: I_PAYMENT_INFO_REQUEST
  
  The payment information request options.
Returns Promise<I_PAYMENT_INFO_RESPONSE>
The payment information response.

makeSignatue

makeSignatue(data, key): string
Generates a signature for the given data and key.
Parameters
- data: Record<string, any>
  
  The data to generate the signature for.
- key: string
  
  The key used in the signature generation.
Returns string
The generated signature.

refundFromBlockedWallet

refundFromBlockedWallet(options): Promise<I_REFUND_FROM_BLOCK_WALLET_RESPONSE>
Refunds from a blocked wallet.
Parameters
- options: I_REFUND_FROM_BLOCK_WALLET_REQUEST
  
  The options for the refund request.
Returns Promise<I_REFUND_FROM_BLOCK_WALLET_RESPONSE>
- A promise that resolves to the refund response.

refundPayment

refundPayment(options): Promise<I_PAYMENT_REFUND_RESPONSE>
Refunds a payment.
Parameters
- options: I_PAYMENT_REFUND_REQUEST
  
  The options for refunding the payment.
Returns Promise<I_PAYMENT_REFUND_RESPONSE>
The response containing the refund details.

request

request<T>(method, type, route, data): Promise<T>
Sends a request to the specified route using the given HTTP method and token type.
Type Parameters
- T
Parameters
- method: E_HTTP
  
  The HTTP method to use for the request.
- type: E_TOKEN
  
  The type of token to use for authentication.
- route: string
  
  The route to send the request to.
- data: Record<string, any>
  
  The data to include in the request.
Returns Promise<T>
- A promise that resolves with the response data.

resendWebhook

resendWebhook(options): Promise<I_RESEND_WEBHOOK_RESPONSE>
Asynchronously resends a webhook.
Parameters
- options: I_RESEND_WEBHOOK_REQUEST
  
  The options for resending the webhook.
Returns Promise<I_RESEND_WEBHOOK_RESPONSE>
- The response from the resend request.

testPaymentWebhook

testPaymentWebhook(options): Promise<I_TEST_WEBHOOK_RESPONSE>
Sends a test webhook request and returns the response.
Parameters
- options: I_TEST_WEBHOOK_REQUEST
  
  The options for the test webhook request.
Returns Promise<I_TEST_WEBHOOK_RESPONSE>
- A promise that resolves to the response of the test webhook request.

testPayoutWebhook

testPayoutWebhook(options): Promise<I_TEST_WEBHOOK_RESPONSE>
Sends a test payout webhook request and returns the response.
Parameters
- options: I_TEST_WEBHOOK_REQUEST
  
  The options for the test webhook request.
Returns Promise<I_TEST_WEBHOOK_RESPONSE>
- The response from the test webhook request.

verifySignatue

verifySignatue(data): boolean
Verifies the signature of the given data.
Parameters
- data: Record<string, any>
  
  The data to verify the signature for.
Returns boolean
Returns true if the signature is valid, false otherwise.

Class Cryptomus

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

merchant: string

paymentToken: string

payoutToken: string

Returns Cryptomus

Properties

Private Readonly merchant

Private Readonly paymentToken

Private Readonly payoutToken

Methods

blockStaticWallet

Parameters

options: I_BLOCK_STATIC_WALLET_REQUEST

Returns Promise<I_BLOCK_STATIC_WALLET_RESPONSE>

createPayment

Parameters

options: I_CREATE_PAYMENT_REQUEST

Returns Promise<I_CREATE_PAYMENT_RESPONSE>

createStaticWallet

Parameters

options: I_CREATE_STATIC_WALLET_REQUEST

Returns Promise<I_CREATE_STATIC_WALLET_RESPONSE>

genQr

Parameters

options: I_GEN_QR_REQUEST

Returns Promise<I_GEN_QR_RESPONSE>

getPayment

Parameters

options: I_PAYMENT_INFO_REQUEST

Returns Promise<I_PAYMENT_INFO_RESPONSE>

makeSignatue

Parameters

data: Record<string, any>

key: string

Returns string

refundFromBlockedWallet

Parameters

options: I_REFUND_FROM_BLOCK_WALLET_REQUEST

Returns Promise<I_REFUND_FROM_BLOCK_WALLET_RESPONSE>

refundPayment

Parameters

options: I_PAYMENT_REFUND_REQUEST

Returns Promise<I_PAYMENT_REFUND_RESPONSE>

request

Type Parameters

T

Parameters

method: E_HTTP

type: E_TOKEN

route: string

data: Record<string, any>

Returns Promise<T>

resendWebhook

Parameters

options: I_RESEND_WEBHOOK_REQUEST

Returns Promise<I_RESEND_WEBHOOK_RESPONSE>

testPaymentWebhook

Parameters

options: I_TEST_WEBHOOK_REQUEST

Returns Promise<I_TEST_WEBHOOK_RESPONSE>

testPayoutWebhook

Parameters

options: I_TEST_WEBHOOK_REQUEST

Returns Promise<I_TEST_WEBHOOK_RESPONSE>

verifySignatue

Parameters

data: Record<string, any>

Returns boolean

On This Page

`Private` `Readonly` merchant

`Private` `Readonly` paymentToken

`Private` `Readonly` payoutToken