Skip to main content

Version 2.10.2

· 7 min read
Adrian Mizzi

What's Changed​

  • Changes to invite corporate user and consume invite

    • When creating a new corporate user, the invite email is not sent automatically. This must now be triggered separately.
      • POST /corporates/{id}/users/_/create
    • A new API
      • POST /corporates/{id}/invites/{invite_id}/send
    • When inviting a corporate user, this new consume invite operation now returns the auth token for the user to avoid having to login again
      • POST /auth/invites/{invite_id}/consume

  • Addition of new error codes as detailed below

  • Minor changes to responses as detailed below

What's New​

POST /auth/invites/{invite_id}/consume​
POST /corporates/{id}/invites/{invite_id}/send​

What's Deleted​

POST /corporates/{id}/invites/consume​

What's Changed​

POST /corporates/{id}/users/{user_id}/update​
Request:​

Changed content type : application/json

  • Changed property name (string)

    The first name of the user

  • Changed property surname (string)

    The last name of the user

POST /corporates/{id}/users/_/create​
Request:​

Changed content type : application/json

  • Changed property name (string)

    The first name of the user

  • Changed property surname (string)

    The last name of the user

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    New required properties:

    • corporateUser
    • inviteId

    New optional properties:

    • email
    • id
    • identity
    • name
    • surname
    • type
    • username

    • Added property corporateUser (object)

      • Property id (integer)

      • Property type (string)

        Enum values:

        • ROOT
        • USER

      • Property identity (object)

        • Property type (string)

        • Property id (integer)

      • Property username (string)

      • Property title (string)

      • Property name (string)

      • Property surname (string)

      • Property email (string)

      • Property active (boolean)

      • Property companyPosition (string)

      • Property mobileCountryCode (string)

      • Property mobileNumber (string)

    • Added property inviteId (integer)

      Invite id required to create new user's credentials

    • Deleted property id (integer)

    • Deleted property type (string)

    • Deleted property identity (object)

    • Deleted property username (string)

    • Deleted property title (string)

    • Deleted property name (string)

    • Deleted property surname (string)

    • Deleted property email (string)

    • Deleted property active (boolean)

    • Deleted property companyPosition (string)

    • Deleted property mobileCountryCode (string)

    • Deleted property mobileNumber (string)

POST /corporates/{id}/update​
Request:​

Changed content type : application/json

  • Changed property name (string)

    The registered name of the company

Return Type:​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INVALID_FEE_GROUP
POST /corporates/_/create​
Request:​

Changed content type : application/json

  • Changed property companyName (string)

    The registered name of the company

  • Changed property rootName (string)

    The first name of the root user

  • Changed property rootSurname (string)

    The last name of the root user

Return Type:​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INVALID_FEE_GROUP
POST /consumers/{id}/get​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property kyc (object)

      The KYC status of the consumer.

      • Added property pep (object)

        Enum values:

        • CHECK_NOT_STARTED
        • YES
        • NO
        • PENDING

      • Added property sanctioned (object)

        Enum values:

        • CHECK_NOT_STARTED
        • YES
        • NO
        • PENDING

      • Deleted property isPep (object)

      • Deleted property isSanctioned (object)

    • Changed property address (object)

      Address of the consumer

      • Changed property addressLine1 (string)

        Address of the identity

      • Changed property addressLine2 (string)

        Continued address of the identity

      • Changed property city (string)

        City of the identity

POST /consumers/{id}/update​
Request:​

Changed content type : application/json

  • Changed property name (string)

    The first name of the Consumer

  • Changed property surname (string)

    The last name of the Consumer

  • Changed property address (object)

    Address of the consumer

    • Changed property addressLine1 (string)

      Address of the identity

    • Changed property addressLine2 (string)

      Continued address of the identity

    • Changed property city (string)

      City of the identity

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property kyc (object)

      The KYC status of the consumer.

      • Added property pep (object)

        Enum values:

        • CHECK_NOT_STARTED
        • YES
        • NO
        • PENDING

      • Added property sanctioned (object)

        Enum values:

        • CHECK_NOT_STARTED
        • YES
        • NO
        • PENDING

      • Deleted property isPep (object)

      • Deleted property isSanctioned (object)

    • Changed property address (object)

      Address of the consumer

      • Changed property addressLine1 (string)

        Address of the identity

      • Changed property addressLine2 (string)

        Continued address of the identity

      • Changed property city (string)

        City of the identity

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INVALID_FEE_GROUP
POST /consumers/_/create​
Request:​

Changed content type : application/json

  • Changed property name (string)

    The first name of the Consumer

  • Changed property surname (string)

    The last name of the Consumer

  • Changed property address (object)

    Address of the consumer

    • Changed property addressLine1 (string)

      Address of the identity

    • Changed property addressLine2 (string)

      Continued address of the identity

    • Changed property city (string)

      City of the identity

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property kyc (object)

      The KYC status of the consumer.

      • Added property pep (object)

        Enum values:

        • CHECK_NOT_STARTED
        • YES
        • NO
        • PENDING

      • Added property sanctioned (object)

        Enum values:

        • CHECK_NOT_STARTED
        • YES
        • NO
        • PENDING

      • Deleted property isPep (object)

      • Deleted property isSanctioned (object)

    • Changed property address (object)

      Address of the consumer

      • Changed property addressLine1 (string)

        Address of the identity

      • Changed property addressLine2 (string)

        Continued address of the identity

      • Changed property city (string)

        City of the identity

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INVALID_FEE_GROUP
POST /managed_accounts/{id}/unfreeze​
Return Type:​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INSTRUMENT_DESTROYED
POST /managed_accounts/{id}/freeze​
Return Type:​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INSTRUMENT_DESTROYED
POST /managed_cards/get​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property card (array)

      Changed items (object):

      • Changed property billingAddress (object)

        The billing address set for the card holder required for AVS checking.

        • Changed property addressLine1 (string)

          Address of the identity

        • Changed property addressLine2 (string)

          Continued address of the identity

        • Changed property city (string)

          City of the identity

POST /managed_cards/{id}/unfreeze​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property billingAddress (object)

      The billing address set for the card holder required for AVS checking.

      • Changed property addressLine1 (string)

        Address of the identity

      • Changed property addressLine2 (string)

        Continued address of the identity

      • Changed property city (string)

        City of the identity

POST /managed_cards/{id}/remove​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property billingAddress (object)

      The billing address set for the card holder required for AVS checking.

      • Changed property addressLine1 (string)

        Address of the identity

      • Changed property addressLine2 (string)

        Continued address of the identity

      • Changed property city (string)

        City of the identity

POST /managed_cards/{id}/get​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property billingAddress (object)

      The billing address set for the card holder required for AVS checking.

      • Changed property addressLine1 (string)

        Address of the identity

      • Changed property addressLine2 (string)

        Continued address of the identity

      • Changed property city (string)

        City of the identity

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

Changed content type : application/json

  • Changed property billingAddress (object)

    The billing address set for the card holder required for AVS checking.

    • Changed property addressLine1 (string)

      Address of the identity

    • Changed property addressLine2 (string)

      Continued address of the identity

    • Changed property city (string)

      City of the identity

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property billingAddress (object)

      The billing address set for the card holder required for AVS checking.

      • Changed property addressLine1 (string)

        Address of the identity

      • Changed property addressLine2 (string)

        Continued address of the identity

      • Changed property city (string)

        City of the identity

POST /managedcards//create​
Request:​

Changed content type : application/json

  • Changed property billingAddress (object)

    The billing address set for the card holder required for AVS checking.

    • Changed property addressLine1 (string)

      Address of the identity

    • Changed property addressLine2 (string)

      Continued address of the identity

    • Changed property city (string)

      City of the identity

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property billingAddress (object)

      The billing address set for the card holder required for AVS checking.

      • Changed property addressLine1 (string)

        Address of the identity

      • Changed property addressLine2 (string)

        Continued address of the identity

      • Changed property city (string)

        City of the identity

POST /managed_cards/{id}/freeze​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property billingAddress (object)

      The billing address set for the card holder required for AVS checking.

      • Changed property addressLine1 (string)

        Address of the identity

      • Changed property addressLine2 (string)

        Continued address of the identity

      • Changed property city (string)

        City of the identity