Multi API Version 2.13.17

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 cardPhysical 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. upgrade process

You can only upgrade virtual cardsVirtual Card A payment card that is created instantly and can be used for e-commerce and online purchases. Virtual cards are issued through the Mastercard network and are automatically enrolled in the 3D Secure program for increased security and limited fraud risk. They can be created in prepaid or debit mode. to 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. 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 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. 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 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. transaction.

API ChangeLog

What's New

---

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}/invites/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.

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}/invites/validate

What's Deprecated

---

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}/invites/{invite_id}/validate

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}/invites/{invite_id}/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.

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}/users/{user_id}/update

Return Type:

Changed response : 409 Conflict

Conflict

• Changed content type : application/json

  • Changed property errorCode (string)

    Added enum value:

    • ROOT_USER_ALREADY_VERIFIED

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}/invites/{invite_id}/validate

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}/invites/{invite_id}/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.

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

  New optional properties:

  • companyRegistrationNumber
  • name
  • registrationCountry

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

  New optional properties:

  • companyRegistrationNumber
  • name
  • registrationCountry

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

New optional properties:

• companyName
• companyRegistrationNumber
• registrationCountry

• Changed property companyName (string)

  The registered name of the company

• Changed property companyRegistrationNumber (string)

  The company registration number

• Changed property registrationCountry (string)

  The country of company registration - using ISO 3166 alpha-2

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  New optional properties:

  • companyRegistrationNumber
  • name
  • registrationCountry

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}/get

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Added property ipAddress (string)

    IP Address of the computer the Consumer has been created from.

  • Added property acceptedTerms (boolean)

    Whether the Consumer has accepted the terms and conditions.

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

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Added property ipAddress (string)

    IP Address of the computer the Consumer has been created from.

  • Added property acceptedTerms (boolean)

    Whether the Consumer has accepted the terms and conditions.

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./_/create

Request:

Changed content type : application/json

• Added property ipAddress (string)

  IP Address of the computer the Consumer has been created from.

• Added property acceptedTerms (object)

  Enum values:

  • TRUE
  • FALSE

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Added property ipAddress (string)

    IP Address of the computer the Consumer has been created from.

  • Added property acceptedTerms (boolean)

    Whether the Consumer has accepted the terms and conditions.

Changed response : 409 Conflict

Conflict

• Changed content type : application/json

  • Changed property errorCode (string)

    Added enum value:

    • TERMS_NOT_ACCEPTED

POST /managed_cards/{id}/physical/upgrade

Return Type:

Changed response : 409 Conflict

Conflict

• Changed content type : application/json

  • Changed property errorCode (string)

    Added enum value:

    • INSTRUMENT_BLOCKED

POST /managed_cards/{id}/physical/pin/set

Return Type:

Changed response : 409 Conflict

Conflict

• Changed content type : application/json

  • Changed property errorCode (string)

    Added enum value:

    • PHYSICAL_CARD_NOT_ACTIVATED

POST /managedcards//create

Return Type:

Changed response : 409 Conflict

Conflict

• Changed content type : application/json

  • Changed property errorCode (string)

    Added enum value:

    • OWNER_NOT_VERIFIED

POST /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

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Changed property transfer (array)

    Changed items (object):

    • Changed property conflict (string)

      Added enum values:

      • SOURCE_INSTRUMENT_BLOCKED

      • DESTINATION_INSTRUMENT_BLOCKED Removed enum value:

      • ACCOUNT_BLOCKED

POST /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

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Changed property conflict (string)

    Added enum values:

    • SOURCE_INSTRUMENT_BLOCKED

    • DESTINATION_INSTRUMENT_BLOCKED Removed enum value:

    • ACCOUNT_BLOCKED

POST /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

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Changed property conflict (string)

    Added enum values:

    • SOURCE_INSTRUMENT_BLOCKED

    • DESTINATION_INSTRUMENT_BLOCKED Removed enum value:

    • ACCOUNT_BLOCKED

  Changed response : 409 Conflict

  Conflict

• Changed content type : application/json

  • Changed property errorCode (string)

    Added enum values:

    • SOURCE_INSTRUMENT_BLOCKED

    • DESTINATION_INSTRUMENT_BLOCKED Removed enum value:

    • ACCOUNT_BLOCKED

POST /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./get

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Changed property send (array)

    Changed items (object):

    • Changed property conflict (string)

      Added enum value:

      • INSUFFICIENT_FUNDS

POST /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./{id}/get

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Changed property conflict (string)

    Added enum value:

    • INSUFFICIENT_FUNDS

POST /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./_/execute

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Changed property conflict (string)

    Added enum value:

    • INSUFFICIENT_FUNDS

  Changed response : 409 Conflict

  Conflict

• Changed content type : application/json

  • Changed property errorCode (string)

    Added enum value:

    • INSUFFICIENT_FUNDS

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

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Changed property transfer (array)

    Changed items (object):

    • Changed property destination (object)

      New required properties:

      • beneficiaryAddress
      • beneficiaryBankAddress
      • beneficiaryBankCountry
      • beneficiaryBankName

      • Changed property beneficiaryName (string)

        The name of the beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required.

      • Changed property beneficiaryAddress (string)

        The beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required. address

      • Changed property beneficiaryBankName (string)

        The name of the beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required. bank

      • Changed property beneficiaryBankAddress (string)

        The beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required. bank address

      • Changed property beneficiaryBankCountry (string)

        The beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required. bank country - using ISO 3166 alpha-2

      • Changed property sepa (object)

        New required properties:

        • bankIdentifierCode
        • iban

      • Changed property fasterPayments (object)

        New required properties:

        • accountNumber
        • sortCode

      • Changed property swift (object)

        New required properties:

        • iban
        • swift

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

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Changed property destination (object)

    New required properties:

    • beneficiaryAddress
    • beneficiaryBankAddress
    • beneficiaryBankCountry
    • beneficiaryBankName

    • Changed property beneficiaryName (string)

      The name of the beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required.

    • Changed property beneficiaryAddress (string)

      The beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required. address

    • Changed property beneficiaryBankName (string)

      The name of the beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required. bank

    • Changed property beneficiaryBankAddress (string)

      The beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required. bank address

    • Changed property beneficiaryBankCountry (string)

      The beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required. bank country - using ISO 3166 alpha-2

    • Changed property sepa (object)

      New required properties:

      • bankIdentifierCode
      • iban

    • Changed property fasterPayments (object)

      New required properties:

      • accountNumber
      • sortCode

    • Changed property swift (object)

      New required properties:

      • iban
      • swift

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

Request:

Changed content type : application/json

• Changed property description (string)

• Changed property destination (object)

  New required properties:

  • beneficiaryAddress
  • beneficiaryBankAddress
  • beneficiaryBankCountry
  • beneficiaryBankName

  • Changed property beneficiaryName (string)

    The name of the beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required.

  • Changed property beneficiaryAddress (string)

    The beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required. address

  • Changed property beneficiaryBankName (string)

    The name of the beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required. bank

  • Changed property beneficiaryBankAddress (string)

    The beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required. bank address

  • Changed property beneficiaryBankCountry (string)

    The beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required. bank country - using ISO 3166 alpha-2

  • Changed property sepa (object)

    New required properties:

    • bankIdentifierCode
    • iban

  • Changed property fasterPayments (object)

    New required properties:

    • accountNumber
    • sortCode

  • Changed property swift (object)

    New required properties:

    • iban
    • swift

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Changed property destination (object)

    New required properties:

    • beneficiaryAddress
    • beneficiaryBankAddress
    • beneficiaryBankCountry
    • beneficiaryBankName

    • Changed property beneficiaryName (string)

      The name of the beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required.

    • Changed property beneficiaryAddress (string)

      The beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required. address

    • Changed property beneficiaryBankName (string)

      The name of the beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required. bank

    • Changed property beneficiaryBankAddress (string)

      The beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required. bank address

    • Changed property beneficiaryBankCountry (string)

      The beneficiaryBeneficiary A trusted recipient for payments that includes both information about the business or individual as well as their bank account or instrument details. When using trusted beneficiaries, customers may be allowed to skip Strong Customer Authentication (SCA) when executing Outgoing Wire Transfer or Send transactions, reducing the number of approval steps required. bank country - using ISO 3166 alpha-2

    • Changed property sepa (object)

      New required properties:

      • bankIdentifierCode
      • iban

    • Changed property fasterPayments (object)

      New required properties:

      • accountNumber
      • sortCode

    • Changed property swift (object)

      New required properties:

      • iban
      • swift