Migration Guide - Hackathon to Beta

Card Issuing Simulator Service
  • billingConversionRate field needs to be added to the payload in details field for operations /card_issuing_simulator/authorisation and /card_issuing_simulator/settlement. The following definition applies:

    billingConversionRate:
          description: "The conversion rate between the original transaction amount\
            \ and the billing amount."
          $ref: "#/definitions/ScaledAmount"
  • providerProcessingTimestamp field needs to be added to the payload in details field for operation /card_issuing_simulator/settlement. The following definition applies:

    providerProcessingTimestamp:
          type: "string"
          format: "int64"
          description: "This timestamp is similar to standard UNIX epoch timestamps\
            \ but uses millisecond precision instead of seconds."
  • fileName field needs to be added to the payload in details field for operation /card_issuing_simulator/settlement. The following definition applies:

    fileName:
          type: "string"
          minLength: 1
          maxLength: 50
          x-fieldValidation: "required size(1,50)"
Collector Service
  • All API operations for the Collector service have been removed since they were simply placeholders to give an idea of what to expect from the API. Querying the Data Warehouse will therefore not be available in Beta Phase 1, but direct querying in the MySQL server should offer a clear picture of what sort of data is being collected from the other services.
Corporate_Identities Service / Corporates Service
  • Any usages of the following Operations and Definitions need to be refactored as described, particularly if using Swagger-Generated code:
    • Operation /corporate_identities/_/create/corporates/_/create
      • Defn CreateCorporateIdentityParamsCreateCorporateParams
      • Defn CorporateIdentityCorporate
      • Defn CreateCorporateIdentityConflictCreateCorporateConflict
    • Operation /corporate_identities/get/corporates/get
      • Defn CorporateIdentitiesFilterCorporatesFilter
      • Defn CorporateIdentitiesCorporates
    • Operation /corporate_identities/profiles/get/corporates/profiles/get
      • OperationId corporate_identities_profiles_id_getcorporates_profiles_get
      • Defn CorporateIdentityProfilesFilterCorporateProfilesFilter
      • Defn CorporateIdentityProfilesCorporateProfiles
    • Operation /corporate_identities/profiles/{id}/get/corporates/profiles/{id}/get
      • OperationId corporate_identities_profiles_id_getcorporates_profiles_id_get
      • Defn CorporateIdentityProfileCorporateProfile
    • Operation /corporate_identities/users/_/create/corporates/users/_/create
      • OperationId corporate_identities_users_id_createcorporates_users_id_create
      • Defn CreateCorporateIdentityUserParamsCreateCorporateUserParams
    • Operation /corporate_identities/users/get/corporates/users/get
      • OperationId corporate_identities_users_getcorporates_users_get
      • Defn CorporateIdentityUsersFilterCorporateUsersFilter
    • Operation /corporate_identities/users/{id}/get/corporates/users/{id}/get
      • OperationId corporate_identities_users_id_getcorporates_users_id_get
    • Operation /corporate_identities/users/{id}/update/corporates/users/{id}/update
      • OperationId corporate_identities_users_id_updatecorporates_users_id_update
      • Defn UpdateCorporateIdentityUserParamsUpdateCorporateUserParams
    • Operation /corporate_identities/{id}/get/corporates/{id}/get
      • OperationId corporate_identities_id_getcorporates_id_get
      • Defn CorporateIdentityCorporate (as mentioned above)
    • Operation /corporate_identities/{id}/update/corporates/{id}/update
      • OperationId corporate_identities_id_updatecorporates_id_update
      • Defn UpdateCorporateIdentityParamsUpdateCorporateParams
      • Defn CorporateIdentityCorporate (as mentioned above)
Deposits Service
  • programmeId field needs to be added to the payload for operations /deposits/profiles/get and /deposits/get. The following definition applies:
    programmeId:
          $ref: "#/definitions/NullableInt64"
External Accounts Service
  • programmeId field needs to be added to the payload for operations /external_accounts/profiles/get. The following definition applies:

    programmeId:
          $ref: "#/definitions/NullableInt64"
  • ownerId field needs to be added to the payload for operations /external_accounts/get. The following definition applies:

    ownerId:
          $ref: "#/definitions/NullableInt64"
Managed Accounts Service
  • programmeId field needs to be added to the payload for operations /managed_accounts/profiles/get. The following definition applies:

    programmeId:
          $ref: "#/definitions/NullableInt64"
  • ownerId field needs to be added to the payload for operations /managed_accounts/get. The following definition applies:

    ownerId:
          $ref: "#/definitions/NullableInt64"
Managed Cards Service
  • programmeId field needs to be added to the payload for operations /managed_cards/profiles/get. The following definition applies:

    programmeId:
          $ref: "#/definitions/NullableInt64"
  • ownerId field needs to be added to the payload for operations /managed_cards/get. The following definition applies:

    ownerId:
          $ref: "#/definitions/NullableInt64"
Passwords Service
  • oldPassword field needs to be added to the payload for operation /passwords/{credential_id}/update. Authorization header is no longer needed by this operation as one must now know the old password to change it with this operation. This is useful for a forgotten password reset type of functionality. The following definition applies to oldPassword field:
    oldPassword:  description: "The old password value. Must match the credential's existing password."
      $ref: "#/definitions/SensitiveString"</code></pre>
      Alternatively: Switch to the new operation /passwords/{credential_id}/authenticated_update that does
      not require the oldPassword field but requires the Authorization header instead.
Transfers Service
  • programmeId field needs to be added to the payload for operations /transfers/profiles/get and /transfers/get. The following definition applies:
    programmeId:
          $ref: "#/definitions/NullableInt64"
Withdrawals Service
  • programmeId field needs to be added to the payload for operations /withdrawals/profiles/get and /withdrawals/get. The following definition applies:
    programmeId:
          $ref: "#/definitions/NullableInt64"