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 /outgoingwire_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 /managedaccounts/{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 /managedaccounts//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 any more. 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 /managedcards//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

What's Changed​

• Corporates and Consumer Due Diligence Limits: Multiple limits may start to apply to a particular Corporate. For this reason, the current allowedLimit object and remainingLimit object which support only 1 limit have been deprecated in favour of 2 new objects allowedLimits and remainingLimits which support an array of limits. The old objects allowedLimit and remainingLimit will continue to return the most restrictive limit from the set.

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

• Managed Accounts: Two new properties accountNumber and sortCode have been added to the bank details associated with a Managed Account.

  • POST /managed_accounts/get
  • POST /managed_accounts/{id}/unfreeze
  • POST /managed_accounts/{id}/remove
  • POST /managed_accounts/{id}/get
  • POST /managed_accounts/{id}/update
  • POST /managedaccounts//create
  • POST /managed_accounts/{id}/freeze

What's Changed​

• Corporates: Two new objects registrationAddress and a businessAddress have been added to the corporate's information. The registrationAddress refers to the address submitted to the state's registry (example CompaniesHouse in the UK), while the businessAddress refers to the address where the business is currently operating.

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

• Corporates: The companyRegistrationAddress and a companyBusinessAddress have been marked as deprecated as they will be replaced by the new address objects registrationAddress and a businessAddress.

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

• Corporates: The MANUFACTURINGPR_MARKETING property within the industry enum has been split up into 2 properties MANUFACTURING and PR_MARKETING.

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

What's Changed​

• Physical cards: A new API endpoint is being introduced from which a physical card can be replaced due to it having been lost or stolen.

  • POST /managed_cards/{id}/physical/replace_lost_stolen

• Spend Controls: A new control allowCashback is being introduced which when configured as FALSE would deny cashback transactions on physical cards

  • POST /managed_cards/{id}/auth_rule/get
  • POST /managed_cards/{id}/auth_rule/set

• Managed Cards: A new externalHandle property has been added to the card property. This is a uniquely generated code which will be provided as part of the card object when creating a card. The externalHandle can also be used when searching for a card.

  • POST /managed_cards/get
  • POST /managed_cards/{id}/unfreeze
  • POST /managed_cards/{id}/physical/report_lost
  • POST /managed_cards/{id}/physical/report_stolen
  • POST /managed_cards/{id}/physical/replace_damaged
  • POST /managed_cards/{id}/physical/activate
  • POST /managed_cards/{id}/physical/upgrade
  • POST /managed_cards/{id}/remove
  • POST /managed_cards/{id}/get
  • POST /managed_cards/{id}/update
  • POST /managedcards//create
  • POST /managed_cards/{id}/freeze

What's Changed​

• When KYC cannot start, instead of always returning KYC_UNAVAILABLE as the errorCode, either KYC_APPROVED or KYC_PENDING will be returned, providing more context as to why KYC cannot start.

  • POST /consumers/{id}/kyc/start

• Added a new conflict reason DESTINATION_LIMIT_EXCEEDED for the transfer and send resources. This conflict reason will be used in case the transaction failed because the destination instrument exceeded a limit

  • POST /transfers/get
  • POST /transfers/{id}/get
  • POST /transfers/_/execute
  • POST /send/get
  • POST /send/{id}/get
  • POST /send/_/execute