Skip to main content

Multi API Version 2.13.0

· 5 min read
Maria Stellini

What's New​

Initiating Outgoing Wire TransfersWire Transfer A transaction that moves funds between accounts. An incoming wire transfer moves funds from a third-party bank account to a Weavr managed account, while an outgoing wire transfer moves funds from a Weavr managed account to a third-party bank account. Wire transfers require the managed account to have an assigned IBAN (for EUR) or sort code and account number (for GBP).

A new financial service that supports incoming and outgoing wire transfersWire Transfer A transaction that moves funds between accounts. An incoming wire transfer moves funds from a third-party bank account to a Weavr managed account, while an outgoing wire transfer moves funds from a Weavr managed account to a third-party bank account. Wire transfers require the managed account to have an assigned IBAN (for EUR) or sort code and account number (for GBP). has been introduced to the Weavr Platform. This service enables consumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person. and corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees. to receive and sendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. 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 AccountManaged Account An account held at a financial institution that can be created and managed through the Weavr platform. Each account has a balance where customers can hold funds. Optionally, an IBAN can be assigned to enable wire transfers to bank accounts outside of Weavr. has not changed, however the details returned might change so as to allow for 3rd party deposits. To submit an outgoing wire transferWire Transfer A transaction that moves funds between accounts. An incoming wire transfer moves funds from a third-party bank account to a Weavr managed account, while an outgoing wire transfer moves funds from a Weavr managed account to a third-party bank account. Wire transfers require the managed account to have an assigned IBAN (for EUR) or sort code and account number (for GBP)., a new API ​/outgoing_wire_transfers​/_​/execute has been added that enables corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees. and consumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person. to sendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. funds from a Managed AccountManaged Account An account held at a financial institution that can be created and managed through the Weavr platform. Each account has a balance where customers can hold funds. Optionally, an IBAN can be assigned to enable wire transfers to bank accounts outside of Weavr. to an external bank account.

  • POST /outgoingwire_transfersTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations.//execute

Once, an outgoing wire transferWire Transfer A transaction that moves funds between accounts. An incoming wire transfer moves funds from a third-party bank account to a Weavr managed account, while an outgoing wire transfer moves funds from a Weavr managed account to a third-party bank account. Wire transfers require the managed account to have an assigned IBAN (for EUR) or sort code and account number (for GBP). is submitted, the status and details of the transferTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations. can be retrieved via the API.

  • POST /outgoing_wire_transfersTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations./get
  • POST /outgoing_wire_transfersTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations./{id}/get

What's Changed​

Managed AccountsManaged Account An account held at a financial institution that can be created and managed through the Weavr platform. Each account has a balance where customers can hold funds. Optionally, an IBAN can be assigned to enable wire transfers to bank accounts outside of Weavr.

  • 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 accountManaged Account An account held at a financial institution that can be created and managed through the Weavr platform. Each account has a balance where customers can hold funds. Optionally, an IBAN can be assigned to enable wire transfers to bank accounts outside of Weavr., 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 CardsManaged Card A payment card (virtual or physical) that can be created and managed through the Weavr platform. Cards can operate in prepaid mode (with their own balance) or debit mode (linked to a managed account). All cards must be assigned to a card assignee who is an Authorised User.

  • Physical CardsPhysical Card A payment card that is printed or embedded in wearables and sent to customers directly. Physical cards are created by first creating a virtual card and then upgrading it to a physical card. They are sent in an inactive state and must be activated by the card assignee before first use.: The activationCode does not need to be unique any more. Multiple physical cardsPhysical Card A payment card that is printed or embedded in wearables and sent to customers directly. Physical cards are created by first creating a virtual card and then upgrading it to a physical card. They are sent in an inactive state and must be activated by the card assignee before first use. 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 AccountManaged Account An account held at a financial institution that can be created and managed through the Weavr platform. Each account has a balance where customers can hold funds. Optionally, an IBAN can be assigned to enable wire transfers to bank accounts outside of Weavr.: 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

CorporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees.

  • 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 /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/get
    • POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/update
    • POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./_/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 /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{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 /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/users/{user_id}/activate
    • POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/users/{user_id}/deactivate

ConsumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person.

  • 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 /consumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person./{id}/charge_fee

  • Updating a Consumer: It is now possible to update the baseCurrency of a consumer.

    • POST /consumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person./{id}/update

What's New​

POST /managedcards//assign​
POST ​/outgoing_wire_transfersTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations.​/get​
POST ​​/outgoing_wire_transfersTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations.​/{id}​/get​
POST /outgoingwire_transfersTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations.//execute​

What's Changed​

POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/charge_fee​
Return Type​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • IDENTITY_NOT_OWNER_OF_INSTRUMENT
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/users/mobile/send_verification_code​
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/get​
Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property ipAddress (string) > The IP address of the root userRoot user The individual who creates the identity. For corporate identities, the root user needs to be a legal representative of the corporate such as a director or a representative who has the power of attorney over the company. For consumer identities, the root user is the owner of the identity. Every identity must always have one root user. who did the registration
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/update​
Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property ipAddress (string) > The IP address of the root userRoot user The individual who creates the identity. For corporate identities, the root user needs to be a legal representative of the corporate such as a director or a representative who has the power of attorney over the company. For consumer identities, the root user is the owner of the identity. Every identity must always have one root user. who did the registration
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./_/create​
Request​

Changed content type : application/json

  • Changed property ipAddress (string)

    The IP address of the root userRoot user The individual who creates the identity. For corporate identities, the root user needs to be a legal representative of the corporate such as a director or a representative who has the power of attorney over the company. For consumer identities, the root user is the owner of the identity. Every identity must always have one root user. doing the registration

Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property ipAddress (string) > The IP address of the root userRoot user The individual who creates the identity. For corporate identities, the root user needs to be a legal representative of the corporate such as a director or a representative who has the power of attorney over the company. For consumer identities, the root user is the owner of the identity. Every identity must always have one root user. who did the registration
POST /consumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person./{id}/mobile/send_verification_code​
POST /consumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person./{id}/charge_fee​
Return Type​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • IDENTITY_NOT_OWNER_OF_INSTRUMENT
POST /managed_cards/{id}/physical/replace_damaged​
Request​

Changed content type : application/json

  • Changed property activationCode (string)

    An identifier that allows for instrument activation

POST /managed_cards/{id}/physical/replace_lost_stolen​
Request​

Changed content type : application/json

  • Changed property activationCode (string)

    An identifier that allows for instrument activation

POST /managed_cards/{id}/physical/activate​
Request​

Changed content type : application/json

  • Changed property activationCode (string)

    An identifier that allows for instrument activation

POST /managed_cards/{id}/physical/upgrade​
Request​

Changed content type : application/json

  • Changed property activationCode (string)

    An identifier that allows for instrument activation