Multi API Version 2.11.1

What's Changed

• 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.: With this release we are introducing support to 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.. 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 be either traditional plastic cards, but also wearables.

  • POST /managed_cards/{id}/physical/upgrade
  • 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
  • POST /managed_cards/{id}/physical/report_lost
  • POST /managed_cards/{id}/physical/report_stolen
  • POST /managed_cards/{id}/physical/replace_damaged

• Spend Control: This release also introduces the ability to configure purchase authorisation rules at both application level (from Settings area), as well as individual card level (via APIs).

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

---

What's New

POST /managed_cards/{id}/physical/report_stolen

POST /managed_cards/{id}/physical/replace_damaged

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

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

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

POST /managed_cards/{id}/physical/report_lost

POST /managed_cards/{id}/physical/activate

POST /managed_cards/{id}/physical/upgrade

POST /managed_cards/{id}/auth_rule/get

POST /managed_cards/{id}/auth_rule/set

POST /managed_cards/{id}/auth_rule/unset

What's Changed

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

    • DOB_MISSING
    • ADDRESS_MISSING

POST /managed_cards/get

Request:

Changed content type : application/json

• Changed property type (string)

  Added enum value:

  • PHYSICAL

  Removed enum value:

  • PLASTIC

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Changed property card (array)

    Changed items (object):

    • Added property physicalCardDetails (object)

      • Property cardBureau (string)

      • Property productReference (string)

      • Property carrierType (string)

      • Property physicalState (object)

        Enum values:

        • PENDING_ACTIVATION
        • ACTIVE
        • LOST
        • STOLEN
        • DAMAGED
        • EXPIRED
        • PIN_BLOCKED

      • Property physicalActivationState (object)

        Enum values:

        • CONVERTED_ACTIVATION_PENDING
        • CONVERTED_ACTIVE
        • REGENERATED_ACTIVATION_PENDING
        • REGENERATED_ACTIVE
        • RENEWED_ACTIVATION_PENDING
        • RENEWED_ACTIVE

      • Property replacementId (integer)

      • Property replacementType (string)

        Enum values:

        • DAMAGED
        • LOST_STOLEN
        • RENEW

    • 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

    • Changed property type (string)

      Added enum value:

      • PHYSICAL Removed enum value:

      • PLASTIC

POST /managed_cards/{id}/unfreeze

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Added property physicalCardDetails (object)

    • Property cardBureau (string)

    • Property productReference (string)

    • Property carrierType (string)

    • Property physicalState (object)

      Enum values:

      • PENDING_ACTIVATION
      • ACTIVE
      • LOST
      • STOLEN
      • DAMAGED
      • EXPIRED
      • PIN_BLOCKED

    • Property physicalActivationState (object)

      Enum values:

      • CONVERTED_ACTIVATION_PENDING
      • CONVERTED_ACTIVE
      • REGENERATED_ACTIVATION_PENDING
      • REGENERATED_ACTIVE
      • RENEWED_ACTIVATION_PENDING
      • RENEWED_ACTIVE

    • Property replacementId (integer)

    • Property replacementType (string)

      Enum values:

      • DAMAGED
      • LOST_STOLEN
      • RENEW

  • 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

  • Changed property type (string)

    Added enum value:

    • PHYSICAL Removed enum value:

    • PLASTIC

  Changed response : 409 Conflict

  Conflict

• Changed content type : application/json

  • Changed property errorCode (string)

    Added enum value:

    • INSTRUMENT_MARKED_LOST_STOLEN

POST /managed_cards/{id}/remove

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Added property physicalCardDetails (object)

    • Property cardBureau (string)

    • Property productReference (string)

    • Property carrierType (string)

    • Property physicalState (object)

      Enum values:

      • PENDING_ACTIVATION
      • ACTIVE
      • LOST
      • STOLEN
      • DAMAGED
      • EXPIRED
      • PIN_BLOCKED

    • Property physicalActivationState (object)

      Enum values:

      • CONVERTED_ACTIVATION_PENDING
      • CONVERTED_ACTIVE
      • REGENERATED_ACTIVATION_PENDING
      • REGENERATED_ACTIVE
      • RENEWED_ACTIVATION_PENDING
      • RENEWED_ACTIVE

    • Property replacementId (integer)

    • Property replacementType (string)

      Enum values:

      • DAMAGED
      • LOST_STOLEN
      • RENEW

  • 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

  • Changed property type (string)

    Added enum value:

    • PHYSICAL Removed enum value:

    • PLASTIC

POST /managed_cards/{id}/get

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Added property physicalCardDetails (object)

    • Property cardBureau (string)

    • Property productReference (string)

    • Property carrierType (string)

    • Property physicalState (object)

      Enum values:

      • PENDING_ACTIVATION
      • ACTIVE
      • LOST
      • STOLEN
      • DAMAGED
      • EXPIRED
      • PIN_BLOCKED

    • Property physicalActivationState (object)

      Enum values:

      • CONVERTED_ACTIVATION_PENDING
      • CONVERTED_ACTIVE
      • REGENERATED_ACTIVATION_PENDING
      • REGENERATED_ACTIVE
      • RENEWED_ACTIVATION_PENDING
      • RENEWED_ACTIVE

    • Property replacementId (integer)

    • Property replacementType (string)

      Enum values:

      • DAMAGED
      • LOST_STOLEN
      • RENEW

  • 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

  • Changed property type (string)

    Added enum value:

    • PHYSICAL Removed enum value:

    • PLASTIC

POST /managed_cards/{id}/update

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Added property physicalCardDetails (object)

    • Property cardBureau (string)

    • Property productReference (string)

    • Property carrierType (string)

    • Property physicalState (object)

      Enum values:

      • PENDING_ACTIVATION
      • ACTIVE
      • LOST
      • STOLEN
      • DAMAGED
      • EXPIRED
      • PIN_BLOCKED

    • Property physicalActivationState (object)

      Enum values:

      • CONVERTED_ACTIVATION_PENDING
      • CONVERTED_ACTIVE
      • REGENERATED_ACTIVATION_PENDING
      • REGENERATED_ACTIVE
      • RENEWED_ACTIVATION_PENDING
      • RENEWED_ACTIVE

    • Property replacementId (integer)

    • Property replacementType (string)

      Enum values:

      • DAMAGED
      • LOST_STOLEN
      • RENEW

  • 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

  • Changed property type (string)

    Added enum value:

    • PHYSICAL Removed enum value:

    • PLASTIC

POST /managedcards//create

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Added property physicalCardDetails (object)

    • Property cardBureau (string)

    • Property productReference (string)

    • Property carrierType (string)

    • Property physicalState (object)

      Enum values:

      • PENDING_ACTIVATION
      • ACTIVE
      • LOST
      • STOLEN
      • DAMAGED
      • EXPIRED
      • PIN_BLOCKED

    • Property physicalActivationState (object)

      Enum values:

      • CONVERTED_ACTIVATION_PENDING
      • CONVERTED_ACTIVE
      • REGENERATED_ACTIVATION_PENDING
      • REGENERATED_ACTIVE
      • RENEWED_ACTIVATION_PENDING
      • RENEWED_ACTIVE

    • Property replacementId (integer)

    • Property replacementType (string)

      Enum values:

      • DAMAGED
      • LOST_STOLEN
      • RENEW

  • 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

  • Changed property type (string)

    Added enum value:

    • PHYSICAL Removed enum value:

    • PLASTIC

POST /managed_cards/{id}/freeze

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json

  • Added property physicalCardDetails (object)

    • Property cardBureau (string)

    • Property productReference (string)

    • Property carrierType (string)

    • Property physicalState (object)

      Enum values:

      • PENDING_ACTIVATION
      • ACTIVE
      • LOST
      • STOLEN
      • DAMAGED
      • EXPIRED
      • PIN_BLOCKED

    • Property physicalActivationState (object)

      Enum values:

      • CONVERTED_ACTIVATION_PENDING
      • CONVERTED_ACTIVE
      • REGENERATED_ACTIVATION_PENDING
      • REGENERATED_ACTIVE
      • RENEWED_ACTIVATION_PENDING
      • RENEWED_ACTIVE

    • Property replacementId (integer)

    • Property replacementType (string)

      Enum values:

      • DAMAGED
      • LOST_STOLEN
      • RENEW

  • 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

  • Changed property type (string)

    Added enum value:

    • PHYSICAL Removed enum value:

    • PLASTIC

  Changed response : 409 Conflict

  Conflict

• Changed content type : application/json

  • Changed property errorCode (string)

    Added enum value:

    • INSTRUMENT_MARKED_LOST_STOLEN