Skip to main content

Version 2.13.17

· 8 min read

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 card upgrade process​

You can only upgrade virtual cards to physical cards 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 transfer 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 transfer transaction.

API ChangeLog​

What's New​

POST /corporates/{id}/users/{user_id}/invites/send​
POST /corporates/{id}/users/{user_id}/invites/validate​

What's Deprecated​

POST /corporates/{id}/invites/{invite_id}/validate​
POST /corporates/{id}/invites/{invite_id}/send​

What's Changed​

POST /corporates/{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 /corporates/{id}/invites/{invite_id}/validate​
POST /corporates/{id}/invites/{invite_id}/send​
POST /corporates/{id}/get​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    New optional properties:

    • companyRegistrationNumber
    • name
    • registrationCountry
POST /corporates/{id}/update​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    New optional properties:

    • companyRegistrationNumber
    • name
    • registrationCountry
POST /corporates/_/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 /consumers/{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 /consumers/{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 /consumers/_/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 /transfers/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 /transfers/{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 /transfers/_/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 /send/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 /send/{id}/get​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property conflict (string)

      Added enum value:

      • INSUFFICIENT_FUNDS
POST /send/_/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_transfers/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 beneficiary

        • Changed property beneficiaryAddress (string)

          The beneficiary address

        • Changed property beneficiaryBankName (string)

          The name of the beneficiary bank

        • Changed property beneficiaryBankAddress (string)

          The beneficiary bank address

        • Changed property beneficiaryBankCountry (string)

          The beneficiary 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_transfers/{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 beneficiary

      • Changed property beneficiaryAddress (string)

        The beneficiary address

      • Changed property beneficiaryBankName (string)

        The name of the beneficiary bank

      • Changed property beneficiaryBankAddress (string)

        The beneficiary bank address

      • Changed property beneficiaryBankCountry (string)

        The beneficiary 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_transfers//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 beneficiary

    • Changed property beneficiaryAddress (string)

      The beneficiary address

    • Changed property beneficiaryBankName (string)

      The name of the beneficiary bank

    • Changed property beneficiaryBankAddress (string)

      The beneficiary bank address

    • Changed property beneficiaryBankCountry (string)

      The beneficiary 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 beneficiary

      • Changed property beneficiaryAddress (string)

        The beneficiary address

      • Changed property beneficiaryBankName (string)

        The name of the beneficiary bank

      • Changed property beneficiaryBankAddress (string)

        The beneficiary bank address

      • Changed property beneficiaryBankCountry (string)

        The beneficiary 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