Skip to content

Latest commit

 

History

History
131 lines (129 loc) · 16 KB

README.md

File metadata and controls

131 lines (129 loc) · 16 KB

MangoPay Node.js SDK Documentation

Services

All available functions

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