mangopay4-nodejs-sdk 1.64.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/node.js.yml +32 -0
- package/.github/workflows/npm-publish.yml +26 -0
- package/.jshintrc +16 -0
- package/CHANGELOG.md +946 -0
- package/LICENSE +21 -0
- package/README.md +179 -0
- package/docs/BankAccounts.md +35 -0
- package/docs/BankingAliases.md +108 -0
- package/docs/CardPreAuthorizations.md +55 -0
- package/docs/CardRegistrations.md +55 -0
- package/docs/Cards.md +82 -0
- package/docs/Clients.md +142 -0
- package/docs/DisputeDocuments.md +53 -0
- package/docs/Disputes.md +292 -0
- package/docs/Events.md +23 -0
- package/docs/Hooks.md +68 -0
- package/docs/Idempotency.md +11 -0
- package/docs/KycDocuments.md +52 -0
- package/docs/Mandates.md +125 -0
- package/docs/OptionsHelper.md +32 -0
- package/docs/PayIns.md +72 -0
- package/docs/PayOuts.md +55 -0
- package/docs/README.md +131 -0
- package/docs/Refunds.md +25 -0
- package/docs/Reports.md +63 -0
- package/docs/Repudiations.md +25 -0
- package/docs/Responses.md +33 -0
- package/docs/Transfers.md +72 -0
- package/docs/UboDeclarations.md +70 -0
- package/docs/Users.md +322 -0
- package/docs/Wallets.md +70 -0
- package/docs/templates/class.mustache +11 -0
- package/docs/templates/file.mustache +53 -0
- package/docs/templates/function.mustache +33 -0
- package/docs/templates/index.mustache +26 -0
- package/docs/templates/overview.mustache +1 -0
- package/examples/createUsers.js +112 -0
- package/examples/createWallet.js +28 -0
- package/examples/failedRequest.js +20 -0
- package/examples/getBankAccounts.js +29 -0
- package/examples/getUserEmoney.js +16 -0
- package/examples/getUsers.js +32 -0
- package/examples/readResponseHeaders.js +42 -0
- package/index.js +1 -0
- package/lib/Model.js +58 -0
- package/lib/api.js +467 -0
- package/lib/apiMethods.js +270 -0
- package/lib/config.js +57 -0
- package/lib/log.js +9 -0
- package/lib/mangopay.js +8 -0
- package/lib/models/Address.js +32 -0
- package/lib/models/BankAccount.js +45 -0
- package/lib/models/BankAccountDetails.js +7 -0
- package/lib/models/BankAccountDetailsCA.js +12 -0
- package/lib/models/BankAccountDetailsGB.js +10 -0
- package/lib/models/BankAccountDetailsIBAN.js +10 -0
- package/lib/models/BankAccountDetailsOTHER.js +16 -0
- package/lib/models/BankAccountDetailsUS.js +14 -0
- package/lib/models/BankAccountType.js +8 -0
- package/lib/models/BankingAlias.js +37 -0
- package/lib/models/BankingAliasIBAN.js +27 -0
- package/lib/models/Billing.js +14 -0
- package/lib/models/BinData.js +16 -0
- package/lib/models/Birthplace.js +10 -0
- package/lib/models/BrowserInfo.js +15 -0
- package/lib/models/Card.js +19 -0
- package/lib/models/CardInfo.js +32 -0
- package/lib/models/CardPreAuthorization.js +144 -0
- package/lib/models/CardRegistration.js +29 -0
- package/lib/models/CardValidation.js +19 -0
- package/lib/models/CategorizeUserLegal.js +15 -0
- package/lib/models/CategorizeUserNatural.js +18 -0
- package/lib/models/Check.js +13 -0
- package/lib/models/CheckData.js +8 -0
- package/lib/models/Client.js +62 -0
- package/lib/models/ClientWallet.js +28 -0
- package/lib/models/Conversion.js +19 -0
- package/lib/models/ConversionRate.js +10 -0
- package/lib/models/CountryAuthorization.js +12 -0
- package/lib/models/DebitedBankAccount.js +15 -0
- package/lib/models/DeclaredUbo.js +29 -0
- package/lib/models/DeclaredUboStatus.js +17 -0
- package/lib/models/Deposit.js +29 -0
- package/lib/models/Dispute.js +46 -0
- package/lib/models/DisputeDocument.js +10 -0
- package/lib/models/DisputeDocumentPage.js +12 -0
- package/lib/models/DisputeReason.js +11 -0
- package/lib/models/Document.js +12 -0
- package/lib/models/DocumentPageConsult.js +17 -0
- package/lib/models/EMoney.js +30 -0
- package/lib/models/EntityBase.js +70 -0
- package/lib/models/Hook.js +19 -0
- package/lib/models/IdempotencyResponse.js +11 -0
- package/lib/models/IdentityVerification.js +12 -0
- package/lib/models/KycDocument.js +11 -0
- package/lib/models/KycDocumentStatus.js +7 -0
- package/lib/models/KycDocumentType.js +7 -0
- package/lib/models/KycPage.js +12 -0
- package/lib/models/LegalPersonType.js +7 -0
- package/lib/models/LegalRepresentative.js +16 -0
- package/lib/models/Mandate.js +69 -0
- package/lib/models/MandateStatus.js +7 -0
- package/lib/models/Money.js +16 -0
- package/lib/models/PayByBankSupportedBank.js +7 -0
- package/lib/models/PayIn.js +36 -0
- package/lib/models/PayInExecutionDetails.js +7 -0
- package/lib/models/PayInExecutionDetailsBankingAlias.js +19 -0
- package/lib/models/PayInExecutionDetailsDirect.js +29 -0
- package/lib/models/PayInExecutionDetailsWeb.js +40 -0
- package/lib/models/PayInExecutionType.js +5 -0
- package/lib/models/PayInIntent.js +20 -0
- package/lib/models/PayInIntentSplit.js +14 -0
- package/lib/models/PayInIntentSplits.js +7 -0
- package/lib/models/PayInPaymentDetails.js +7 -0
- package/lib/models/PayInPaymentDetailsApplePay.js +19 -0
- package/lib/models/PayInPaymentDetailsBancontact.js +13 -0
- package/lib/models/PayInPaymentDetailsBankWire.js +23 -0
- package/lib/models/PayInPaymentDetailsBankingAlias.js +18 -0
- package/lib/models/PayInPaymentDetailsBizum.js +23 -0
- package/lib/models/PayInPaymentDetailsBlik.js +17 -0
- package/lib/models/PayInPaymentDetailsCard.js +10 -0
- package/lib/models/PayInPaymentDetailsCardDirect.js +14 -0
- package/lib/models/PayInPaymentDetailsCardWeb.js +28 -0
- package/lib/models/PayInPaymentDetailsDirectDebitDirect.js +22 -0
- package/lib/models/PayInPaymentDetailsDirectDebitWeb.js +13 -0
- package/lib/models/PayInPaymentDetailsGiropay.js +15 -0
- package/lib/models/PayInPaymentDetailsGooglePay.js +35 -0
- package/lib/models/PayInPaymentDetailsIdeal.js +25 -0
- package/lib/models/PayInPaymentDetailsKlarna.js +36 -0
- package/lib/models/PayInPaymentDetailsMbway.js +20 -0
- package/lib/models/PayInPaymentDetailsMultibanco.js +14 -0
- package/lib/models/PayInPaymentDetailsPayByBank.js +71 -0
- package/lib/models/PayInPaymentDetailsPayPal.js +63 -0
- package/lib/models/PayInPaymentDetailsPayconiq.js +23 -0
- package/lib/models/PayInPaymentDetailsPreAuthorized.js +10 -0
- package/lib/models/PayInPaymentDetailsSatispay.js +19 -0
- package/lib/models/PayInPaymentDetailsSwish.js +35 -0
- package/lib/models/PayInPaymentDetailsTwint.js +15 -0
- package/lib/models/PayInPaymentType.js +21 -0
- package/lib/models/PayInRecurringRegistration.js +64 -0
- package/lib/models/PayInTemplateURLOptions.js +10 -0
- package/lib/models/PayOut.js +24 -0
- package/lib/models/PayOutPaymentDetails.js +7 -0
- package/lib/models/PayOutPaymentDetailsBankWire.js +32 -0
- package/lib/models/PayOutPaymentType.js +3 -0
- package/lib/models/PaymentData.js +20 -0
- package/lib/models/PaymentMethodMetadata.js +38 -0
- package/lib/models/PayoutMethods.js +7 -0
- package/lib/models/PendingUserAction.js +16 -0
- package/lib/models/PersonType.js +5 -0
- package/lib/models/PlatformCategorization.js +16 -0
- package/lib/models/PlatformType.js +10 -0
- package/lib/models/Quote.js +11 -0
- package/lib/models/Recipient.js +20 -0
- package/lib/models/RecipientSchema.js +17 -0
- package/lib/models/RecurringPayIn.js +10 -0
- package/lib/models/RecurringPayInCIT.js +32 -0
- package/lib/models/RecurringPayInCurrentState.js +24 -0
- package/lib/models/RecurringPayInMIT.js +27 -0
- package/lib/models/RecurringPayInPut.js +24 -0
- package/lib/models/Refund.js +26 -0
- package/lib/models/RefundReasonDetails.js +10 -0
- package/lib/models/Report.js +54 -0
- package/lib/models/ReportFilter.js +52 -0
- package/lib/models/ReportFilterV2.js +11 -0
- package/lib/models/ReportV2.js +28 -0
- package/lib/models/Repudiation.js +51 -0
- package/lib/models/SecurityInfo.js +12 -0
- package/lib/models/Settlement.js +16 -0
- package/lib/models/SettlementTransfer.js +37 -0
- package/lib/models/Shipping.js +14 -0
- package/lib/models/ShippingAddress.js +25 -0
- package/lib/models/ShippingPreference.js +5 -0
- package/lib/models/Transaction.js +50 -0
- package/lib/models/Transfer.js +13 -0
- package/lib/models/Ubo.js +19 -0
- package/lib/models/UboDeclaration.js +42 -0
- package/lib/models/UboDeclarationRefusedReasonType.js +23 -0
- package/lib/models/UboDeclarationStatus.js +26 -0
- package/lib/models/UboRefusedReasonType.js +14 -0
- package/lib/models/User.js +66 -0
- package/lib/models/UserCategory.js +5 -0
- package/lib/models/UserConsent.js +7 -0
- package/lib/models/UserDataFormatValidation.js +7 -0
- package/lib/models/UserEnrollmentResult.js +7 -0
- package/lib/models/UserLegal.js +65 -0
- package/lib/models/UserLegalOwner.js +66 -0
- package/lib/models/UserLegalPayer.js +66 -0
- package/lib/models/UserLegalSca.js +57 -0
- package/lib/models/UserNatural.js +51 -0
- package/lib/models/UserNaturalCapacity.js +13 -0
- package/lib/models/UserNaturalOwner.js +55 -0
- package/lib/models/UserNaturalPayer.js +55 -0
- package/lib/models/UserNaturalPut.js +49 -0
- package/lib/models/UserNaturalSca.js +56 -0
- package/lib/models/VirtualAccount.js +22 -0
- package/lib/models/Wallet.js +32 -0
- package/lib/models/index.js +102 -0
- package/lib/service.js +14 -0
- package/lib/services/BankAccounts.js +31 -0
- package/lib/services/BankingAliases.js +137 -0
- package/lib/services/CardPreAuthorizations.js +75 -0
- package/lib/services/CardRegistrations.js +64 -0
- package/lib/services/Cards.js +168 -0
- package/lib/services/Clients.js +196 -0
- package/lib/services/Conversions.js +155 -0
- package/lib/services/Deposits.js +109 -0
- package/lib/services/DisputeDocuments.js +65 -0
- package/lib/services/Disputes.js +409 -0
- package/lib/services/Events.js +24 -0
- package/lib/services/Hooks.js +81 -0
- package/lib/services/Idempotency.js +17 -0
- package/lib/services/IdentityVerifications.js +48 -0
- package/lib/services/KycDocuments.js +66 -0
- package/lib/services/Mandates.js +161 -0
- package/lib/services/OptionsHelper.js +20 -0
- package/lib/services/PayIns.js +690 -0
- package/lib/services/PayOuts.js +110 -0
- package/lib/services/Recipients.js +117 -0
- package/lib/services/Refunds.js +29 -0
- package/lib/services/Regulatory.js +29 -0
- package/lib/services/Reports.js +61 -0
- package/lib/services/ReportsV2.js +55 -0
- package/lib/services/Repudiations.js +33 -0
- package/lib/services/Responses.js +23 -0
- package/lib/services/Settlements.js +74 -0
- package/lib/services/Transfers.js +87 -0
- package/lib/services/UboDeclarations.js +135 -0
- package/lib/services/Users.js +831 -0
- package/lib/services/VirtualAccounts.js +99 -0
- package/lib/services/Wallets.js +85 -0
- package/lib/services/index.js +34 -0
- package/lib/utils.js +36 -0
- package/package.json +40 -0
- package/test/TestKycPageFile.png +0 -0
- package/test/helpers.js +1431 -0
- package/test/main.js +10 -0
- package/test/mocha.opts +3 -0
- package/test/services/BankAccounts.js +46 -0
- package/test/services/BankingAliases.js +89 -0
- package/test/services/CardPreAuthorizations.js +70 -0
- package/test/services/CardRegistrations.js +239 -0
- package/test/services/Cards.js +54 -0
- package/test/services/Clients.js +235 -0
- package/test/services/Conversions.js +308 -0
- package/test/services/Deposits.js +148 -0
- package/test/services/Disputes.js +542 -0
- package/test/services/EMoney.js +54 -0
- package/test/services/Events.js +143 -0
- package/test/services/Hooks.js +109 -0
- package/test/services/Idempotency.js +46 -0
- package/test/services/IdentityVerifications.js +68 -0
- package/test/services/KycDocuments.js +73 -0
- package/test/services/Mandates.js +256 -0
- package/test/services/PayIns.js +2553 -0
- package/test/services/PayOuts.js +106 -0
- package/test/services/RateLimit.js +48 -0
- package/test/services/Recipients.js +234 -0
- package/test/services/Refunds.js +123 -0
- package/test/services/Regulatory.js +45 -0
- package/test/services/Reports.js +114 -0
- package/test/services/ReportsV2.js +306 -0
- package/test/services/Repudiations.js +22 -0
- package/test/services/Settlements.js +58 -0
- package/test/services/Tokens.js +55 -0
- package/test/services/Transfers.js +137 -0
- package/test/services/UboDeclarations.js +135 -0
- package/test/services/Users.js +1303 -0
- package/test/services/VirtualAccounts.js +105 -0
- package/test/services/Wallets.js +132 -0
- package/test/settlement_sample.csv +8 -0
- package/typings/base.d.ts +308 -0
- package/typings/enums.d.ts +204 -0
- package/typings/index.d.ts +885 -0
- package/typings/index.test-d.ts +1535 -0
- package/typings/models/address.d.ts +70 -0
- package/typings/models/bankAccount.d.ts +235 -0
- package/typings/models/bankingAlias.d.ts +97 -0
- package/typings/models/billing.d.ts +42 -0
- package/typings/models/birthplace.d.ts +9 -0
- package/typings/models/card.d.ts +119 -0
- package/typings/models/cardPreauthorization.d.ts +157 -0
- package/typings/models/cardRegistration.d.ts +83 -0
- package/typings/models/cardValidation.d.ts +125 -0
- package/typings/models/client.d.ts +208 -0
- package/typings/models/conversion.d.ts +225 -0
- package/typings/models/conversionRate.d.ts +29 -0
- package/typings/models/countryAuthorization.d.ts +16 -0
- package/typings/models/deposit.d.ts +104 -0
- package/typings/models/dispute.d.ts +116 -0
- package/typings/models/disputeDocument.d.ts +119 -0
- package/typings/models/entityBase.d.ts +9 -0
- package/typings/models/event.d.ts +142 -0
- package/typings/models/hook.d.ts +39 -0
- package/typings/models/idempotency.d.ts +36 -0
- package/typings/models/identityVerification.d.ts +98 -0
- package/typings/models/kycDocument.d.ts +114 -0
- package/typings/models/mandate.d.ts +93 -0
- package/typings/models/money.d.ts +45 -0
- package/typings/models/payIn.d.ts +3742 -0
- package/typings/models/payOut.d.ts +144 -0
- package/typings/models/recipient.d.ts +242 -0
- package/typings/models/refund.d.ts +92 -0
- package/typings/models/report.d.ts +234 -0
- package/typings/models/reportV2.d.ts +145 -0
- package/typings/models/repudiation.d.ts +26 -0
- package/typings/models/securityInfo.d.ts +12 -0
- package/typings/models/settlement.d.ts +50 -0
- package/typings/models/settlementTransfer.d.ts +37 -0
- package/typings/models/shipping.d.ts +37 -0
- package/typings/models/shippingAddress.d.ts +15 -0
- package/typings/models/transaction.d.ts +85 -0
- package/typings/models/transfer.d.ts +119 -0
- package/typings/models/uboDeclaration.d.ts +100 -0
- package/typings/models/user.d.ts +1001 -0
- package/typings/models/virtualAccount.d.ts +182 -0
- package/typings/models/wallet.d.ts +46 -0
- package/typings/models.d.ts +74 -0
- package/typings/services/BankAccounts.d.ts +12 -0
- package/typings/services/BankingAliases.d.ts +51 -0
- package/typings/services/CardPreauthorizations.d.ts +44 -0
- package/typings/services/CardRegistrations.d.ts +43 -0
- package/typings/services/Cards.d.ts +80 -0
- package/typings/services/Clients.d.ts +77 -0
- package/typings/services/Conversions.d.ts +23 -0
- package/typings/services/Deposits.d.ts +20 -0
- package/typings/services/DisputeDocuments.d.ts +27 -0
- package/typings/services/Disputes.d.ts +169 -0
- package/typings/services/Events.d.ts +11 -0
- package/typings/services/Hooks.d.ts +33 -0
- package/typings/services/Idempotency.d.ts +7 -0
- package/typings/services/IdentityVerifications.d.ts +29 -0
- package/typings/services/KycDocuments.d.ts +38 -0
- package/typings/services/Mandates.d.ts +59 -0
- package/typings/services/OptionsHelper.d.ts +11 -0
- package/typings/services/PayIns.d.ts +319 -0
- package/typings/services/PayOuts.d.ts +34 -0
- package/typings/services/Recipients.d.ts +55 -0
- package/typings/services/Refunds.d.ts +12 -0
- package/typings/services/Regulatory.d.ts +17 -0
- package/typings/services/Reports.d.ts +26 -0
- package/typings/services/ReportsV2.d.ts +26 -0
- package/typings/services/Repudiations.d.ts +12 -0
- package/typings/services/Responses.d.ts +10 -0
- package/typings/services/Settlements.d.ts +28 -0
- package/typings/services/Transfers.d.ts +38 -0
- package/typings/services/UboDeclarations.d.ts +81 -0
- package/typings/services/Users.d.ts +308 -0
- package/typings/services/VirtualAccounts.d.ts +42 -0
- package/typings/services/Wallets.d.ts +36 -0
- package/typings/tsconfig.json +20 -0
- package/typings/tslint.json +11 -0
- package/typings/types.d.ts +652 -0
package/docs/PayIns.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# PayIns
|
|
2
|
+
|
|
3
|
+
[MangoPay PayIns API Reference](https://docs.mangopay.com/endpoints/v2.01/payins)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
* * *
|
|
8
|
+
|
|
9
|
+
### PayIns.create(payIn, callback, options)
|
|
10
|
+
|
|
11
|
+
Create new pay-in
|
|
12
|
+
|
|
13
|
+
**Parameters**
|
|
14
|
+
|
|
15
|
+
**payIn**: `Object`, PayIn object
|
|
16
|
+
|
|
17
|
+
**callback**: `function`, Callback function
|
|
18
|
+
|
|
19
|
+
**options**: `Object`, Request options
|
|
20
|
+
|
|
21
|
+
**Returns**: `Object`, Request promise
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
### PayIns.get(payInId, callback, options)
|
|
25
|
+
|
|
26
|
+
Get pay-in
|
|
27
|
+
|
|
28
|
+
**Parameters**
|
|
29
|
+
|
|
30
|
+
**payInId**: `number`, PayIn identifier
|
|
31
|
+
|
|
32
|
+
**callback**: `function`, Callback function
|
|
33
|
+
|
|
34
|
+
**options**: `Object`, Request options
|
|
35
|
+
|
|
36
|
+
**Returns**: `Object`, Request promise
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
### PayIns.createRefund(payInId, refund, callback, options)
|
|
40
|
+
|
|
41
|
+
Create refund for pay-in object
|
|
42
|
+
|
|
43
|
+
**Parameters**
|
|
44
|
+
|
|
45
|
+
**payInId**: `number`, PayIn identifier
|
|
46
|
+
|
|
47
|
+
**refund**: `Object`, Refund data
|
|
48
|
+
|
|
49
|
+
**callback**: `function`, Callback function
|
|
50
|
+
|
|
51
|
+
**options**: `Object`, Request options
|
|
52
|
+
|
|
53
|
+
**Returns**: `Object`, Request promise
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### PayIns.getRefunds(payInId, callback, options)
|
|
57
|
+
|
|
58
|
+
Gets list of Refunds for a PayIn
|
|
59
|
+
|
|
60
|
+
**Parameters**
|
|
61
|
+
|
|
62
|
+
**payInId**: `number`, PayIn identifier
|
|
63
|
+
|
|
64
|
+
**callback**: `function`, Callback function
|
|
65
|
+
|
|
66
|
+
**options**: `Object`, Request options
|
|
67
|
+
|
|
68
|
+
**Returns**: `Object`, Request promise
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
* * *
|
package/docs/PayOuts.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# PayOuts
|
|
2
|
+
|
|
3
|
+
[MangoPay PayOuts API Reference](https://docs.mangopay.com/endpoints/v2.01/payouts)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
* * *
|
|
8
|
+
|
|
9
|
+
### PayOuts.create(payOut, callback, options)
|
|
10
|
+
|
|
11
|
+
Create new pay-out
|
|
12
|
+
|
|
13
|
+
**Parameters**
|
|
14
|
+
|
|
15
|
+
**payOut**: `Object`, PayOut object
|
|
16
|
+
|
|
17
|
+
**callback**: `function`, Callback function
|
|
18
|
+
|
|
19
|
+
**options**: `Object`, Request options
|
|
20
|
+
|
|
21
|
+
**Returns**: `Object`, Request promise
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
### PayOuts.get(payOutId, callback, options)
|
|
25
|
+
|
|
26
|
+
Get payout
|
|
27
|
+
|
|
28
|
+
**Parameters**
|
|
29
|
+
|
|
30
|
+
**payOutId**: `number`, PayOut identifiers
|
|
31
|
+
|
|
32
|
+
**callback**: `function`, Callback function
|
|
33
|
+
|
|
34
|
+
**options**: `Object`, Request options
|
|
35
|
+
|
|
36
|
+
**Returns**: `Object`, Request promise
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
### PayOuts.getRefunds(payOutId, callback, options)
|
|
40
|
+
|
|
41
|
+
Gets list of Refunds of a PayOut
|
|
42
|
+
|
|
43
|
+
**Parameters**
|
|
44
|
+
|
|
45
|
+
**payOutId**: `number`, PayOut identifier
|
|
46
|
+
|
|
47
|
+
**callback**: `function`, Callback function
|
|
48
|
+
|
|
49
|
+
**options**: `Object`, Request options
|
|
50
|
+
|
|
51
|
+
**Returns**: `Object`, Request promise
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
* * *
|
package/docs/README.md
ADDED
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
# MangoPay Node.js SDK Documentation
|
|
2
|
+
|
|
3
|
+
## Services
|
|
4
|
+
* [CardPreAuthorizations](CardPreAuthorizations.md)
|
|
5
|
+
* [CardRegistrations](CardRegistrations.md)
|
|
6
|
+
* [Cards](Cards.md)
|
|
7
|
+
* [DisputeDocuments](DisputeDocuments.md)
|
|
8
|
+
* [Disputes](Disputes.md)
|
|
9
|
+
* [Events](Events.md)
|
|
10
|
+
* [Hooks](Hooks.md)
|
|
11
|
+
* [KycDocuments](KycDocuments.md)
|
|
12
|
+
* [PayIns](PayIns.md)
|
|
13
|
+
* [PayOuts](PayOuts.md)
|
|
14
|
+
* [Refunds](Refunds.md)
|
|
15
|
+
* [Responses](Responses.md)
|
|
16
|
+
* [Transfers](Transfers.md)
|
|
17
|
+
* [Users](Users.md)
|
|
18
|
+
* [Wallets](Wallets.md)
|
|
19
|
+
|
|
20
|
+
## All available functions
|
|
21
|
+
| Function | Description | Source Code |
|
|
22
|
+
| -------- | ----------- | ----------- |
|
|
23
|
+
|[BankingAliases.activate](BankingAliases.md) | Activate banking alias | [../lib/services/BankingAliases.js](../lib/services/BankingAliases.js) |
|
|
24
|
+
|[Mandates.cancel](Mandates.md) | Cancel a mandate | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
|
|
25
|
+
|[Disputes.closeDispute](Disputes.md) | Close dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
26
|
+
|[Disputes.contestDispute](Disputes.md) | Contest dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
27
|
+
|[CardRegistrations.create](CardRegistrations.md) | Create new card registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.js) |
|
|
28
|
+
|[BankingAliases.create](BankingAliases.md) | Create a banking alias | [../lib/services/BankingAliases.js](../lib/services/BankingAliases.js) |
|
|
29
|
+
|[Hooks.create](Hooks.md) | Create new hook | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
|
|
30
|
+
|[PayOuts.create](PayOuts.md) | Create new pay-out | [../lib/services/PayOuts.js](../lib/services/PayOuts.js) |
|
|
31
|
+
|[CardPreAuthorizations.create](CardPreAuthorizations.md) | Create new pre-authorization | [../lib/services/CardPreAuthorizations.js](../lib/services/CardPreAuthorizations.js) |
|
|
32
|
+
|[Mandates.create](Mandates.md) | Create a new Mandate | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
|
|
33
|
+
|[PayIns.create](PayIns.md) | Create new pay-in | [../lib/services/PayIns.js](../lib/services/PayIns.js) |
|
|
34
|
+
|[Wallets.create](Wallets.md) | Create new wallet | [../lib/services/Wallets.js](../lib/services/Wallets.js) |
|
|
35
|
+
|[Transfers.create](Transfers.md) | Create new transfer | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
|
|
36
|
+
|[Reports.create](Reports.md) | Create a report | [../lib/services/Reports.js](../lib/services/Reports.js) |
|
|
37
|
+
|[.create](UboDeclarations.md) | Create a UBO declaration object from the API | [../lib/services/UboDeclarations.js](../lib/services/UboDeclarations.js) |
|
|
38
|
+
|[Users.create](Users.md) | Create a new user | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
39
|
+
|[Users.createBankAccount](Users.md) | Create bank account for user | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
40
|
+
|[Disputes.createDisputeDocument](Disputes.md) | Creates document for dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
41
|
+
|[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) |
|
|
42
|
+
|[Disputes.createDisputeDocumentPage](Disputes.md) | Creates document's page for dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
43
|
+
|[Disputes.createDisputeDocumentPageFromFile](Disputes.md) | Creates document's page for dispute from file | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
44
|
+
|[Users.createKycDocument](Users.md) | Create new KYC document | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
45
|
+
|[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) |
|
|
46
|
+
|[Users.createKycPage](Users.md) | Create page for KYC document | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
47
|
+
|[Users.createKycPageFromFile](Users.md) | Create page for KYC document | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
48
|
+
|[PayIns.createRefund](PayIns.md) | Create refund for pay-in object | [../lib/services/PayIns.js](../lib/services/PayIns.js) |
|
|
49
|
+
|[Transfers.createRefund](Transfers.md) | Create refund for transfer object | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
|
|
50
|
+
|[Disputes.createSettlementTransfer](Disputes.md) | Creates settlement transfer | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
51
|
+
|[BankingAliases.deactivate](BankingAliases.md) | Deactivate banking alias | [../lib/services/BankingAliases.js](../lib/services/BankingAliases.js) |
|
|
52
|
+
|[Users.deactivateBankAccount](Users.md) | Deactivate a bank account | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
53
|
+
|[CardRegistrations.get](CardRegistrations.md) | Get registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.js) |
|
|
54
|
+
|[Clients.get](Clients.md) | Get client by ID | [../lib/services/Clients.js](../lib/services/Clients.js) |
|
|
55
|
+
|[BankingAliases.get](BankingAliases.md) | Get a banking alias | [../lib/services/BankingAliases.js](../lib/services/BankingAliases.js) |
|
|
56
|
+
|[Hooks.get](Hooks.md) | Get hook | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
|
|
57
|
+
|[PayOuts.get](PayOuts.md) | Get payout | [../lib/services/PayOuts.js](../lib/services/PayOuts.js) |
|
|
58
|
+
|[DisputeDocuments.get](DisputeDocuments.md) | Gets dispute's document | [../lib/services/DisputeDocuments.js](../lib/services/DisputeDocuments.js) |
|
|
59
|
+
|[KycDocuments.get](KycDocuments.md) | Get KycDocument | [../lib/services/KycDocuments.js](../lib/services/KycDocuments.js) |
|
|
60
|
+
|[CardPreAuthorizations.get](CardPreAuthorizations.md) | Get pre-authorization object | [../lib/services/CardPreAuthorizations.js](../lib/services/CardPreAuthorizations.js) |
|
|
61
|
+
|[Cards.get](Cards.md) | Get card | [../lib/services/Cards.js](../lib/services/Cards.js) |
|
|
62
|
+
|[Mandates.get](Mandates.md) | Get mandate by ID | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
|
|
63
|
+
|[PayIns.get](PayIns.md) | Get pay-in | [../lib/services/PayIns.js](../lib/services/PayIns.js) |
|
|
64
|
+
|[Disputes.get](Disputes.md) | Get dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
65
|
+
|[Responses.get](Responses.md) | Get response from previous call | [../lib/services/Responses.js](../lib/services/Responses.js) |
|
|
66
|
+
|[Refunds.get](Refunds.md) | Get events | [../lib/services/Refunds.js](../lib/services/Refunds.js) |
|
|
67
|
+
|[Wallets.get](Wallets.md) | Get pay-in | [../lib/services/Wallets.js](../lib/services/Wallets.js) |
|
|
68
|
+
|[Transfers.get](Transfers.md) | Get transfer | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
|
|
69
|
+
|[Reports.get](Reports.md) | Get a report | [../lib/services/Reports.js](../lib/services/Reports.js) |
|
|
70
|
+
|[.get](UboDeclarations.md) | Retrieves a UBO declaration object from the API. | [../lib/services/UboDeclarations.js](../lib/services/UboDeclarations.js) |
|
|
71
|
+
|[Users.get](Users.md) | Get natural or legal user by ID | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
72
|
+
|[Events.getAll](Events.md) | Get events | [../lib/services/Events.js](../lib/services/Events.js) |
|
|
73
|
+
|[BankingAliases.getAll](BankingAliases.md) | Get all banking aliases | [../lib/services/BankingAliases.js](../lib/services/BankingAliases.js) |
|
|
74
|
+
|[Hooks.getAll](Hooks.md) | Get all hooks | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
|
|
75
|
+
|[DisputeDocuments.getAll](DisputeDocuments.md) | Gets dispute's documents for client | [../lib/services/DisputeDocuments.js](../lib/services/DisputeDocuments.js) |
|
|
76
|
+
|[KycDocuments.getAll](KycDocuments.md) | Get all KycDocuments | [../lib/services/KycDocuments.js](../lib/services/KycDocuments.js) |
|
|
77
|
+
|[Mandates.getAll](Mandates.md) | Get all mandates | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
|
|
78
|
+
|[Disputes.getAll](Disputes.md) | Get all disputes | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
79
|
+
|[Reports.getAll](Reports.md) | Get all reports | [../lib/services/Reports.js](../lib/services/Reports.js) |
|
|
80
|
+
|[Users.getAll](Users.md) | Get all users | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
81
|
+
|[Users.getBankAccount](Users.md) | Get all bank accounts for user | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
82
|
+
|[Users.getBankAccounts](Users.md) | Get all bank accounts for user | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
83
|
+
|[Cards.getByFingerprint](Cards.md) | Gets a list of cards having the same fingerprint.
|
|
84
|
+
The fingerprint is a hash uniquely generated per 16-digit card number. | [../lib/services/Cards.js](../lib/services/Cards.js) |
|
|
85
|
+
|[.getById](UboDeclarations.md) | Retrieves a UBO declaration object from the API. | [../lib/services/UboDeclarations.js](../lib/services/UboDeclarations.js) |
|
|
86
|
+
|[Users.getCards](Users.md) | Get all cards for user | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
87
|
+
|[Clients.getClientWallet](Clients.md) | Get a client wallet | [../lib/services/Clients.js](../lib/services/Clients.js) |
|
|
88
|
+
|[Clients.getClientWalletTransactions](Clients.md) | Get a client wallet's transactions | [../lib/services/Clients.js](../lib/services/Clients.js) |
|
|
89
|
+
|[Clients.getClientWallets](Clients.md) | Get all client wallets | [../lib/services/Clients.js](../lib/services/Clients.js) |
|
|
90
|
+
|[Clients.getClientWalletsByFundsType](Clients.md) | Get client wallets by the type of funds | [../lib/services/Clients.js](../lib/services/Clients.js) |
|
|
91
|
+
|[Disputes.getDisputesForUser](Disputes.md) | Gets user's disputes | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
92
|
+
|[Disputes.getDisputesForWallet](Disputes.md) | Gets dispute's documents for wallet | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
93
|
+
|[Disputes.getDocumentsForDispute](Disputes.md) | Gets documents for dispute | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
94
|
+
|[Users.getEMoney](Users.md) | Get users's EMoney | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
95
|
+
|[Users.getKycDocument](Users.md) | Get KYC document | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
96
|
+
|[Users.getKycDocuments](Users.md) | Get all KYC documents for user | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
97
|
+
|[Users.getLegal](Users.md) | Get legal user by ID | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
98
|
+
|[Mandates.getMandatesForBankAccount](Mandates.md) | Gets bank account mandates | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
|
|
99
|
+
|[Mandates.getMandatesForUser](Mandates.md) | Gets user's mandates | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
|
|
100
|
+
|[Users.getNatural](Users.md) | Get natural user by ID | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
101
|
+
|[Disputes.getPendingSettlement](Disputes.md) | Retrieve a list of Disputes pending settlement | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
102
|
+
|[Cards.getPreAuthorizations](Cards.md) | Gets list of PreAuthorizations of a Card. | [../lib/services/Cards.js](../lib/services/Cards.js) |
|
|
103
|
+
|[PayOuts.getRefunds](PayOuts.md) | Gets list of Refunds of a PayOut | [../lib/services/PayOuts.js](../lib/services/PayOuts.js) |
|
|
104
|
+
|[PayIns.getRefunds](PayIns.md) | Gets list of Refunds for a PayIn | [../lib/services/PayIns.js](../lib/services/PayIns.js) |
|
|
105
|
+
|[Repudiations.getRefunds](Repudiations.md) | Gets list of Refunds of a Repudiation | [../lib/services/Repudiations.js](../lib/services/Repudiations.js) |
|
|
106
|
+
|[Transfers.getRefunds](Transfers.md) | Gets list of Refunds of a Transfer | [../lib/services/Transfers.js](../lib/services/Transfers.js) |
|
|
107
|
+
|[Disputes.getRepudiation](Disputes.md) | Gets repudiation | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
108
|
+
|[Disputes.getSettlementTransfer](Disputes.md) | Gets settlement transfer | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
109
|
+
|[BankAccounts.getTransactions](BankAccounts.md) | Retrieve list of transactions for a bank account | [../lib/services/BankAccounts.js](../lib/services/BankAccounts.js) |
|
|
110
|
+
|[Cards.getTransactions](Cards.md) | Get list of Transactions of a Card | [../lib/services/Cards.js](../lib/services/Cards.js) |
|
|
111
|
+
|[Mandates.getTransactions](Mandates.md) | Gets Transactions for a Mandate | [../lib/services/Mandates.js](../lib/services/Mandates.js) |
|
|
112
|
+
|[Disputes.getTransactions](Disputes.md) | Gets dispute's transactions | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
113
|
+
|[Wallets.getTransactions](Wallets.md) | Get transactions for the wallet | [../lib/services/Wallets.js](../lib/services/Wallets.js) |
|
|
114
|
+
|[Users.getTransactions](Users.md) | Get all transactions for user | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
115
|
+
|[Users.getWallets](Users.md) | Get all wallets accounts for user | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
116
|
+
|[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) |
|
|
117
|
+
|[CardRegistrations.update](CardRegistrations.md) | Update card registration | [../lib/services/CardRegistrations.js](../lib/services/CardRegistrations.js) |
|
|
118
|
+
|[Clients.update](Clients.md) | Update client | [../lib/services/Clients.js](../lib/services/Clients.js) |
|
|
119
|
+
|[BankingAliases.update](BankingAliases.md) | Update banking alias | [../lib/services/BankingAliases.js](../lib/services/BankingAliases.js) |
|
|
120
|
+
|[Hooks.update](Hooks.md) | Save hook | [../lib/services/Hooks.js](../lib/services/Hooks.js) |
|
|
121
|
+
|[CardPreAuthorizations.update](CardPreAuthorizations.md) | Update pre-authorization object | [../lib/services/CardPreAuthorizations.js](../lib/services/CardPreAuthorizations.js) |
|
|
122
|
+
|[Cards.update](Cards.md) | Update card | [../lib/services/Cards.js](../lib/services/Cards.js) |
|
|
123
|
+
|[Disputes.update](Disputes.md) | Update dispute's tag | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
124
|
+
|[Wallets.update](Wallets.md) | Update wallet | [../lib/services/Wallets.js](../lib/services/Wallets.js) |
|
|
125
|
+
|[.update](UboDeclarations.md) | Updates a UBO declaration entity. | [../lib/services/UboDeclarations.js](../lib/services/UboDeclarations.js) |
|
|
126
|
+
|[Users.update](Users.md) | Save user | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
127
|
+
|[Disputes.updateDisputeDocument](Disputes.md) | Update dispute document | [../lib/services/Disputes.js](../lib/services/Disputes.js) |
|
|
128
|
+
|[Users.updateKycDocument](Users.md) | Save KYC document | [../lib/services/Users.js](../lib/services/Users.js) |
|
|
129
|
+
|[Clients.uploadLogo](Clients.md) | Upload client logo | [../lib/services/Clients.js](../lib/services/Clients.js) |
|
|
130
|
+
|[Clients.uploadLogoFromFile](Clients.md) | Upload client logo from file | [../lib/services/Clients.js](../lib/services/Clients.js) |
|
|
131
|
+
|[.withIdempotency](OptionsHelper.md) | Adds Idempotency-Key headers to the provided 'options' parameter | [../lib/services/OptionsHelper.js](../lib/services/OptionsHelper.js) |
|
package/docs/Refunds.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Refunds
|
|
2
|
+
|
|
3
|
+
[MangoPay Refunds API Reference](https://docs.mangopay.com/endpoints/v2.01/refunds)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
* * *
|
|
8
|
+
|
|
9
|
+
### Refunds.get(refundId, callback, options)
|
|
10
|
+
|
|
11
|
+
Get events
|
|
12
|
+
|
|
13
|
+
**Parameters**
|
|
14
|
+
|
|
15
|
+
**refundId**: `number`, Refund id
|
|
16
|
+
|
|
17
|
+
**callback**: `function`, Callback function
|
|
18
|
+
|
|
19
|
+
**options**: `Object`, Request options
|
|
20
|
+
|
|
21
|
+
**Returns**: `Object`, Request promise
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
* * *
|
package/docs/Reports.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# Reports
|
|
2
|
+
|
|
3
|
+
[MangoPay Reports API Reference](https://docs.mangopay.com/endpoints/v2.01/reporting)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
* * *
|
|
8
|
+
|
|
9
|
+
### Reports.create(report, callback, options)
|
|
10
|
+
|
|
11
|
+
Create a report
|
|
12
|
+
|
|
13
|
+
**Parameters**
|
|
14
|
+
|
|
15
|
+
**report**: `Object`, Report Data
|
|
16
|
+
|
|
17
|
+
**callback**: `function`, Callback function
|
|
18
|
+
|
|
19
|
+
**options**: `Object`, Request options
|
|
20
|
+
|
|
21
|
+
**Returns**: `Object`, Request promise
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
### Reports.get(reportId, callback, options)
|
|
25
|
+
|
|
26
|
+
Get a report
|
|
27
|
+
|
|
28
|
+
**Parameters**
|
|
29
|
+
|
|
30
|
+
**reportId**: `number`, Report Id
|
|
31
|
+
|
|
32
|
+
**callback**: `function`, Callback function
|
|
33
|
+
|
|
34
|
+
**options**: `Object`, Request options
|
|
35
|
+
|
|
36
|
+
**Returns**: `Object`, Request promise
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
### Reports.getAll(callback, options)
|
|
40
|
+
|
|
41
|
+
Get all reports
|
|
42
|
+
|
|
43
|
+
**Parameters**
|
|
44
|
+
|
|
45
|
+
**callback**: `function`, Callback function
|
|
46
|
+
|
|
47
|
+
**options**: `Object`, Request options
|
|
48
|
+
|
|
49
|
+
**Returns**: `Object`, Request promise
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
* * *
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Repudiations
|
|
2
|
+
|
|
3
|
+
[MangoPay Repudiations API Reference](https://docs.mangopay.com/endpoints/v2.01/repudiations)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
* * *
|
|
8
|
+
|
|
9
|
+
### Repudiations.getRefunds(repudiationId, callback, options)
|
|
10
|
+
|
|
11
|
+
Gets list of Refunds of a Repudiation
|
|
12
|
+
|
|
13
|
+
**Parameters**
|
|
14
|
+
|
|
15
|
+
**repudiationId**: `number`, Repudiation identifier
|
|
16
|
+
|
|
17
|
+
**callback**: `function`, Callback function
|
|
18
|
+
|
|
19
|
+
**options**: `Object`, Request options
|
|
20
|
+
|
|
21
|
+
**Returns**: `Object`, Request promise
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
* * *
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Responses
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
* * *
|
|
8
|
+
|
|
9
|
+
### Responses.get(callback, options)
|
|
10
|
+
|
|
11
|
+
Get response from previous call
|
|
12
|
+
|
|
13
|
+
**Parameters**
|
|
14
|
+
|
|
15
|
+
**callback**: `function`, Callback function
|
|
16
|
+
|
|
17
|
+
**options**: `Object`, Request options
|
|
18
|
+
|
|
19
|
+
**Returns**: `Object`, Request promise
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
* * *
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# Transfers
|
|
2
|
+
|
|
3
|
+
[MangoPay Transfers API Reference](https://docs.mangopay.com/endpoints/v2.01/transfers)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
* * *
|
|
8
|
+
|
|
9
|
+
### Transfers.create(transfer, callback, options)
|
|
10
|
+
|
|
11
|
+
Create new transfer
|
|
12
|
+
|
|
13
|
+
**Parameters**
|
|
14
|
+
|
|
15
|
+
**transfer**: `Object`, Transfer object
|
|
16
|
+
|
|
17
|
+
**callback**: `function`, Callback function
|
|
18
|
+
|
|
19
|
+
**options**: `Object`, Request options
|
|
20
|
+
|
|
21
|
+
**Returns**: `Object`, Request promise
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
### Transfers.get(transferId, callback, options)
|
|
25
|
+
|
|
26
|
+
Get transfer
|
|
27
|
+
|
|
28
|
+
**Parameters**
|
|
29
|
+
|
|
30
|
+
**transferId**: `number`, Transfer identifier
|
|
31
|
+
|
|
32
|
+
**callback**: `function`, Callback function
|
|
33
|
+
|
|
34
|
+
**options**: `Object`, Request options
|
|
35
|
+
|
|
36
|
+
**Returns**: `Object`, Request promise
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
### Transfers.createRefund(transferId, refund, callback, options)
|
|
40
|
+
|
|
41
|
+
Create refund for transfer object
|
|
42
|
+
|
|
43
|
+
**Parameters**
|
|
44
|
+
|
|
45
|
+
**transferId**: `number`, Transfer identifier
|
|
46
|
+
|
|
47
|
+
**refund**: `Object`, Refund object
|
|
48
|
+
|
|
49
|
+
**callback**: `function`, Callback function
|
|
50
|
+
|
|
51
|
+
**options**: `Object`, Request options
|
|
52
|
+
|
|
53
|
+
**Returns**: `Object`, Request promise
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### Transfers.getRefunds(transferId, callback, options)
|
|
57
|
+
|
|
58
|
+
Gets list of Refunds of a Transfer
|
|
59
|
+
|
|
60
|
+
**Parameters**
|
|
61
|
+
|
|
62
|
+
**transferId**: `number`, Transfer identifier
|
|
63
|
+
|
|
64
|
+
**callback**: `function`, Callback function
|
|
65
|
+
|
|
66
|
+
**options**: `Object`, Request options
|
|
67
|
+
|
|
68
|
+
**Returns**: `Object`, Request promise
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
* * *
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Global
|
|
2
|
+
|
|
3
|
+
[MangoPay UBO Declaration API Reference](https://docs.mangopay.com/endpoints/v2.01/ubo-declarations)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
* * *
|
|
8
|
+
|
|
9
|
+
### create(userId, callback, options)
|
|
10
|
+
|
|
11
|
+
Create a UBO declaration object from the API
|
|
12
|
+
|
|
13
|
+
**Parameters**
|
|
14
|
+
|
|
15
|
+
**userId**: `String`, user Unique identifier
|
|
16
|
+
|
|
17
|
+
**callback**: `function`, Create a UBO declaration object from the API
|
|
18
|
+
|
|
19
|
+
**options**: `Object`, Create a UBO declaration object from the API
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
### get(userId, id, callback, options)
|
|
24
|
+
|
|
25
|
+
Retrieves a UBO declaration object from the API.
|
|
26
|
+
|
|
27
|
+
**Parameters**
|
|
28
|
+
|
|
29
|
+
**userId**: `String`, User Unique identifier
|
|
30
|
+
|
|
31
|
+
**id**: `String`, Unique identifier
|
|
32
|
+
|
|
33
|
+
**callback**: `function`, Retrieves a UBO declaration object from the API.
|
|
34
|
+
|
|
35
|
+
**options**: `Object`, Retrieves a UBO declaration object from the API.
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
### getById(id, callback, options)
|
|
40
|
+
|
|
41
|
+
Retrieves a UBO declaration object from the API.
|
|
42
|
+
|
|
43
|
+
**Parameters**
|
|
44
|
+
|
|
45
|
+
**id**: `String`, Unique identifier
|
|
46
|
+
|
|
47
|
+
**callback**: `function`, Retrieves a UBO declaration object from the API.
|
|
48
|
+
|
|
49
|
+
**options**: `Object`, Retrieves a UBO declaration object from the API.
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
### update(userId, uboDeclaration, callback, options)
|
|
54
|
+
|
|
55
|
+
Updates a UBO declaration entity.
|
|
56
|
+
|
|
57
|
+
**Parameters**
|
|
58
|
+
|
|
59
|
+
**userId**: `String`, User Unique Identifier
|
|
60
|
+
|
|
61
|
+
**uboDeclaration**: `Object`, Updated UBO declaration entity - must have ID!
|
|
62
|
+
|
|
63
|
+
**callback**: `function`, Updates a UBO declaration entity.
|
|
64
|
+
|
|
65
|
+
**options**: `Object`, Updates a UBO declaration entity.
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
* * *
|