Skip to main content

Multi API Version 2.13.22

· 4 min read
Maria Stellini

Updating the delivery address of a 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.​

We introduced the ability to update the delivery address of a managed cardManaged 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.. This feature is particularly useful if the user using a 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. 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 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 the delivery address is specified when updating a virtual cardVirtual 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., the API will return a 409 - Conflict error with error code INSTRUMENT_NOT_PHYSICAL.

New error codes when managing 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.​

You cannot activate, retrieve or update the pin of a blocked or destroyed 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.. 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​

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}/kybKYB Know Your Business - the identity verification process for corporate identities. This process allows you to seamlessly and securely verify your business customer's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers./start​
Return Type:​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • KYB_REJECTED
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 : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • EMAIL_NOT_UNIQUE
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}/kycKYC Know Your Customer - the identity verification process for consumer identities. This process allows you to seamlessly and securely verify your user's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers./start​
Return Type:​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • KYC_REJECTED
POST /managed_cards/{id}/update​
Request:​

Changed content type : application/json

  • Added property deliveryAddress (object)

    • Property addressLine1 (string)

      Address of the identity

    • Property addressLine2 (string)

      Continued address of the identity

    • Property city (string)

      City of the identity

    • Property country (string)

      Country of the identity - using ISO 3166 alpha-2

    • Property postCode (string)

      Post code of the identity

    • Property state (string)

      State of the identity

    • Property name (string)

      The first name of the addressee

    • Property surname (string)

      The last name of the addressee

Return Type:​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INSTRUMENT_NOT_PHYSICAL
POST /managed_cards/{id}/physical/replace_lost_stolen​
Return Type:​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Removed enum value:

      • PHYSICAL_CARD_NOT_ACTIVATED
POST /managed_cards/{id}/physical/report_lost​
Return Type:​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Removed enum value:

      • PHYSICAL_CARD_NOT_ACTIVATED
POST /managed_cards/{id}/physical/activate​
Return Type:​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum values:

      • INSTRUMENT_BLOCKED
      • INSTRUMENT_DESTROYED
POST /managed_cards/{id}/physical/upgrade​
Request:​

Changed content type : application/json

  • Changed property deliveryMethod (string)

    The preferred method of delivery for this 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.. If unspecified, standard delivery would be the default delivery method.

    Added enum value:

    • FIRST_CLASS_MAIL
POST /managed_cards/{id}/physical/pin/get​
Return Type:​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum values:

      • INSTRUMENT_BLOCKED
      • INSTRUMENT_DESTROYED
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 values:

      • INSTRUMENT_BLOCKED
      • INSTRUMENT_DESTROYED
POST /managed_cards/{id}/physical/pin/unblock​
Return Type:​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum values:

      • INSTRUMENT_BLOCKED
      • INSTRUMENT_DESTROYED
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 value:

      • TRANSFER_BETWEEN_INSTRUMENTS_UNSUPPORTED Removed enum value:

      • CROSS_PROVIDER_TRANSFER_UNSUPPORTED

    Changed response : 409 Conflict

    Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • TRANSFER_BETWEEN_INSTRUMENTS_UNSUPPORTED Removed enum value:

      • CROSS_PROVIDER_TRANSFER_UNSUPPORTED

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 values:

      • SEND_TO_INSTRUMENT_UNSUPPORTED

      • SOURCE_INSTRUMENT_BLOCKED

      • DESTINATION_INSTRUMENT_BLOCKED Removed enum values:

      • ACCOUNT_BLOCKED

      • CROSS_PROVIDER_SEND_UNSUPPORTED

    Changed response : 409 Conflict

    Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum values:

      • SEND_TO_INSTRUMENT_UNSUPPORTED

      • SOURCE_INSTRUMENT_BLOCKED

      • DESTINATION_INSTRUMENT_BLOCKED Removed enum values:

      • ACCOUNT_BLOCKED

      • CROSS_PROVIDER_SEND_UNSUPPORTED