# cpay-mtn-api

> MastercardMultiTokenNetworkApi - JavaScript client for MastercardMultiTokenNetworkAPI MTN (Multi Token Network) API is for customers and their consumers to - create account - buy/sell/hold cryptos - resolve alias and addresses - mint/transfer/burn tokeniz

Latest version **0.0.1** (published 2024-05-14) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install cpay-mtn-api
pnpm add cpay-mtn-api
yarn add cpay-mtn-api
bun add cpay-mtn-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2024-05-14 |
| First published | 2024-05-14 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 428.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | shaynos |

## Links

- npm: https://www.npmjs.com/package/cpay-mtn-api
- npm.io page: https://npm.io/package/cpay-mtn-api

## Dependencies (4)

- [uuid](https://npm.io/package/uuid.md) ^9.0.1
- [superagent](https://npm.io/package/superagent.md) 5.1.0
- [mastercard-oauth1-signer](https://npm.io/package/mastercard-oauth1-signer.md) ^1.1.6
- [mastercard-client-encryption](https://npm.io/package/mastercard-client-encryption.md) ^1.10.2

## Recent versions

- 0.0.1 (latest) — 2024-05-14

## README

# MastercardMultiTokenNetworkAPI

MastercardMultiTokenNetworkApi - JavaScript client for MastercardMultiTokenNetworkAPI
MTN (Multi Token Network) API is for customers and their consumers to
- create account
- buy/sell/hold cryptos
- resolve alias and addresses
- mint/transfer/burn tokenized deposits on blockchain
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.0.1
- Package version: 0.0.1
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For more information, please visit [https://developer.mastercard.com/support](https://developer.mastercard.com/support)

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install MastercardMultiTokenNetworkAPI --save
```

##### Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

Finally, switch to the directory you want to use your MastercardMultiTokenNetworkAPI from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

You should now be able to `require('MastercardMultiTokenNetworkAPI')` in javascript files from the directory you ran the last command above from.

### git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID
then install it via:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following the above steps with Node.js and installing browserify with `npm install -g browserify`, perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually use this library):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var MastercardMultiTokenNetworkApi = require('MastercardMultiTokenNetworkAPI');


var api = new MastercardMultiTokenNetworkApi.AccountsApi()
var ica = 12321; // {String} Used for Customer identification in all service requests for a registered customer.
var account = new MastercardMultiTokenNetworkApi.Account(); // {Account} Request to create a new account for a registered customer.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountPost(ica, account, callback);

```

## Documentation for API Endpoints

All URIs are relative to *https://api.mastercard.com/crypto*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*MastercardMultiTokenNetworkApi.AccountsApi* | [**accountPost**](docs/AccountsApi.md#accountPost) | **POST** /customers/{ica}/accounts | Register a new consumer account identity.
*MastercardMultiTokenNetworkApi.AccountsApi* | [**accountSearch**](docs/AccountsApi.md#accountSearch) | **POST** /customers/{ica}/accounts/searches | Search for an account&#39;s details.
*MastercardMultiTokenNetworkApi.AccountsApi* | [**accountUpdate**](docs/AccountsApi.md#accountUpdate) | **PUT** /customers/{ica}/accounts | Updates an account.
*MastercardMultiTokenNetworkApi.AliasResolutionApi* | [**getAliasResolutionRequest**](docs/AliasResolutionApi.md#getAliasResolutionRequest) | **GET** /customers/{ica}/alias-resolutions/{request_id} | Retrieve an account resolution request.
*MastercardMultiTokenNetworkApi.AliasResolutionApi* | [**getAliasResolutionRequests**](docs/AliasResolutionApi.md#getAliasResolutionRequests) | **GET** /customers/{ica}/alias-resolutions | Retrieve account resolution requests.
*MastercardMultiTokenNetworkApi.AliasResolutionApi* | [**resolveAccountAlias**](docs/AliasResolutionApi.md#resolveAccountAlias) | **POST** /customers/{ica}/alias-resolutions | Creates an account resolution request.
*MastercardMultiTokenNetworkApi.AliasResolutionApi* | [**updateAccountResolutionRequest**](docs/AliasResolutionApi.md#updateAccountResolutionRequest) | **PUT** /customers/{ica}/alias-resolutions/{request_id} | Update an account resolution request.
*MastercardMultiTokenNetworkApi.CryptoAddressesApi* | [**addCryptoAddress**](docs/CryptoAddressesApi.md#addCryptoAddress) | **POST** /customers/{ica}/crypto-addresses | Adds a preferred crypto address for an account.
*MastercardMultiTokenNetworkApi.CryptoAddressesApi* | [**decommissionCryptoAddress**](docs/CryptoAddressesApi.md#decommissionCryptoAddress) | **DELETE** /customers/{ica}/crypto-addresses/{crypto_address_id} | Decommissions a crypto address.
*MastercardMultiTokenNetworkApi.CryptoAddressesApi* | [**getCryptoAddress**](docs/CryptoAddressesApi.md#getCryptoAddress) | **GET** /customers/{ica}/crypto-addresses/{crypto_address_id} | Gets a crypto address.
*MastercardMultiTokenNetworkApi.CryptoAddressesApi* | [**updateCryptoAddress**](docs/CryptoAddressesApi.md#updateCryptoAddress) | **PUT** /customers/{ica}/crypto-addresses/{crypto_address_id} | Updates a crypto address.
*MastercardMultiTokenNetworkApi.EarmarksApi* | [**earmarkSearch**](docs/EarmarksApi.md#earmarkSearch) | **GET** /customers/{ica}/earmarks | Retrieve earmarks details
*MastercardMultiTokenNetworkApi.EarmarksApi* | [**getEarmark**](docs/EarmarksApi.md#getEarmark) | **GET** /customers/{ica}/earmarks/{earmark_id} | Retrieve an earmark by using earmarkId
*MastercardMultiTokenNetworkApi.EarmarksApi* | [**postEarmark**](docs/EarmarksApi.md#postEarmark) | **POST** /customers/{ica}/earmarks | Creates an Earmark request
*MastercardMultiTokenNetworkApi.EarmarksApi* | [**updateEarmark**](docs/EarmarksApi.md#updateEarmark) | **PUT** /customers/{ica}/earmarks/{earmark_id} | Update an earmark
*MastercardMultiTokenNetworkApi.EarmarksApi* | [**updateEarmarkForCancel**](docs/EarmarksApi.md#updateEarmarkForCancel) | **PUT** /customers/{ica}/earmarks/{earmark_id}/cancel | Request to cancel an earmark
*MastercardMultiTokenNetworkApi.EarmarksApi* | [**updateEarmarkForDeposits**](docs/EarmarksApi.md#updateEarmarkForDeposits) | **PUT** /customers/{ica}/earmarks/{earmark_id}/deposits | Deposit funds for an Earmark.
*MastercardMultiTokenNetworkApi.EarmarksApi* | [**updateEarmarkForRelease**](docs/EarmarksApi.md#updateEarmarkForRelease) | **PUT** /customers/{ica}/earmarks/{earmark_id}/release | Request to release funds for an earmark
*MastercardMultiTokenNetworkApi.FiatManagementApi* | [**getFiatBalance**](docs/FiatManagementApi.md#getFiatBalance) | **GET** /customers/{ica}/fiat-balances | Retrieves an existing fiat balance for a given customer.
*MastercardMultiTokenNetworkApi.FiatWithdrawalsApi* | [**createFiatWithdrawal**](docs/FiatWithdrawalsApi.md#createFiatWithdrawal) | **POST** /customers/{ica}/fiat-withdrawals | Initiates a new fiat withdrawal.
*MastercardMultiTokenNetworkApi.FiatWithdrawalsApi* | [**getFiatWithdrawal**](docs/FiatWithdrawalsApi.md#getFiatWithdrawal) | **GET** /customers/{ica}/fiat-withdrawals/{fiat_withdrawal_id} | Retrieves an existing fiat withdrawal.
*MastercardMultiTokenNetworkApi.MarketApi* | [**getPrices**](docs/MarketApi.md#getPrices) | **GET** /customers/{ica}/prices | Retrieve prices.
*MastercardMultiTokenNetworkApi.MarketApi* | [**getQuotes**](docs/MarketApi.md#getQuotes) | **GET** /customers/{ica}/quotes | Retrieve latest quote.
*MastercardMultiTokenNetworkApi.OrdersApi* | [**getOrder**](docs/OrdersApi.md#getOrder) | **GET** /customers/{ica}/orders/{order_id} | Retrieve a consumer order.
*MastercardMultiTokenNetworkApi.OrdersApi* | [**orderPost**](docs/OrdersApi.md#orderPost) | **POST** /customers/{ica}/orders | Place a new consumer order.
*MastercardMultiTokenNetworkApi.PeerToPeerInstructionsApi* | [**getP2PInstructionRequest**](docs/PeerToPeerInstructionsApi.md#getP2PInstructionRequest) | **GET** /customers/{ica}/peer-to-peer-instructions/{instruction_id} | Retrieve a P2P instruction request.
*MastercardMultiTokenNetworkApi.PeerToPeerInstructionsApi* | [**getP2PInstructionRequests**](docs/PeerToPeerInstructionsApi.md#getP2PInstructionRequests) | **GET** /customers/{ica}/peer-to-peer-instructions | Retrieve P2P Instruction requests.
*MastercardMultiTokenNetworkApi.PeerToPeerInstructionsApi* | [**resolveP2PInstructionRequest**](docs/PeerToPeerInstructionsApi.md#resolveP2PInstructionRequest) | **POST** /customers/{ica}/peer-to-peer-instructions | Creates a P2P instruction request.
*MastercardMultiTokenNetworkApi.PeerToPeerInstructionsApi* | [**updateP2PInstructionRequest**](docs/PeerToPeerInstructionsApi.md#updateP2PInstructionRequest) | **PUT** /customers/{ica}/peer-to-peer-instructions/{instruction_id} | Update a P2P instruction request.
*MastercardMultiTokenNetworkApi.ReportsApi* | [**createReport**](docs/ReportsApi.md#createReport) | **POST** /customers/{ica}/reports | Create a report request
*MastercardMultiTokenNetworkApi.ReportsApi* | [**getReport**](docs/ReportsApi.md#getReport) | **GET** /customers/{ica}/reports/{report_id} | Retrieve a report request
*MastercardMultiTokenNetworkApi.ReportsApi* | [**getReportRequests**](docs/ReportsApi.md#getReportRequests) | **GET** /customers/{ica}/reports | Retrieve report requests
*MastercardMultiTokenNetworkApi.TokenManagementApi* | [**getBalances**](docs/TokenManagementApi.md#getBalances) | **POST** /customers/{ica}/token-balances | Retrieve token balance.
*MastercardMultiTokenNetworkApi.TokenManagementApi* | [**getOperation**](docs/TokenManagementApi.md#getOperation) | **GET** /customers/{ica}/token-operations/{operation_id} | Retrieve details of token operation.
*MastercardMultiTokenNetworkApi.TokenManagementApi* | [**submitOperation**](docs/TokenManagementApi.md#submitOperation) | **POST** /customers/{ica}/token-operations | Submit token operation.
*MastercardMultiTokenNetworkApi.TokenSettlementApi* | [**getSettlementAdvisement**](docs/TokenSettlementApi.md#getSettlementAdvisement) | **GET** /customers/{ica}/token-settlement-advisements | Get Settlement Advisement.
*MastercardMultiTokenNetworkApi.TravelRulesApi* | [**putBeneficiaryDetails**](docs/TravelRulesApi.md#putBeneficiaryDetails) | **PUT** /customers/{ica}/travel-rule-transfers/{travel_rule_transfer_id}/beneficiary-details | Provide beneficiary information required as per travel rules.
*MastercardMultiTokenNetworkApi.TravelRulesApi* | [**putOriginatorDetails**](docs/TravelRulesApi.md#putOriginatorDetails) | **PUT** /customers/{ica}/travel-rule-transfers/{travel_rule_transfer_id}/originator-details | Provide originator information required as per travel rules.


## Documentation for Models

 - [MastercardMultiTokenNetworkApi.Account](docs/Account.md)
 - [MastercardMultiTokenNetworkApi.AccountBalance](docs/AccountBalance.md)
 - [MastercardMultiTokenNetworkApi.AccountResolution](docs/AccountResolution.md)
 - [MastercardMultiTokenNetworkApi.AccountResolutionP2PInstruction](docs/AccountResolutionP2PInstruction.md)
 - [MastercardMultiTokenNetworkApi.AccountResolutionPaginationDataAndMetaData](docs/AccountResolutionPaginationDataAndMetaData.md)
 - [MastercardMultiTokenNetworkApi.AccountResolutions](docs/AccountResolutions.md)
 - [MastercardMultiTokenNetworkApi.AccountSearch](docs/AccountSearch.md)
 - [MastercardMultiTokenNetworkApi.Advisement](docs/Advisement.md)
 - [MastercardMultiTokenNetworkApi.AliasBeneficiaryConsumer](docs/AliasBeneficiaryConsumer.md)
 - [MastercardMultiTokenNetworkApi.AssetBalance](docs/AssetBalance.md)
 - [MastercardMultiTokenNetworkApi.AttestationBeneficiaryConsumer](docs/AttestationBeneficiaryConsumer.md)
 - [MastercardMultiTokenNetworkApi.AttestationP2PInstruction](docs/AttestationP2PInstruction.md)
 - [MastercardMultiTokenNetworkApi.BeneficiaryInformation](docs/BeneficiaryInformation.md)
 - [MastercardMultiTokenNetworkApi.BlockchainTransaction](docs/BlockchainTransaction.md)
 - [MastercardMultiTokenNetworkApi.BurnOperation](docs/BurnOperation.md)
 - [MastercardMultiTokenNetworkApi.BuyOrder](docs/BuyOrder.md)
 - [MastercardMultiTokenNetworkApi.Claim](docs/Claim.md)
 - [MastercardMultiTokenNetworkApi.Consumer](docs/Consumer.md)
 - [MastercardMultiTokenNetworkApi.ConsumerTravelTransferBeneficiary](docs/ConsumerTravelTransferBeneficiary.md)
 - [MastercardMultiTokenNetworkApi.ConsumerTravelTransferOriginator](docs/ConsumerTravelTransferOriginator.md)
 - [MastercardMultiTokenNetworkApi.CreateFiatWithdrawal](docs/CreateFiatWithdrawal.md)
 - [MastercardMultiTokenNetworkApi.CryptoAddress](docs/CryptoAddress.md)
 - [MastercardMultiTokenNetworkApi.CryptoAddressRiskScore](docs/CryptoAddressRiskScore.md)
 - [MastercardMultiTokenNetworkApi.DateAndPlaceOfBirth](docs/DateAndPlaceOfBirth.md)
 - [MastercardMultiTokenNetworkApi.Deposit](docs/Deposit.md)
 - [MastercardMultiTokenNetworkApi.Earmark](docs/Earmark.md)
 - [MastercardMultiTokenNetworkApi.EarmarkPaginationDataAndMetaData](docs/EarmarkPaginationDataAndMetaData.md)
 - [MastercardMultiTokenNetworkApi.Earmarks](docs/Earmarks.md)
 - [MastercardMultiTokenNetworkApi.Error](docs/Error.md)
 - [MastercardMultiTokenNetworkApi.ErrorResponse](docs/ErrorResponse.md)
 - [MastercardMultiTokenNetworkApi.Errors](docs/Errors.md)
 - [MastercardMultiTokenNetworkApi.Fee](docs/Fee.md)
 - [MastercardMultiTokenNetworkApi.FiatBalances](docs/FiatBalances.md)
 - [MastercardMultiTokenNetworkApi.FiatBalancesData](docs/FiatBalancesData.md)
 - [MastercardMultiTokenNetworkApi.FiatWithdrawal](docs/FiatWithdrawal.md)
 - [MastercardMultiTokenNetworkApi.GeographicAddress](docs/GeographicAddress.md)
 - [MastercardMultiTokenNetworkApi.MintOperation](docs/MintOperation.md)
 - [MastercardMultiTokenNetworkApi.Name](docs/Name.md)
 - [MastercardMultiTokenNetworkApi.NameIdentifier](docs/NameIdentifier.md)
 - [MastercardMultiTokenNetworkApi.NationalIdentification](docs/NationalIdentification.md)
 - [MastercardMultiTokenNetworkApi.NaturalPerson](docs/NaturalPerson.md)
 - [MastercardMultiTokenNetworkApi.Obligation](docs/Obligation.md)
 - [MastercardMultiTokenNetworkApi.Order](docs/Order.md)
 - [MastercardMultiTokenNetworkApi.OriginatorConsumer](docs/OriginatorConsumer.md)
 - [MastercardMultiTokenNetworkApi.OriginatorInformation](docs/OriginatorInformation.md)
 - [MastercardMultiTokenNetworkApi.P2PInstruction](docs/P2PInstruction.md)
 - [MastercardMultiTokenNetworkApi.P2PInstructionPaginationDataAndMetaData](docs/P2PInstructionPaginationDataAndMetaData.md)
 - [MastercardMultiTokenNetworkApi.P2PInstructions](docs/P2PInstructions.md)
 - [MastercardMultiTokenNetworkApi.P2PWeb3Data](docs/P2PWeb3Data.md)
 - [MastercardMultiTokenNetworkApi.Payer](docs/Payer.md)
 - [MastercardMultiTokenNetworkApi.Payout](docs/Payout.md)
 - [MastercardMultiTokenNetworkApi.Person](docs/Person.md)
 - [MastercardMultiTokenNetworkApi.Price](docs/Price.md)
 - [MastercardMultiTokenNetworkApi.Quote](docs/Quote.md)
 - [MastercardMultiTokenNetworkApi.QuoteFilter](docs/QuoteFilter.md)
 - [MastercardMultiTokenNetworkApi.QuoteOrder](docs/QuoteOrder.md)
 - [MastercardMultiTokenNetworkApi.Receipt](docs/Receipt.md)
 - [MastercardMultiTokenNetworkApi.Recipient](docs/Recipient.md)
 - [MastercardMultiTokenNetworkApi.Refund](docs/Refund.md)
 - [MastercardMultiTokenNetworkApi.Release](docs/Release.md)
 - [MastercardMultiTokenNetworkApi.ReleaseConditions](docs/ReleaseConditions.md)
 - [MastercardMultiTokenNetworkApi.Report](docs/Report.md)
 - [MastercardMultiTokenNetworkApi.ReportPaginationDataAndMetaData](docs/ReportPaginationDataAndMetaData.md)
 - [MastercardMultiTokenNetworkApi.Reports](docs/Reports.md)
 - [MastercardMultiTokenNetworkApi.SellOrder](docs/SellOrder.md)
 - [MastercardMultiTokenNetworkApi.SettlementAdvisement](docs/SettlementAdvisement.md)
 - [MastercardMultiTokenNetworkApi.StatusReasonInformation](docs/StatusReasonInformation.md)
 - [MastercardMultiTokenNetworkApi.TokenBalance](docs/TokenBalance.md)
 - [MastercardMultiTokenNetworkApi.TokenIdentifier](docs/TokenIdentifier.md)
 - [MastercardMultiTokenNetworkApi.TokenOperation](docs/TokenOperation.md)
 - [MastercardMultiTokenNetworkApi.TransactionReportCriteria](docs/TransactionReportCriteria.md)
 - [MastercardMultiTokenNetworkApi.TransferOperation](docs/TransferOperation.md)
 - [MastercardMultiTokenNetworkApi.TriggerIndex](docs/TriggerIndex.md)
 - [MastercardMultiTokenNetworkApi.Vasp](docs/Vasp.md)


## Documentation for Authorization

All endpoints do not require authorization.

---
_Source: https://npm.io/package/cpay-mtn-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._