Skip to main content

Version 2.12.3

· 15 min read

What's Changed​

  • Corporates and Consumer Due Diligence Limits: Multiple limits may start to apply to a particular Corporate. For this reason, the current allowedLimit object and remainingLimit object which support only 1 limit have been deprecated in favour of 2 new objects allowedLimits and remainingLimits which support an array of limits. The old objects allowedLimit and remainingLimit will continue to return the most restrictive limit from the set.

    • POST /corporates/{id}/kyb/get
    • POST /corporates/{id}/get
    • POST /corporates/{id}/update
    • POST /corporates/_/create
    • POST /consumers/{id}/kyc/get
    • POST /consumers/{id}/get
    • POST /consumers/{id}/update
    • POST /consumers/_/create

  • Managed Accounts: Two new properties accountNumber and sortCode have been added to the bank details associated with a Managed Account.

    • POST /managed_accounts/get
    • POST /managed_accounts/{id}/unfreeze
    • POST /managed_accounts/{id}/remove
    • POST /managed_accounts/{id}/get
    • POST /managed_accounts/{id}/update
    • POST /managedaccounts//create
    • POST /managed_accounts/{id}/freeze

What's Changed​

POST /corporates/{id}/kyb/get​
Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property allowedLimits (array) > The allowed funding limit for the corporate given the current KYB Status.

      Items (object):

      • Property name (string) > The name of the limit.

      • Property counterValue (integer) > How much amount value have been added to the counter as of now.

      • Property limit (object)

        • Property currency (string) > The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

        • Property amount (integer) > The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

    • Added property remainingLimits (array) > The remaining funding limit for the corporate given the current KYB Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

      Items (object):

      • Property name (string) > The name of the limit.

      • Property counterValue (integer) > How much amount value have been added to the counter as of now.

      • Property limit (object)

        • Property currency (string) > The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

        • Property amount (integer) > The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

    • Changed property allowedLimit (object) > The allowed funding limit for the corporate given the current KYB Status.

    • Changed property remainingLimit (object) > The remaining funding limit for the corporate given the current KYB Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

POST /corporates/{id}/get​
Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property kyb (object) > The KYB status of the corporate account.

      • Added property allowedLimits (array) > The allowed funding limit for the corporate given the current KYB Status.

        Items (object):

        • Property name (string) > The name of the limit.

        • Property counterValue (integer) > How much amount value have been added to the counter as of now.

        • Property limit (object)

          • Property currency (string) > The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

          • Property amount (integer) > The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

      • Added property remainingLimits (array) > The remaining funding limit for the corporate given the current KYB Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

        Items (object):

        • Property name (string) > The name of the limit.

        • Property counterValue (integer) > How much amount value have been added to the counter as of now.

        • Property limit (object)

          • Property currency (string) > The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

          • Property amount (integer) > The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

      • Changed property allowedLimit (object) > The allowed funding limit for the corporate given the current KYB Status.

      • Changed property remainingLimit (object) > The remaining funding limit for the corporate given the current KYB Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

POST /corporates/{id}/update​
Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property kyb (object) > The KYB status of the corporate account.

      • Added property allowedLimits (array) > The allowed funding limit for the corporate given the current KYB Status.

        Items (object):

        • Property name (string) > The name of the limit.

        • Property counterValue (integer) > How much amount value have been added to the counter as of now.

        • Property limit (object)

          • Property currency (string) > The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

          • Property amount (integer) > The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

      • Added property remainingLimits (array) > The remaining funding limit for the corporate given the current KYB Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

        Items (object):

        • Property name (string) > The name of the limit.

        • Property counterValue (integer) > How much amount value have been added to the counter as of now.

        • Property limit (object)

          • Property currency (string) > The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

          • Property amount (integer) > The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

      • Changed property allowedLimit (object) > The allowed funding limit for the corporate given the current KYB Status.

      • Changed property remainingLimit (object) > The remaining funding limit for the corporate given the current KYB Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

POST /corporates/_/create​
Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property kyb (object) > The KYB status of the corporate account.

      • Added property allowedLimits (array) > The allowed funding limit for the corporate given the current KYB Status.

        Items (object):

        • Property name (string) > The name of the limit.

        • Property counterValue (integer) > How much amount value have been added to the counter as of now.

        • Property limit (object)

          • Property currency (string) > The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

          • Property amount (integer) > The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

      • Added property remainingLimits (array) > The remaining funding limit for the corporate given the current KYB Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

        Items (object):

        • Property name (string) > The name of the limit.

        • Property counterValue (integer) > How much amount value have been added to the counter as of now.

        • Property limit (object)

          • Property currency (string) > The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

          • Property amount (integer) > The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

      • Changed property allowedLimit (object) > The allowed funding limit for the corporate given the current KYB Status.

      • Changed property remainingLimit (object) > The remaining funding limit for the corporate given the current KYB Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

POST /consumers/{id}/kyc/get​
Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property allowedLimits (array) > The allowed funding limit for the consumer given the current KYC Status.

      Items (object):

      • Property name (string) > The name of the limit.

      • Property counterValue (integer) > How much amount value have been added to the counter as of now.

      • Property limit (object)

        • Property currency (string) > The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

        • Property amount (integer) > The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

    • Added property remainingLimits (array) > The remaining funding limit for the consumer given the current KYC Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

      Items (object):

      • Property name (string) > The name of the limit.

      • Property counterValue (integer) > How much amount value have been added to the counter as of now.

      • Property limit (object)

        • Property currency (string) > The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

        • Property amount (integer) > The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

    • Changed property allowedLimit (object) > The allowed funding limit for the consumer given the current KYC Status.

    • Changed property remainingLimit (object) > The remaining funding limit for the consumer given the current KYC Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

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 allowedLimits (array) > The allowed funding limit for the consumer given the current KYC Status.

        Items (object):

        • Property name (string) > The name of the limit.

        • Property counterValue (integer) > How much amount value have been added to the counter as of now.

        • Property limit (object)

          • Property currency (string) > The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

          • Property amount (integer) > The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

      • Added property remainingLimits (array) > The remaining funding limit for the consumer given the current KYC Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

        Items (object):

        • Property name (string) > The name of the limit.

        • Property counterValue (integer) > How much amount value have been added to the counter as of now.

        • Property limit (object)

          • Property currency (string) > The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

          • Property amount (integer) > The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

      • Changed property allowedLimit (object) > The allowed funding limit for the consumer given the current KYC Status.

      • Changed property remainingLimit (object) > The remaining funding limit for the consumer given the current KYC Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

POST /consumers/{id}/update​
Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property kyc (object) > The KYC status of the consumer.

      • Added property allowedLimits (array) > The allowed funding limit for the consumer given the current KYC Status.

        Items (object):

        • Property name (string) > The name of the limit.

        • Property counterValue (integer) > How much amount value have been added to the counter as of now.

        • Property limit (object)

          • Property currency (string) > The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

          • Property amount (integer) > The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

      • Added property remainingLimits (array) > The remaining funding limit for the consumer given the current KYC Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

        Items (object):

        • Property name (string) > The name of the limit.

        • Property counterValue (integer) > How much amount value have been added to the counter as of now.

        • Property limit (object)

          • Property currency (string) > The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

          • Property amount (integer) > The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

      • Changed property allowedLimit (object) > The allowed funding limit for the consumer given the current KYC Status.

      • Changed property remainingLimit (object) > The remaining funding limit for the consumer given the current KYC Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

POST /consumers/_/create​
Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property kyc (object) > The KYC status of the consumer.

      • Added property allowedLimits (array) > The allowed funding limit for the consumer given the current KYC Status.

        Items (object):

        • Property name (string) > The name of the limit.

        • Property counterValue (integer) > How much amount value have been added to the counter as of now.

        • Property limit (object)

          • Property currency (string) > The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

          • Property amount (integer) > The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

      • Added property remainingLimits (array) > The remaining funding limit for the consumer given the current KYC Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

        Items (object):

        • Property name (string) > The name of the limit.

        • Property counterValue (integer) > How much amount value have been added to the counter as of now.

        • Property limit (object)

          • Property currency (string) > The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

          • Property amount (integer) > The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

      • Changed property allowedLimit (object) > The allowed funding limit for the consumer given the current KYC Status.

      • Changed property remainingLimit (object) > The remaining funding limit for the consumer given the current KYC Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

POST /managed_accounts/get​
Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property account (array)

      Changed items (object):

      • Changed property bankAccountDetails (object) > The bank account details to be used when loading funds to this managed account.

        • Added property accountNumber (string)

        • Added property sortCode (string)

POST /managed_accounts/{id}/unfreeze​
Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property bankAccountDetails (object) > The bank account details to be used when loading funds to this managed account.

      • Added property accountNumber (string)

      • Added property sortCode (string)

POST /managed_accounts/{id}/remove​
Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property bankAccountDetails (object) > The bank account details to be used when loading funds to this managed account.

      • Added property accountNumber (string)

      • Added property sortCode (string)

POST /managed_accounts/{id}/get​
Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property bankAccountDetails (object) > The bank account details to be used when loading funds to this managed account.

      • Added property accountNumber (string)

      • Added property sortCode (string)

POST /managed_accounts/{id}/update​
Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property bankAccountDetails (object) > The bank account details to be used when loading funds to this managed account.

      • Added property accountNumber (string)

      • Added property sortCode (string)

POST /managedaccounts//create​
Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property bankAccountDetails (object) > The bank account details to be used when loading funds to this managed account.

      • Added property accountNumber (string)

      • Added property sortCode (string)

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum values:

      • OWNER_NOT_VERIFIED
      • OWNER_ACCOUNT_LIMIT_EXCEEDED
POST /managed_accounts/{id}/freeze​
Return Type​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property bankAccountDetails (object) > The bank account details to be used when loading funds to this managed account.

      • Added property accountNumber (string)

      • Added property sortCode (string)