mangopay2-nodejs-sdk/docs/README.md

Mangopay Node.js SDK

# MangoPay Node.js SDK Documentation

## Services
* [CardPreAuthorizations](CardPreAuthorizations.md)
* [CardRegistrations](CardRegistrations.md)
* [Cards](Cards.md)
* [DisputeDocuments](DisputeDocuments.md)
* [Disputes](Disputes.md)
* [Events](Events.md)
* [Hooks](Hooks.md)
* [KycDocuments](KycDocuments.md)
* [PayIns](PayIns.md)
* [PayOuts](PayOuts.md)
* [Refunds](Refunds.md)
* [Responses](Responses.md)
* [Transfers](Transfers.md)
* [Users](Users.md)
* [Wallets](Wallets.md)

## All available functions
| Function | Description | Source Code |
| -------- | ----------- | ----------- |
|[BankingAliases.activate](BankingAliases.md) | Activate banking alias | [../lib/services/BankingAliases.js](../lib/services/BankingAliases.js) |
|[Mandates.cancel](Mandates.md) | Cancel a mandate | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
|[Disputes.closeDispute](Disputes.md) | Close dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[Disputes.contestDispute](Disputes.md) | Contest dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[CardRegistrations.create](CardRegistrations.md) | Create new card registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.js) |
|[BankingAliases.create](BankingAliases.md) | Create a banking alias | [../lib/services/BankingAliases.js](../lib/services/BankingAliases.js) |
|[Hooks.create](Hooks.md) | Create new hook | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
|[PayOuts.create](PayOuts.md) | Create new pay-out | [../lib/services/PayOuts.js](../lib/services/PayOuts.js) |
|[CardPreAuthorizations.create](CardPreAuthorizations.md) | Create new pre-authorization | [../lib/services/CardPreAuthorizations.js](../lib/services/CardPreAuthorizations.js) |
|[Mandates.create](Mandates.md) | Create a new Mandate | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
|[PayIns.create](PayIns.md) | Create new pay-in | [../lib/services/PayIns.js](../lib/services/PayIns.js) |
|[Wallets.create](Wallets.md) | Create new wallet | [../lib/services/Wallets.js](../lib/services/Wallets.js) |
|[Transfers.create](Transfers.md) | Create new transfer | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
|[Reports.create](Reports.md) | Create a report | [../lib/services/Reports.js](../lib/services/Reports.js) |
|[.create](UboDeclarations.md) | Create a UBO declaration object from the API | [../lib/services/UboDeclarations.js](../lib/services/UboDeclarations.js) |
|[Users.create](Users.md) | Create a new user | [../lib/services/Users.js](../lib/services/Users.js) |
|[Users.createBankAccount](Users.md) | Create bank account for user | [../lib/services/Users.js](../lib/services/Users.js) |
|[Disputes.createDisputeDocument](Disputes.md) | Creates document for dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[DisputeDocuments.createDisputeDocumentConsult](DisputeDocuments.md) | Creates temporary URLs where each page of a dispute document can be viewed. | [../lib/services/DisputeDocuments.js](../lib/services/DisputeDocuments.js) |
|[Disputes.createDisputeDocumentPage](Disputes.md) | Creates document's page for dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[Disputes.createDisputeDocumentPageFromFile](Disputes.md) | Creates document's page for dispute from file | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[Users.createKycDocument](Users.md) | Create new KYC document | [../lib/services/Users.js](../lib/services/Users.js) |
|[KycDocuments.createKycDocumentConsult](KycDocuments.md) | Creates temporary URLs where each page of a KYC document can be viewed. | [../lib/services/KycDocuments.js](../lib/services/KycDocuments.js) |
|[Users.createKycPage](Users.md) | Create page for KYC document | [../lib/services/Users.js](../lib/services/Users.js) |
|[Users.createKycPageFromFile](Users.md) | Create page for KYC document | [../lib/services/Users.js](../lib/services/Users.js) |
|[PayIns.createRefund](PayIns.md) | Create refund for pay-in object | [../lib/services/PayIns.js](../lib/services/PayIns.js) |
|[Transfers.createRefund](Transfers.md) | Create refund for transfer object | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
|[Disputes.createSettlementTransfer](Disputes.md) | Creates settlement transfer | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[BankingAliases.deactivate](BankingAliases.md) | Deactivate banking alias | [../lib/services/BankingAliases.js](../lib/services/BankingAliases.js) |
|[Users.deactivateBankAccount](Users.md) | Deactivate a bank account | [../lib/services/Users.js](../lib/services/Users.js) |
|[CardRegistrations.get](CardRegistrations.md) | Get registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.js) |
|[Clients.get](Clients.md) | Get client by ID | [../lib/services/Clients.js](../lib/services/Clients.js) |
|[BankingAliases.get](BankingAliases.md) | Get a banking alias | [../lib/services/BankingAliases.js](../lib/services/BankingAliases.js) |
|[Hooks.get](Hooks.md) | Get hook | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
|[PayOuts.get](PayOuts.md) | Get payout | [../lib/services/PayOuts.js](../lib/services/PayOuts.js) |
|[DisputeDocuments.get](DisputeDocuments.md) | Gets dispute's document | [../lib/services/DisputeDocuments.js](../lib/services/DisputeDocuments.js) |
|[KycDocuments.get](KycDocuments.md) | Get KycDocument | [../lib/services/KycDocuments.js](../lib/services/KycDocuments.js) |
|[CardPreAuthorizations.get](CardPreAuthorizations.md) | Get pre-authorization object | [../lib/services/CardPreAuthorizations.js](../lib/services/CardPreAuthorizations.js) |
|[Cards.get](Cards.md) | Get card | [../lib/services/Cards.js](../lib/services/Cards.js) |
|[Mandates.get](Mandates.md) | Get mandate by ID | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
|[PayIns.get](PayIns.md) | Get pay-in | [../lib/services/PayIns.js](../lib/services/PayIns.js) |
|[Disputes.get](Disputes.md) | Get dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[Responses.get](Responses.md) | Get response from previous call | [../lib/services/Responses.js](../lib/services/Responses.js) |
|[Refunds.get](Refunds.md) | Get events | [../lib/services/Refunds.js](../lib/services/Refunds.js) |
|[Wallets.get](Wallets.md) | Get pay-in | [../lib/services/Wallets.js](../lib/services/Wallets.js) |
|[Transfers.get](Transfers.md) | Get transfer | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
|[Reports.get](Reports.md) | Get a report | [../lib/services/Reports.js](../lib/services/Reports.js) |
|[.get](UboDeclarations.md) | Retrieves a UBO declaration object from the API. | [../lib/services/UboDeclarations.js](../lib/services/UboDeclarations.js) |
|[Users.get](Users.md) | Get natural or legal user by ID | [../lib/services/Users.js](../lib/services/Users.js) |
|[Events.getAll](Events.md) | Get events | [../lib/services/Events.js](../lib/services/Events.js) |
|[BankingAliases.getAll](BankingAliases.md) | Get all banking aliases | [../lib/services/BankingAliases.js](../lib/services/BankingAliases.js) |
|[Hooks.getAll](Hooks.md) | Get all hooks | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
|[DisputeDocuments.getAll](DisputeDocuments.md) | Gets dispute's documents for client | [../lib/services/DisputeDocuments.js](../lib/services/DisputeDocuments.js) |
|[KycDocuments.getAll](KycDocuments.md) | Get all KycDocuments | [../lib/services/KycDocuments.js](../lib/services/KycDocuments.js) |
|[Mandates.getAll](Mandates.md) | Get all mandates | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
|[Disputes.getAll](Disputes.md) | Get all disputes | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[Reports.getAll](Reports.md) | Get all reports | [../lib/services/Reports.js](../lib/services/Reports.js) |
|[Users.getAll](Users.md) | Get all users | [../lib/services/Users.js](../lib/services/Users.js) |
|[Users.getBankAccount](Users.md) | Get all bank accounts for user | [../lib/services/Users.js](../lib/services/Users.js) |
|[Users.getBankAccounts](Users.md) | Get all bank accounts for user | [../lib/services/Users.js](../lib/services/Users.js) |
|[Cards.getByFingerprint](Cards.md) | Gets a list of cards having the same fingerprint.
The fingerprint is a hash uniquely generated per 16-digit card number. | [../lib/services/Cards.js](../lib/services/Cards.js) |
|[.getById](UboDeclarations.md) | Retrieves a UBO declaration object from the API. | [../lib/services/UboDeclarations.js](../lib/services/UboDeclarations.js) |
|[Users.getCards](Users.md) | Get all cards for user | [../lib/services/Users.js](../lib/services/Users.js) |
|[Clients.getClientWallet](Clients.md) | Get a client wallet | [../lib/services/Clients.js](../lib/services/Clients.js) |
|[Clients.getClientWalletTransactions](Clients.md) | Get a client wallet's transactions | [../lib/services/Clients.js](../lib/services/Clients.js) |
|[Clients.getClientWallets](Clients.md) | Get all client wallets | [../lib/services/Clients.js](../lib/services/Clients.js) |
|[Clients.getClientWalletsByFundsType](Clients.md) | Get client wallets by the type of funds | [../lib/services/Clients.js](../lib/services/Clients.js) |
|[Disputes.getDisputesForUser](Disputes.md) | Gets user's disputes | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[Disputes.getDisputesForWallet](Disputes.md) | Gets dispute's documents for wallet | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[Disputes.getDocumentsForDispute](Disputes.md) | Gets documents for dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[Users.getEMoney](Users.md) | Get users's EMoney | [../lib/services/Users.js](../lib/services/Users.js) |
|[Users.getKycDocument](Users.md) | Get KYC document | [../lib/services/Users.js](../lib/services/Users.js) |
|[Users.getKycDocuments](Users.md) | Get all KYC documents for user | [../lib/services/Users.js](../lib/services/Users.js) |
|[Users.getLegal](Users.md) | Get legal user by ID | [../lib/services/Users.js](../lib/services/Users.js) |
|[Mandates.getMandatesForBankAccount](Mandates.md) | Gets bank account mandates | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
|[Mandates.getMandatesForUser](Mandates.md) | Gets user's mandates | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
|[Users.getNatural](Users.md) | Get natural user by ID | [../lib/services/Users.js](../lib/services/Users.js) |
|[Disputes.getPendingSettlement](Disputes.md) | Retrieve a list of Disputes pending settlement | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[Cards.getPreAuthorizations](Cards.md) | Gets list of PreAuthorizations of a Card. | [../lib/services/Cards.js](../lib/services/Cards.js) |
|[PayOuts.getRefunds](PayOuts.md) | Gets list of Refunds of a PayOut | [../lib/services/PayOuts.js](../lib/services/PayOuts.js) |
|[PayIns.getRefunds](PayIns.md) | Gets list of Refunds for a PayIn | [../lib/services/PayIns.js](../lib/services/PayIns.js) |
|[Repudiations.getRefunds](Repudiations.md) | Gets list of Refunds of a Repudiation | [../lib/services/Repudiations.js](../lib/services/Repudiations.js) |
|[Transfers.getRefunds](Transfers.md) | Gets list of Refunds of a Transfer | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
|[Disputes.getRepudiation](Disputes.md) | Gets repudiation | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[Disputes.getSettlementTransfer](Disputes.md) | Gets settlement transfer | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[BankAccounts.getTransactions](BankAccounts.md) | Retrieve list of transactions for a bank account | [../lib/services/BankAccounts.js](../lib/services/BankAccounts.js) |
|[Cards.getTransactions](Cards.md) | Get list of Transactions of a Card | [../lib/services/Cards.js](../lib/services/Cards.js) |
|[Mandates.getTransactions](Mandates.md) | Gets Transactions for a Mandate | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
|[Disputes.getTransactions](Disputes.md) | Gets dispute's transactions | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[Wallets.getTransactions](Wallets.md) | Get transactions for the wallet | [../lib/services/Wallets.js](../lib/services/Wallets.js) |
|[Users.getTransactions](Users.md) | Get all transactions for user | [../lib/services/Users.js](../lib/services/Users.js) |
|[Users.getWallets](Users.md) | Get all wallets accounts for user | [../lib/services/Users.js](../lib/services/Users.js) |
|[Disputes.resubmitDispute](Disputes.md) | This method is used to resubmit a Dispute if it is reopened requiring more docs | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[CardRegistrations.update](CardRegistrations.md) | Update card registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.js) |
|[Clients.update](Clients.md) | Update client | [../lib/services/Clients.js](../lib/services/Clients.js) |
|[BankingAliases.update](BankingAliases.md) | Update banking alias | [../lib/services/BankingAliases.js](../lib/services/BankingAliases.js) |
|[Hooks.update](Hooks.md) | Save hook | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
|[CardPreAuthorizations.update](CardPreAuthorizations.md) | Update pre-authorization object | [../lib/services/CardPreAuthorizations.js](../lib/services/CardPreAuthorizations.js) |
|[Cards.update](Cards.md) | Update card | [../lib/services/Cards.js](../lib/services/Cards.js) |
|[Disputes.update](Disputes.md) | Update dispute's tag | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[Wallets.update](Wallets.md) | Update wallet | [../lib/services/Wallets.js](../lib/services/Wallets.js) |
|[.update](UboDeclarations.md) | Updates a UBO declaration entity. | [../lib/services/UboDeclarations.js](../lib/services/UboDeclarations.js) |
|[Users.update](Users.md) | Save user | [../lib/services/Users.js](../lib/services/Users.js) |
|[Disputes.updateDisputeDocument](Disputes.md) | Update dispute document | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|[Users.updateKycDocument](Users.md) | Save KYC document | [../lib/services/Users.js](../lib/services/Users.js) |
|[Clients.uploadLogo](Clients.md) | Upload client logo | [../lib/services/Clients.js](../lib/services/Clients.js) |
|[Clients.uploadLogoFromFile](Clients.md) | Upload client logo from file | [../lib/services/Clients.js](../lib/services/Clients.js) |
|[.withIdempotency](OptionsHelper.md) | Adds Idempotency-Key headers to the provided 'options' parameter | [../lib/services/OptionsHelper.js](../lib/services/OptionsHelper.js) |