Skip to main content

Version 2.7.0

· 3 min read

What's New

  • As part of charging capability (innovator charges to cardholder) we are introducing custom fees

    • POST /corporates/{id}/charge_fee
    • POST /consumers/{id}/charge_fee
  • Introduction of kyb/start for starting Corporate KYB process

    • POST /corporates/{id}/kyb/start
  • Introduction of withdrawal capability from managed_accounts

    • POST /managed_accounts/withdraw/get
    • POST /managed_accounts/{id}/withdraw/{withdraw_id}/get
    • POST /managed_accounts/{id}/withdraw/_/create
    • POST /managed_accounts/{id}/withdraw/get

What's Changed

  • Previously deprecated destroy have now been removed

    • POST /managed_accounts/{id}/destroy
    • POST /managed_cards/{id}/destroy
  • Lost password end points have moved from auth to passwords. auth is still available, but deprecated

    • POST /passwords/lost_password/validate
    • POST /passwords/lost_password/start
    • POST /passwords/lost_password/resume
    • POST /auth/lost_password/validate
    • POST /auth/lost_password/start
    • POST /auth/lost_password/resume
  • New error code returned in case KYC is attempted for a Consumer who is already approved

    • POST /consumers/{id}/kyc/start
  • Removal of secretType from APIs

    • POST /corporates/_/create
    • POST /consumers/_/create
    • POST /corporates/{id}/users/{user_id}/get
    • POST /corporates/{id}/users/{user_id}/update
    • POST /corporates/{id}/users/_/create
    • POST /corporates/{id}/users/get

What's New

POST /passwords/lost_password/validate
POST /passwords/lost_password/start
POST /passwords/lost_password/resume
POST /corporates/{id}/charge_fee
POST /corporates/{id}/kyb/start
POST /consumers/{id}/charge_fee
POST /managed_accounts/withdraw/get
POST /managed_accounts/{id}/withdraw/{withdraw_id}/get
POST /managed_accounts/{id}/withdraw/_/create
POST /managed_accounts/{id}/withdraw/get

What's Deleted

POST /managed_accounts/{id}/destroy
POST /managed_cards/{id}/destroy

What's Deprecated

POST /auth/lost_password/validate
POST /auth/lost_password/start
POST /auth/lost_password/resume

What's Changed

POST /auth/lost_password/validate
Request:

Changed content type : application/json

  • Changed property email (string)

  • Changed property nonce (string)

Return Type:

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INVALID_NONCE_OR_EMAIL

      Removed enum values:

      • PASSWORD_ALREADY_USED
      • PASSWORD_TOO_SHORT
      • PASSWORD_TOO_LONG
      • PASSWORD_TOO_SIMPLE
      • PASSWORD_INCORRECT
POST /auth/lost_password/start
Request:

Changed content type : application/json

  • Changed property email (string)
POST /auth/lost_password/resume
Request:

Changed content type : application/json

  • Changed property email (string)

  • Changed property nonce (string)

Return Type:

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INVALID_NONCE_OR_EMAIL
POST /corporates/{id}/users/{user_id}/get
Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    New optional properties:

    • secretType

    • Deleted property secretType (object)
POST /corporates/{id}/users/{user_id}/update
Request:

Changed content type : application/json

  • Deleted property secretType (object)

    Determines what authentication methods should be used. In general, this should have firstSecretType set to passwords. In the future will allow for secondary authentication mechanisms.

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    New optional properties:

    • secretType

    • Deleted property secretType (object)
POST /corporates/{id}/users/_/create
Request:

Changed content type : application/json

New optional properties:

  • secretType
  • Deleted property secretType (object)
Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    New optional properties:

    • secretType

    • Deleted property secretType (object)
POST /corporates/{id}/users/get
Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property user (array)

      Changed items (object):

      New optional properties:

      • secretType

      • Deleted property secretType (object)
POST /corporates/_/create
Request:

Changed content type : application/json

New optional properties:

  • rootSecretType
  • Deleted property rootSecretType (object)
POST /consumers/{id}/kyc/start
Return Type:

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • KYC_ALREADY_APPROVED
POST /consumers/_/create
Request:

Changed content type : application/json

New optional properties:

  • secretType
  • Deleted property secretType (object)