completePorting

Connect will open on the complete porting page for a subscription. If the user has previously started the porting process, Connect will resume from where the user left off. Upon completing all required porting steps, users will be redirected back to callbackUrl if provided.

completePorting.jpg

The request expects a completePorting object that defines the subscription for which to complete a porting.

Creating a Connect Session with completePorting intent

$ curl --request "POST" \
--url "https://api.gigs.com/projects/${GIGS_PROJECT}/connectSessions" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer ${GIGS_TOKEN}" \
--data '{
  "callbackUrl": "https://example.com",
  "intent": {
    "type": "completePorting",
    "completePorting": {
      "subscription": "sub_0U32VAxJ0Z7P8Y40mBAnOP9LPhEr"
    }
  },
  "user": "usr_0U2ViuFW0Z7P8Y2S1L76mfADMT6m"
}'

Note: Please confirm that the subscription has a pending porting associated with it before creating a Connect Session. This is not checked during session creation. Redirecting the user to a subscription without a pending porting will open Connect in the subscription overview and might confuse users.

Intent Behavior

The completePorting intent displays an intro page at the start and an outro page after completion.

  • Intro Page: At the beginning of the flow, users are shown a page that explains the porting process. If the user previously started but did not finish the flow, a resume state is shown. This informs the user that some information has already been filled in and they are continuing from where they left off.
  • Outro Page: Once the porting flow is successfully completed, Connect will show a confirmation page instead of immediately redirecting the user. This page reassures the user that their porting request has been received and is now being processed in the background.

Note: These pages are enabled by default. If you prefer to skip the intro or outro pages, please contact your CS representative to disable them for your project.

Retrying Failed Porting Attempts

The completePorting intent can also be called for previously failed porting requests. This enables users to resolve the issues themselves by addressing specific errors without having to contact customer support.

This feature applies to porting requests that failed due to the following declinedCodes:

  • portingAccountNumberRequiredOrInvalid
  • portingAccountPinRequiredOrInvalid
  • portingFirstNameRequiredOrInvalid
  • portingLastNameRequiredOrInvalid
  • portingAddressRequiredOrInvalid
  • portingPhoneNumberPortProtected

If a Connect Session is created with a non-applicable declinedCode, Connect will display an error screen with an option to contact customer support and redirect to the callbackUrl if it is defined.

Note: This functionality is optional and must be enabled. Contact your CS representative to activate this feature for your project.

Aborting the Porting Flow

Users have the option to abort the porting flow if they choose not to proceed further. When this happens:

  • The callbackUrl provided during the Connect Session creation will be invoked.
  • The status sent to the callbackUrl will be user_aborted.

Where to go from here