Documentation

Documentation

  • Guide
  • API Reference
  • Changelog

›Recent Posts

Recent Posts

  • Version 2.13.27
  • Version 2.13.25
  • Version 2.13.24
  • Version 2.13.22
  • Version 2.13.17

Version 2.13.27

February 22, 2021

Maria Stellini

Re-introducing mandatory corporate details

When creating a corporate you will be required to specify the following fields:

  • companyName
  • companyRegistrationNumber
  • registrationCountry

API ChangeLog

Read More

Version 2.13.25

February 16, 2021

Maria Stellini

Removing due diligence deprecated fields possibly breaking

In previous releases, a number of fields where made deprecated as they where being replaced with other fields which provide additional information on the due diligence of your corporate and consumer customers.

For Corporate KYB the following fields have now been removed: verifications, kyb.allowedLimit and kyb.remainingLimit. The affected APIs are:

  • POST /corporates/{id}/get
  • POST /corporates/{id}/update
  • POST /corporates/_/create
  • POST /corporates/{id}/kyb/get

For Consumers KYC the following fields have now been removed kyc.pep, kyc.sanctioned, kyc.enhancedDueDiligence, kyc.allowedLimit, kyc.remainingLimit.The affected APIs are:

  • POST /consumers/{id}/get
  • POST /consumers/{id}/update
  • POST /consumers/_/create
  • POST /consumers/{id}/kyc/get

Deprecating due diligence fields non-breaking

We are simplifying further the due diligence information returned to you via the API. This helps you in understanding the status of the KYC or KYB for consumers or corporates respectively.

For Corporates the kyb.enhancedCompanyChecksVerified field has been deprecated. We recommend that you use the kyb.fullCompanyChecksVerified field to get the due diligence status of your corporate.

For Consumers the kyc.fullDueDiligenceAddressMatched field has been deprecated. We recommend that you use the kyc.fullDueDiligence field to get the due diligence status of your consumer.

API ChangeLog

Read More

Version 2.13.24

February 11, 2021

Maria Stellini

Additional validation for the call-ref parameter

When calling any of the APIs offered by Weavr, you can optionally specify a value for the call-ref parameter. If we receive 2 API requests with the same call-ref value, the request will only be executed once. This avoids executing requests multiple times by mistake.

The call-ref parameter has been restricted to a maximum of 255 characters. If a longer call-ref is provided an error 400 - Bad Request will be returned.

API ChangeLog

Read More

Version 2.13.22

February 3, 2021

Maria Stellini

Updating the delivery address of a physical card

We introduced the ability to update the delivery address of a managed card. This feature is particularly useful if the user using a physical card has moved to a different address and you want to make sure that they receive their card at the right address.

You can only update the delivery address for physical cards. If the delivery address is specified when updating a virtual card, the API will return a 409 - Conflict error with error code INSTRUMENT_NOT_PHYSICAL.

New error codes when managing physical cards

You cannot activate, retrieve or update the pin of a blocked or destroyed physical card. When executing the following APIs on a blocked or destroyed card, the API will return a 409 - Conflict error with error code INSTRUMENT_BLOCKED or INSTRUMENT_DESTROYED:

  • POST /managed_cards/{id}/physical/activate/
  • POST /managed_cards/{id}/physical/pin/unblock
  • POST /managed_cards/{id}/physical/pin/get
  • POST /managed_cards/{id}/physical/pin/set

New error code when updating the details of a consumer

A new error code EMAIL_NOT_UNIQUE has been added to the POST /consumers/{id}/update API. This error code will be returned if the new email address being specified is already being used by another consumer in your community.

API ChangeLog

Read More

Version 2.13.17

January 26, 2021

Maria Stellini

Re-branding our build environment

You may have already noticed changes in the documentation and in our communication, we are renaming our build environment to sandbox. The re-branded sandbox environment will have the same features and capabilities we already offer in the build environment.

Update to the physical card upgrade process

You can only upgrade virtual cards to physical cards if their state is ACTIVE. If the card being upgraded is currently BLOCKED the POST /managed_cards/{id}/physical/upgrade API call will return a 409 - Conflict error with error code INSTRUMENT_BLOCKED.

More descriptive error codes for the transfer transaction

We have introduced 2 new error codes SOURCE_INSTRUMENT_BLOCKED and DESTINATION_INSTRUMENT_BLOCKED that replace the current error code ACCOUNT_BLOCKED. With these new error codes you can provide more informative messages to your customers and give better options on how to perform the transfer transaction.

API ChangeLog

Read More

Version 2.13.13

January 18, 2021

Maria Stellini

More flexible physical card PINs

You can now show and update physical card PINs as soon as a virtual card is upgraded to a physical card. Previously cards had to be activated first.

New Webhook notifications

We have added a new webhook so that you are notified when there are updates on the KYC status of a corporate's director or beneficiary.

Updates to the Transfer transaction

We are enhancing our APIs so that we can support a broader set of providers and use-cases. In some use-cases, the Transfer transaction may not be executed instantly so the transfer transaction's status will be shown as PENDING. You can check the status of the transaction by calling the transfers/get or transfers\{id}\get APIs.

API ChangeLog

Read More

Version 2.13.12

January 6, 2021

Maria Stellini

What's New

  • Passwords: A new API endpoint is being introduced to trigger the password expiry for a user. When this API is called, the latest version of the user's password will be expired.
    • POST /passwords/{credential_id}/expire
Read More

Version 2.13.11

January 5, 2021

Maria Stellini

What's Changed

  • Physical cards can be assigned a custom delivery name and surname which when provided will replace the identity's business name on the postage address when delivering the physical card. This is particularly useful when you want to deliver a physical to a corporate user rather than the business.
    • POST /managed_cards/{id}/physical/upgrade
    • POST /managed_cards/get
    • POST /managed_cards/{id}/unfreeze
    • POST /managed_cards/{id}/physical/report_stolen
    • POST /managed_cards/{id}/physical/replace_damaged
    • POST /managed_cards/{id}/physical/report_lost
    • POST /managed_cards/{id}/physical/replace_lost_stolen
    • POST /managed_cards/{id}/physical/activate
    • POST /managed_cards/_/assign
    • POST /managed_cards/{id}/remove
    • POST /managed_cards/{id}/get
    • POST /managed_cards/{id}/update
    • POST /managed_cards/_/create
    • POST /managed_cards/{id}/freeze
Read More

Version 2.13.3

December 17, 2020

Maria Stellini

What's Changed

  • The hasPending request parameter has been removed for both the managed_account and managed_card resources.
    • POST /managed_accounts/get
    • POST /managed_cards/get
Read More

Version 2.13.0

December 11, 2020

Maria Stellini

What's New

Initiating Outgoing Wire Transfers

A new financial service that supports incoming and outgoing wire transfers has been introduced to the Weavr Platform. This service enables consumers and corporates to receive and send funds, from and to third parties as well as their own bank accounts. The capabilities associated with this service are represented under the new outgoing_wire_transfers resource.

The API to get the bank details associated with a Managed Account has not changed, however the details returned might change so as to allow for 3rd party deposits. To submit an outgoing wire transfer, a new API ​/outgoing_wire_transfers​/_​/execute has been added that enables corporates and consumers to send funds from a Managed Account to an external bank account.

  • POST /outgoing_wire_transfers/_/execute

Once, an outgoing wire transfer is submitted, the status and details of the transfer can be retrieved via the API.

  • POST /outgoing_wire_transfers/get
  • POST /outgoing_wire_transfers/{id}/get

What's Changed

Managed Accounts

  • Withdrawal: The withdrawal APIs under the managed_accounts resource have been removed, however the capability is still supported (if permitted by the service provider). To submit a withdrawal from a managed account, the new ​/outgoing_wire_transfers​/_​/execute should be used.

    • POST /managed_accounts/withdraw/get
    • POST /managed_accounts/{id}/withdraw/{withdraw_id}/cancel
    • POST /managed_accounts/{id}/withdraw/{withdraw_id}/get
    • POST /managed_accounts/{id}/withdraw/_/create
    • POST ​/managed_accounts​/{id}​/withdraw​/get
  • Creating an Account: Four new error codes (IDENTITY_LIMITS_EXCEEDED, PROGRAMME_LIMITS_EXCEEDED, INNOVATOR_LIMITS_EXCEEDED, SYSTEM_LIMITS_EXCEEDED) were introduced and may be returned when creating an instrument.

    • POST /managed_accounts/_/create
  • Un/Freezing an Account: A new error message INSTRUMENT_INACTIVE has been added and will be returned if the instrument being frozen/unfrozen hasn't been created yet.

    • POST /managed_accounts/{id}/freeze
    • POST /managed_accounts/{id}/unfreeze

Managed Cards

  • Physical Cards: The activationCode does not need to be unique anymore. Multiple physical cards can have the same activation code.

    • POST /managed_cards/{id}/physical/replace_damaged
    • POST /managed_cards/{id}/physical/replace_lost_stolen
    • POST /managed_cards/{id}/physical/activate
    • POST /managed_cards/{id}/physical/upgrade
  • Creating a Card: Four new error codes (IDENTITY_LIMITS_EXCEEDED, PROGRAMME_LIMITS_EXCEEDED, INNOVATOR_LIMITS_EXCEEDED, SYSTEM_LIMITS_EXCEEDED) were introduced and can be returned when creating an instrument.

    • POST /managed_cards/_/create
  • New Auth Rule: A new auth rule has been introduced which when configured can block any credit type authorisations. Credit authorisations translate in the cardholder receiving funds on a card.

    • POST /managed_cards/{id}/auth_rule/get
    • POST /managed_cards/{id}/auth_rule/set
  • Removing a Managed Account: A new error code INSTRUMENT_HAS_PENDING_ACTIONS has been added and can be returned if the instrument being deleted still has pending actions.

    • POST /managed_cards/{id}/remove

Corporates

  • The ipAddress property has been updated so that is supports IPv6 IP addresses, it's length has increased from 15 characters to 45 characters.

    • POST /corporates/{id}/get
    • POST /corporates/{id}/update
    • POST /corporates/_/create
  • Charging a Fee: A new error code IDENTITY_NOT_OWNER_OF_INSTRUMENT has been added to the /corporates/{id}/charge_fee API. The error code will be returned if the identity owning the source instrument from where the fee is to be taken, does not match the identity currently logged in.

    • POST /corporates/{id}/charge_fee
  • Updating a Corporate: It is now possible to update the baseCurrency of a corporate.

    • POST /corporate/{id}/update
  • Activating/Deactivating a User: The response code 409 was removed from the possible response types.

    • POST /corporates/{id}/users/{user_id}/activate
    • POST /corporates/{id}/users/{user_id}/deactivate

Consumers

  • Charging a Fee: A new error code IDENTITY_NOT_OWNER_OF_INSTRUMENT has been added to the /consumers/{id}/charge_fee API. The error code will be returned if the identity owning the source instrument from where the fee is to be taken, does not match the identity currently logged in.

    • POST /consumers/{id}/charge_fee
  • Updating a Consumer: It is now possible to update the baseCurrency of a consumer.

    • POST /consumers/{id}/update
Read More
Next →
Copyright © 2021 Paystratus Group Ltd.