Detalhes do pacote

mangopay2-nodejs-sdk

Mangopay21.3kMIT1.57.1

Mangopay Node.js SDK

mangopay, nodejs, sdk, credit cards

readme (leia-me)

Mangopay Node.js SDK Build Status

MangopaySDK is a Node.js client library to work with Mangopay REST API.

Installation

Install the module via npm

npm install mangopay2-nodejs-sdk --save

Usage inside your app

var mangopay = require('mangopay2-nodejs-sdk');

var api = new mangopay({
    clientId: 'your_client_id',
    clientApiKey: 'your_client_api_key',
    // Set the right production API url. If testing, omit the property since it defaults to sandbox URL
    baseUrl: 'https://api.mangopay.com'
});

api.Users.create(...)

Supported options

Option Default value Description
clientId null API Client Id
clientApiKey null API Client Api Key
baseUrl "https://api.sandbox.mangopay.com" API Base URL. The default value points to sandbox. Production is 'https://api.mangopay.com'
debugMode false Active debugging
logClass function() {console.log(arguments)} Log function to be used for debug
connectionTimeout 30000 Set the connection timeout limit (in milliseconds)
responseTimeout 80000 Set the response timeout limit (in milliseconds)
apiVersion 'v2.01' API Version
errorHandler function(options, err) {console.error(options, err)} Set a custom error handler

Documentation

Github Full Node.js SDK Documentation is located in /docs folder. You can also access API References on our website.

License

MangopaySDK is distributed under MIT license, see the LICENSE file.

Contacts

Report bugs or suggest features using issue tracker on GitHub.

Account creation

You can get yourself a free sandbox account or sign up for a production account by registering on the Mangopay site (note that validation of your production account involves several steps, so think about doing it in advance of when you actually want to go live).

Creating a user

Using a hash of properties:

    mangopay.Users.create({
        "FirstName": "Victor",
        "LastName": "Hugo",
        "Address": "1 rue des Misérables, Paris",
        "Birthday": 1300186358,
        "Nationality": "FR",
        "CountryOfResidence": "FR",
        "Occupation": "Writer",
        "IncomeRange": "6",
        "ProofOfIdentity": null,
        "ProofOfAddress": null,
        "PersonType": "NATURAL",
        "Email": "victor@hugo.com",
        "Tag": "custom tag",
    }, function(model) {
        // User created - using callback
    }).then(function(model){
        // User created - using promise
    });

Using Mangopay SDK pre-defined models:

    var myUser = new api.models.UserLegal({
        Name: 'MangoPay',
        Email: 'info@mangopay.com',
        LegalPersonType: 'BUSINESS',
        LegalRepresentativeFirstName: 'Mango',
        LegalRepresentativeLastName: 'Pay',
        LegalRepresentativeEmail: 'mango@mangopay.com',
        HeadquartersAddress: new api.models.Address({
            AddressLine1: "4101 Reservoir Rd NW",
            AddressLine2: "",
            City: "Washington",
            Region: "District of Columbia",
            PostalCode: "20007",
            Country: "US"
        }),
        LegalRepresentativeBirthday: 1300186358,
        LegalRepresentativeNationality: 'FR',
        LegalRepresentativeCountryOfResidence: 'FR',
        CompanyNumber: 123456789,
        Tag: 'custom tag'
    });

    api.Users.create(myUser).then(function(){
        // Output the created user data to console
        console.log(myUser.Name + ' user created at ' + myUser.CreationDate);
    });

Promise vs Callback

Mangopay Node.js SDK supports both callback and promise approach. Here is how they can be implemented :

    api.Service.method(... , function(data, response, err){
        // Callback method
    })

    api.Service.method(...).then(function(data) {
        // Promise function called
    }, function(error) {
        //exception
    })

Pagination / Filtering

In order to paginate or filter results, we can use options.parameters to specify these options:

    api.Transactions.getAll({
        parameters: {
            // Pagination
            per_page: 2,
            page: 2,

            // Filters
            BeforeDate: 1414000367,
            AfterDate: 1414000367,
            Nature: REGULAR,
            Status: FAILED,
            Type: TRANSFER
        }
    }

Reading server response headers

For reading the server response headers we can use options.resolveWithFullResponse: true

    api.Users.getAll(null, {
      parameters: {
        per_page: 1
      },
      resolveWithFullResponse: true
    }).then(function(response){
      // Read pages count
      console.log(response.headers['x-number-of-pages']);

      // Read response body
      console.log(response.body);
    });

Sample usage of Mangopay SDK installed with npm in a Node.js project

Don't forget to check examples folder !

Contributing

npm start                       // installs dependencies and global mocha for testing and jsdox for documentation
npm test                        // runs the mocha tests
npm run-script documentation    // update documentation using jsdox, make sure to have it installed globally

Unit Tests

Mocha tests are placed under /test/ folder. To run the tests, make sure you have all dependencies installed. Check Contributing section for details.

changelog (log de mudanças)

[1.57.1] - 2025-06-17

Added

[1.57.0] - 2025-06-10

Added

Endpoints for new Reporting Service feature:

Webhook event types for new Reporting Service:

  • REPORT_GENERATED
  • REPORT_FAILED

Support for GET List Disputes for a PayIn endpoint.

[1.56.1] - 2025-06-06

Added

Fixed

  • Status enum value on Identity Verification object changed from OUTDATED to OUT_OF_DATE

[1.56.0] - 2025-05-23

Added

Event types for user account webhooks, relevant to SCA enrollment in user endpoints and account closure:

  • USER_ACCOUNT_VALIDATION_ASKED
  • USER_ACCOUNT_ACTIVATED
  • USER_ACCOUNT_CLOSED

Event types for instant and quoted FX conversions:

  • INSTANT_CONVERSION_CREATED
  • INSTANT_CONVERSION_SUCCEEDED
  • INSTANT_CONVERSION_FAILED
  • QUOTED_CONVERSION_CREATED
  • QUOTED_CONVERSION_SUCCEEDED
  • QUOTED_CONVERSION_FAILED

Support for 30-day deposit preauthorization features:

[1.55.1] - 2025-05-15

Fixed

  • File naming issue on Recipients service (thanks for raising @JordhanMadec 🙏)

[1.55.0] - 2025-05-14

Added and refined

Hosted KYC/KYB endpoints

The following endpoints have been refined following the beta phase, and are now generally available:

The previously available endpoint GET View Checks for an IDV Session has been removed (as Checks were integrated into the GET by ID).

See the guide for more details.

Recipients

The Country property has been added to Recipients, as a required query parameter on GET View the schema for a Recipient and as a required body parameter on POST Validate data for a Recipient and POST Create a Recipient.

Added

[1.54.0] - 2025-04-29

Added

SCA on wallet access endpoints

ScaContext query parameter added on wallet access endpoints for the introduction of SCA:

If SCA is required, Mangopay responds with a 401 response code. The PendingUserAction RedirectUrl is in the dedicated WWW-Authenticate response header.

See the tests for examples on handling this error.

BLIK with code

Support for BLIK with code endpoint

[1.53.1] - 2025-04-17

Fixed

  • Fixed the PaymentType enum for recurring payin registrations

[1.53.0] - 2025-04-16

Added

Recipients

SCA on Owner-initiated transfers

Endpoints to close a user account

[1.52.0] - 2025-04-16

Added

Fixed

  • Removed chai requirement from Users service - thanks for the MR @thierrymarianne

[1.51.1] - 2025-04-01

Changed

  • User-Agent Header value standardized on format: User-Agent: Mangopay-SDK/SDKVersion (Language/LanguageVersion)

Fixed

  • Fixed tests for categorize SCA users endpoint

    [1.51.0] - 2025-03-07

Added

New endpoints for strong customer authentication (SCA) on Owner users:

Added

New endpoint for Payconiq:

[1.50.1] - 2025-02-28

Added

Missing endpoint GET View card details for a Web Card PayIn

Fixed

Rate limiting headers interpreted dynamically based on X-RateLimit-Reset time and for a variable number of bucket values.

[1.50.0] - 2025-02-26

Added

Endpoints and webhooks for hosted KYC/B solution (in beta)

[1.49.1] - 2025-02-24

Added

New endpoint for the Pay by Bank PayIn object:

[1.49.0] - 2025-02-14

Added

New endpoint for the Swish PayIn object:

Added the List Transactions for a Card Fingerprint endpoint.

Updated

Improve retrieval of UBO declarations: get(userId, uboDeclarationId) is now deprecated. Please use getById(uboDeclarationId) to retrieve UBO declarations.

[1.48.4] - 2025-02-07

Updated

  • Improved Apple Pay to ensure full support in TypeScript.
  • Add StatementDescriptor parameter to the Refund object.

[1.48.3] - 2025-02-04

Updated

Revised tests to improve reliability and address any outdated tests.

[1.48.2] - 2025-01-30

Updated

[1.48.1] - 2024-12-17

Fixed

  • 426 Fixed typo mistake reports_wallets_create instead of reports_wallet_create. Thanks for your contribution @jilink

  • 428 Fixed tests and added missing BankWireExternalInstructionPayInData type.

[1.48.0] - 2024-12-17

Added

  • New PaymentRef parameter for Payouts

[1.47.1] - 2024-11-28

Updated

Added all relevant EVENT_TYPE_CHOICES for virtual accounts:

  • VIRTUAL_ACCOUNT_ACTIVE
  • VIRTUAL_ACCOUNT_BLOCKED
  • VIRTUAL_ACCOUNT_CLOSED
  • VIRTUAL_ACCOUNT_FAILED

[1.47.0] - 2024-10-25

Added

New endpoints for The Virtual Account object:

[1.46.2] - 2024-09-04

Fixed

  • Add additional refund reason types.

[1.46.1] - 2024-08-30

Fixed

  • Updated Axios to the latest version.

[1.46.0] - 2024-07-15

Added

[1.45.4] - 2024-05-24

Added

[1.45.3] - 2024-04-30

Fixed

[1.45.2] - 2024-04-16

Fixed

  • 400 & #401 Improve timeout error management

[1.45.1] - 2024-04-02

Added

[1.45.0] - 2024-04-02

Added

  • New endpoint Add tracking to Paypal payin
  • New parameters for Paypal mean of payment : CancelURL & Category (sub-parameter of LineItems). And management of PaypalPayerID, BuyerCountry, BuyerFirstname, BuyerLastname, BuyerPhone, PaypalOrderID in the response.

[1.44.0] - 2024-03-15

Fixed

  • Conversions endpoint spelling

  • 350 thanks @hostyn

Added

  • The optional Fees parameter is now available on instant conversions, allowing platforms to charge users for FX services. More information here.
  • Platforms can now use a quote to secure the rate for a conversion between two currencies for a set amount of time. More information here.
  • Introduced the ukHeaderFlag boolean configuration key. Platforms partnered with Mangopay's UK entity should set this key to true for proper configuration.

[1.43.1] - 2024-02-29

Fixed

  • Fix for #393 and #395 : Reject promise on API error and fix status type.

[1.43.0] - 2024-02-21

Added

  • New endpoint to look up metadata from BIN or Google Pay token. More information here
  • Get a card validation endpoint
  • Event types for Card Validation : "CARD_VALIDATION_CREATED", "CARD_VALIDATION_SUCCEEDED" and "CARD_VALIDATION_FAILED"

[1.42.1] - 2024-02-08

Fixed

We have upgraded our SDK to use Axios for API communication with Mangopay. This change ensures faster, more reliable, and secure interactions, aligning with our commitment to provide an efficient and robust user experience.

[1.42.0] - 2023-12-22

Added

New CardInfo parameter returned on card transactions. More information here.

[1.41.1] - 2023-12-18

Fixed

  • Typing for User
  • Comments #336

[1.41.0] - 2023-12-06

Added

The IDEAL legacy implementation has been enhanced. You can now pass the Bic, and if provided, the API response will include the BankName parameter. More information here.

Fixed

BankingAlias typings have been fixed to match the API behavior

[1.40.1] - 2023-11-09

Added

It's now possible to specify an amount for DebitedFunds and Fees when you create a refund with PayIns.createRefund()

[1.40.0] - 2023-11-02

Updated

  • Giropay and Ideal integrations with Mangopay have been improved. Some methods have been deprecated
  • Klarna param "MerchantOrderId" has been renamed to "Reference"

Fixed

  • An error occurred while creating a transaction report. It has been fixed.

Added

  • New Reference parameter for the new Paypal implementation.

[1.39.0] - 2023-09-29

Added

  • Instantly convert funds between 2 wallets of different currencies owned by the same user with the new SPOT FX endpoints

[1.38.0] - 2023-09-22

Added

Klarna is now available as a payment method with Mangopay. This payment method is in private beta. Please contact support if you have any questions.

[1.37.0] - 2023-09-15

Added

  • Multibanco, Satispay, Blik are now available as a payment method with Mangopay. This payment method is in private beta. Please contact support if you have any questions.
  • Card validation endpoint is now available (Private beta)
  • A new parameter for Paypal : ShippingPreference

Updated

  • Google Pay integration with Mangopay has been improved. This payment method is in private beta. Please contact support if you have any questions.

Fixed

  • MBWay & PayPal are now using Web Execution Type.

[1.36.0] - 2023-07-24

Added

Paypal integration with Mangopay has been improved. This payment method is in private beta. Please contact support if you have any questions.

[1.35.1] - 2023-07-07

Fixed

  • Phone parameter instead of PhoneNumber for MBWay

[1.35.0] - 2023-06-21

Added

  • MB WAY is now available as a payment method with Mangopay. This payment method is in private beta. Please contact support if you have any questions.

[1.34.0] - 2023-03-17

Added

Knowing when a dispute was closed is now possible thanks to the new ClosedDate parameter for the Dispute object.

The following endpoints have been updated accordingly:

Vew a Dispute

List Disputes for a User

List Disputes for a Wallet

List all Disputes

List Disputes that need settling

Please note that the new ClosedDate field will only display values for the Disputes closed after this release. Otherwise, a null value will be returned.

[1.33.1] - 2023-02-16

Fixed

  • Wrong return type in Disputes.getRepudiation() #339

[1.33.0] - 2023-01-12

Added

Verifying some specific legal structures is now more efficient thanks to a new legal entity type: PARTNERSHIP.

The Legal User LegalPersonType parameter now includes the PARTNERSHIP value. The following endpoints have been updated accordingly:

Create a Legal User (Payer)

Create a Legal User (Owner)

Update a Legal User

Please note that changing the LegalPersonType to PARTNERSHIP for an existing user will automatically result in:

  • A KYC downgrade to Light (default) verification
  • The REGISTRATION_PROOF document being flagged as OUT_OF_DATE.

With this new LegalPersonType, the MANGOPAY team can better handle specific legal structures and speed up the validation process.

[1.32.1] - 2022-12-15

Fixed

  • Fix type on property PayinsLinked

[1.32.0] - 2022-12-09

Added

New 30-day preauthorization feature

Preauthorizations can now hold funds for up to 30 days, therefore ensuring the solvency of a registered card for the same amount of time.

  • The Deposit service has been added with methods for creating, fetching and canceling a deposit
  • The Deposit model has been created
  • The createCardPreAuthorizedDepositPayIn method has been added to the PayIn service

Thanks to 30-day preauthorizations, MANGOPAY can provide a simpler and more flexible payment experience for a wide range of use cases, especially for rentals.

[1.31.1] - 2022-10-14

Fixed

  • Compiling fails in Typescript 4.8 #335
  • KYC's DocumentStatus missing value #333
  • Fixed untyped property for CountryAuthorization
  • Added missing UserId to UboDeclarationData

[1.31.0] - 2022-08-25

Added

New country authorizations endpoints

Country authorizations can now be viewed by using one of the following endpoints:

View a country's authorizations
View all countries' authorizations

With these calls, it is possible to check which countries have:

  • Blocked user creation
  • Blocked bank account creation
  • Blocked payout creation

Please refer to the Restrictions by country article for more information.

[1.30.1] - 2022-08-17

Fixed

  • Missing types for error catching. Fix issue #320
  • Missing types for BankAccount object. Fix issue #319
  • Missing type for CardPreAuthorizationData. Fix issue #311
  • OAuth token renewal bug fix

[1.30.0] - 2022-06-29

Added

Recurring: €0 deadlines for CIT

Setting free recurring payment deadlines is now possible for CIT (customer-initiated transactions) with the FreeCycles parameter.

The FreeCycles parameter allows platforms to define the number of consecutive deadlines that will be free. The following endpoints have been updated to take into account this new parameter:

Create a Recurring PayIn Registration
View a Recurring PayIn Registration

This feature provides new automation capabilities for platforms with offers such as “Get the first month free” or “free trial” subscriptions.

Please refer to the Recurring payments overview documentation for more information.

[1.29.2] - 2022-05-27

Fixed

  • User constructor issue

[1.29.1] - 2022-05-23

Fixed

  • missing UserCategory added to User Base classes

[1.29.0] - 2022-05-20

Added

Users can now be differentiated depending on their MANGOPAY usage.

This is possible with the new UserCategory parameter, whose value can be set to:

  • Payer – For users who are only using MANGOPAY to give money to other users (i.e., only pay).
  • Owner – For users who are using MANGOPAY to receive funds (and who are therefore required to accept MANGOPAY’s terms and conditions).

Please note that the following parameters become required as soon as the UserCategory is set to “Owner”:

  • HeadquartersAddress
  • CompanyNumber (if the LegalPersonType is “Business”)
  • TermsAndConditionsAccepted.

The documentation of user-related endpoints has been updated and reorganised to take into account the new parameter:

Differentiating the platform users results in a smoother user experience for “Payers” as they will have less declarative data to provide.

[1.28.0] - 2022-05-11

Added

Terms and conditions acceptance parameter
The acceptance of the MANGOPAY terms and conditions by the end user can now be registered via the SDK.

This information can be managed by using the new TermsAndConditionsAccepted parameter added to the User object.

The following API endpoints have been updated to take into account the new TermsAndConditionsAccepted parameter:

⚠️ Please note that:

  • Existing users have to be updated to include the terms and conditions acceptance information.
  • Once accepted, the terms and conditions cannot be revoked.

[1.27.0] - 2022-05-11

Added

  • When you create a KYC Document you can now add a Tag ( custom data ).

    Fixed

  • Issue #309 (Sort with column and direction using typescript)

[1.26.1] - 2022-04-21

Fixed

  • Typescript check for GitHub runner

[1.26.0] - 2022-04-01

Added

Instant payment eligibility check

With the function PayOuts.checkEligibility(payOut, callback, options) the destination bank reachability can now be verified prior to making an instant payout. This results in a better user experience, as this preliminary check will allow the platform to propose the instant payout option only to end users whose bank is eligible.

Instant payment mode only

Instant Payment requests can now be automatically cancelled when an issue is encountered (rather than falling back to the standard payout mode).

This is possible by using the new INSTANT_PAYMENT_ONLY option that has been added to the PayoutModeRequested parameter.

[1.25.2] - 2022-02-18

Fixed

  • Added Tag property in the CreateCardDirectPayIn interface.

[1.25.1] - 2022-02-02

Fixed

  • Typescript is now a dev dependency
  • Recurring Registration model is now exported (Thanks to @sengdaliu)
  • Added missing ID in UpdateUbo

[1.25.0] - 2021-12-09

Added

You can now view the rate limiting status in the NodeJS SDK. This test will show you all available properties in rateLimits : test/services/RateLimit.js.

Fixed

Export CurrencyISO and CountryISO

[1.24.1] - 2021-11-26

Fixed

Missing namespaces and exports

[1.24.0] - 2021-11-25

Added

Following numerous requests, we are happy to announce an update in the MANGOPAY Node.JS SDK. This update greatly improves the compatibility of the Node.JS SDK with Typescript.

Breaking Change

LegalRepresentativeAddress is mandatory to create a legal user

Other notable changes

  • The CardRegistrationId becomes mandatory to update a CardRegistration
  • The CreditedUserId becomes optional during the creation of a BANK_WIRE DIRECT PayIn
  • Addition of missing types of PayIn WEB DIRECT_DEBIT
  • Addition of ReportType (WALLET, TRANSACTION) to the object Report
  • Items moved to the “base” namespace: AuthorizationDate, Headers, ColumnAndDirection, Config, RequestOptions, PaginationOptions, FilterOptions, BrowserInfoData, FallbackReasonData
  • Items moved to the “securityInfo” namespace: AVSResult, SecurityInfoData
  • Items moved to the “cardPreauthorization” namespace: PreAuthorizationExecutionType, PaymentStatus, PreAuthorizationStatus
  • Items moved to the “billing” namespace: BillingData, BillingOrShippingRecurringPayInData
  • Items moved to the “money” namespace: MoneyData
  • Items moved to the “payIn” namespace: _3DSVersion
  • Items moved to the “enums” namespace: IPayInExecutionType, IPayInPaymentType, IMandateStatus, ILegalPersonType, IPersonType, IBankAccountType, IDeclaredUboStats, IKycDocumentStatus, IKycDocumentType, IPayOutPaymentType, IPlatformType, IUboDeclarationRefusedReasonType, IUboDeclarationStatus, IUboRefusedReasonType, IUserNaturalCapacity

[1.23.0] - 2021-10-20

Added

You can now change the status to "ENDED" for a recurring payment.

Fixed

  • "Status" is now available in the response when you request a recurring payment registration.

[1.22.1] - 2021-10-11

Added

We provide more information regarding refused KYC documents. Therefore it will be easier for you to adapt your app behavior and help your end user.

You are now able to see the exact explanation thanks to a new parameter called “Flags”.

It has been added to

api.KycDocuments.get(document.Id, function(data, response){});

It will display one or several error codes that provide the reason(s) why your document validation has failed. These error codes description are available here.

[1.21.0] - 2021-10-06

Added

As requested by numerous clients, we are now providing Payconiq as a new mean-of-payment. To request access, please contact MANGOPAY.

Fix

  • We have added missing types (IpAddress, BrowserInfo, DirectDebitDirectPayIn)
  • We have fixed the tests and increased timeout limits.

[1.20.2] - 2021-08-27

Fixed

  • Missing types for Recurring payments
  • Missing "NO_CHOICE" in secure mode
  • Missing "KYC_OUTDATED" in type
  • Bug fix UBO creation with BirthPlace

[1.20.1] - 2021-08-05

Fixed

  • Change FallbackReason parameter's type to object in PayOutPaymentDetailsBankWire

[1.20.0] - 2021-08-04

Fixed

  • We have added BrowserInfo for CreateCardDirectPayIn
  • We have fix a bug with DeactivateBankAccount (missing return data)

Added

  • You can now update and view a Recurring PayIn Registration object. To know more about this feature, please consult the documentation here.
  • To improve recurring payments, we have added new parameters for CIT : DebitedFunds & Fees. To know more about this feature, please consult the documentation here

[1.19.0] - 2021-06-10

Added

We have added a new feature recurring payments dedicated to clients needing to charge a card repeatedly, such as subscriptions or payments installments.

You can start testing in sandbox, to help you define your workflow. This release provides the first elements of the full feature.

This feature is not yet available in production and you need to contact the Support team to request access.

[1.18.0] - 2021-05-27

Added

Mangopay introduces the instant payment mode. It allows payouts (transfer from wallet to user bank account) to be processed within 25 seconds, rather than the 48 hours for a standard payout.

You can now use this new type of payout with the NodeJS SDK.

Example :

let payoutData = api.PayOuts.getBankwire(payOut.Id);
// where payOut.Id is the id of an existing payout

Please note that this feature must be authorized and activated by MANGOPAY. More information here.

[1.17.0] - 2021-05-11

Fixed

IBAN for testing purposes

⚠️ IBAN provided for testing purpose should never be used outside of a testing environement!

  • Fix BankAccount IBAN reference for tests

More information about how to test payments, click here.

BankingAlias

The SDK was calling the endpoint using a deprecated format. It has been fixed.

Added

New events for PreAuthorization

Some of you use a lot the PreAuthorization feature of our API. To make your life easier, we have added three new events :

  • PREAUTHORIZATION_CREATED
  • PREAUTHORIZATION_SUCCEEDED
  • PREAUTHORIZATION_FAILED

The goal is to help you monitor a PreAuthorization with a webhook.

Example: If a PreAuthorization is desynchronized, when the status is updated, you will be able to know it.

Models and services are preloaded from predefined lists

Thanks to @jgautheron, the SDK is now compatible with bundlers (Webpack, etc...) and avoid i/o at runtime.

[1.16.0] - 2021-03-25

Added

On demand feature for 3DSv2

This on-demand feature is for testing purposes only and will not be available in production

Request

We've added a new parameter Requested3DSVersion (not mandatory) that allows you to choose between versions of 3DS protocols (managed by the parameter SecureMode). Two values are available:

  • V1
  • V2_1

If nothing is sent, the flow will be 3DS V1.

The Requested3DSVersion may be included on all calls to the following endpoints:

  • /preauthorizations/card/direct
  • /payins/card/direct

Response

In the API response, the Requested3DSVersion will show the value you requested:

  • V1
  • V2_1
  • null – indicates that nothing was requested

The parameter Applied3DSVersion shows you the version of the 3DS protocol used. Two values are possible:

  • V1
  • V2_1

[1.15.0] - 2021-02-22

  • 3DS2 integration with Shipping and Billing objects, including FirstName and LastName fields
  • The objects Billing and Shipping may be included on all calls to the following endpoints:
    • /preauthorizations/card/direct
    • /payins/card/direct
    • /payins/card/web
  • Enable Instant Payment for payouts by adding a new parameter PayoutModeRequested on the following endpoint /payouts/bankwire
    • The new parameter PayoutModeRequested can take two different values : "INSTANT_PAYMENT" or "STANDARD" (STANDARD = the way we proceed normally a payout request)
    • This new parameter is not mandatory and if empty or not present, the payout will be "STANDARD" by default
    • Instant Payment is in beta all over Europe - SEPA region
  • Fix typo in README
  • Fix typo IpAdress -> IpAddress in PayInPaymentDetailsCardDirect
  • Fix Users update through a PUT request

[1.14.4] - 2020-12-09

  • Added 'Regulatory' endpoint to allow checks of User Block Status
  • Added support for Regulatory -> Blocked Status Hooks
  • Fix for SubmitKycDocument bug

[1.14.3] - 2020-10-30

  • added PaymentType to the CreatePayOut Object
  • added new endpoint for PreAuthorization Transactions
  • added methods for creating client bank accounts and payouts

[1.14.2]

  • New endpoint -> get UBO declaration by ID
  • RemainingFunds tests
  • Fixing of Typos, for Typescript compatibility
  • New endpoint to support changes to Card Validation process (please listen out for product announcements)

[1.13]

Added

USER_KYC_REGULAR has been added as a new Event. Thanks to it, you are now able to know when all the needed KYCs for a user have been validated and its KYCLevel is updated.

Fixed

  • Some issues on CardRegistration have been fixed
  • Pagination parameters use has been fixed and can now be used correctly

[1.12]

Added

  • GooglePay support has been added. This mean of payment will shortly be available (beta phase). Feel free to ask our Sales / Technical Account Manager team about it !
  • AccountNumber parameter has been added for Payins EXTERNAL_INSTRUCTION (as funds could be sent from a non-IBAN account to a wallet)
  • EXPIRED Status for Mandates has been added. Related EventType status MANDATE_EXPIRED has been added too.

Changed

  • PAYLINEV2 parameter has been added to TemplateURLOptions object, as PAYLINE parameter will be deprecated very soon.

Security

  • node-rest-client has been updated from 1.8.x version to 3.1.x version
  • Deprecated Buffer constructor has been replaced

[1.11] - 2019-10-18

Added

  • ApplePay Payin functions are now available. More info about activation to come in the following weeks...

    Changed

  • GET EMoney method now supports year and month parameters. More info on our docs

[1.10] - 2019-07-09

  • New UBO Declaration system (more info here)
  • CompanyNumber support for Legal Users