Switch Product

post https://api-{corename}.{env}.gpsrv.com/intserv/4.0/switchProduct

Use the Switch Product endpoint to change the product ID on the specified account to a new product ID. To control whether the product switch triggers a card reissue, set doReissue.

For prodId pass the new product ID. This endpoint is valid only for card-account products. For products that do not have a card, use Set Account Feature with type: 3 to switch products.

Galileo recommends that you use the CAD for accountNo; however, you can use the PRN if only one card has ever been associated with the account.

For instructions on using this endpoint, see the Switching Products guide.

📘
Note
The expiry_date and card_security_code (CVV2) that are returned by the endpoint are not the new values. The new values are generated later by the emboss process. Call Get Card to retrieve the new values after the emboss process has run.

Form Data

apiLogin

string

required

Web service username, as provided by Galileo.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by Galileo.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

int32

required

Galileo-issued provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

A unique provider-generated ID to identify this API call. A UUID is preferred.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

accountNo

string

required

The PRN, PAN or CAD of the account.
Pattern: PAN, PRN, or CAD
Example: "074103447228"

prodId

int32

required

The new product ID for the account.
Pattern: Integer
Example: 4444

doReissue

string

Defaults to N

Controls whether to reissue the card. Default: N.
Pattern: Y or N
Example: Y

newPan

string | null

Defaults to null

Controls whether to generate a new PAN for the reissued card.
Pattern: Y or N
Example: Y

newExpiryDate

string | null

Defaults to null

Controls whether to generate a new expiry date for the reissued card. If newPan: Y then this value must be Y.
Pattern: Y or N
Example: Y

emboss

string | null

Defaults to null

Controls whether to emboss the reissued card.
Pattern: Y or N
Example: Y

oldCardStatus

string | null

Defaults to null

Specifies the status to set for the card that is being replaced. Status is set by the emboss process. Valid values are C, D or blank. Default: blank
Pattern: C, D or blank
Example: D

Headers

response-content-type

string

Defaults to json

Use xml or json to specify the type of response. The default value is xml. Use this instead of the standard accept header.

Response

Response body

object

status_code

int32 | null

required

The response status code. May return a string for some statuses.

status

string | null

required

The condition of a process or response

processing_time

float | null

required

The time elapsed in processing the transaction

echo

object | null

required

A structure that contains transaction ID information

transaction_id

string | null

required

An ID that represents an API transaction

provider_timestamp

date-time | null

required

Store a related timestamp for reporting and troubleshooting purposes

provider_transaction_id

string | null

required

Secondary transaction identifier (generated by a provider)

system_timestamp

date-time | null

required

A system generated timestamp

rtoken

string | null

required

A Galileo-generated ID used for tracking

errors

array of strings

A list of errors generated while the request was processed

errors

response_data

object | null

required

A structure for the response data. It can be empty but usually will contain information.

prod_id

int32

required

Identifier for the card's product

app_date

string | null

required

Date the account's application was submitted

galileo_account_number

string | null

required

Galileo-generated account number, also known as the balance ID

new_emboss_uuid

string | null

UUID for an emboss record that has not yet been sent to the embosser.

active_flag

string

required

Indicates whether an account is active

bill_cycle_day

string | null

Day of the month that the customer is billed

start_date

date | null

Date the account was activated

status

string

required

Status of the account

cards

array of objects

required

List of cards associated with the account

cards*

object

card_id

string

required

Unique identifier for a card

emboss_uuid

string | null

UUID for an emboss record that has been sent to the embosser. When this field is present outside the embossed_cards object, it contains the most recent emboss UUID.

card_number

string

required

PAN, usually masked

card_status

string | null

Status of the card

card_security_code

string | null

Card verification value (CVV2)

expiry_date

date | null

Expiration date of the card

external_card_id

string | null

required

Partner-specified external card identifier

pin_fail_count

string | null

required

The number of times a PIN entry failed

pin_fail_date

date-time | null

required

Last date a PIN fail was recorded

freeze_info

object

required

encrypted_card_number

string | null

Encrypted PAN of the card

encrypted_expiry_date

string | null

Encrypted expiration date of the card

embossed_cards

array of objects

required

List of embossed card objects

embossed_cards*

object

created_date

date

required

Date the card was created

emboss_uuid

string | null

UUID for an emboss record that has been sent to the embosser. When this field is present outside the embossed_cards object, it contains the most recent emboss UUID.

emboss_date

date

required

Date the card was embossed

expiry_date

date-time | null

Expiration date of the card

status

string

required

Emboss status. For valid values see the Emboss Statuses enumeration.

shipping_type

string | null

required

Type of shipping used

spend_controls

object

first_name

string

required

Cardholder first name

middle_name

string

required

Cardholder middle name

last_name

string

required

Cardholder last name

pmt_ref_no

string | null

required

Galileo-generated account number, also known as the PRN

status

string | null

Whether a card is frozen

ssn

string | null

Social Security number of the cardholder. This field is returned only if CINFN is set.

group_id

string | null

required

Integer used for tracking the location (store, entity, etc.) where the customer was acquired. The group_id is set using the location and locationType parameters in enrollment endpoints.

prn

string

required

Galileo-generated account number, also known as the pmt_ref_no

Status codes

See Global Response Statuses for status codes that are common across endpoints.

Status code	Description
590-01	`Product cannot be switched to the same product`. Verify that `prodId` is different from the account's current product ID.
590-02	`Product cannot be switched to an unauthorized product`. Verify that `prodId` is a valid product ID.
590-03	`Product has been successfully switched but card reissue failed: The valid values for newPanFlag and newExpirationDate include Y/N`. Call Reissue Card to complete the reissue, and verify that `newPanFlag` and `newExpiryDate` are set to `Y`, `N` or blank
590-04	`Trying to update card status without requesting new PAN`. The product has not been successfully switched and card reissue failed. If `newPan` is `N` or blank then `oldCardStatus` must be blank.
590-05	`Product has been successfully switched but card reissue failed: The valid values for oldCardStatus include D/C`. Call Reissue Card to complete the reissue and verify that `oldCardStatus` is set to `C`, `D` or blank.
590-06	`Product has been successfully switched but card reissue failed: Trying to update card status without requesting new PAN`. Call Reissue Card to complete the reissue. If `newPan` is `N` or blank then `oldCardStatus` must be blank.
590-07	`Product has been successfully switched but card reissue failed: Failure getting data associated with account/card`. Cannot retrieve CAD, ENP or product ID. Call Reissue Card to complete the reissue or contact Galileo for troubleshooting.
590-08	`Product has been successfully switched but card reissue failed: Failure getting data associated with account/card`. CAD or XID is null. Contact Galileo for troubleshooting.
590-09	`Product has been successfully switched but card reissue failed: Insufficient funds to cover reissue fee`. Follow your business process for this use case.
590-10	`Product has been successfully switched but card reissue failed: Failure, generic error processing reissue fee.` Contact Galileo for troubleshooting.
590-11	`If new_pan='Y' then new_expiry_date needs to be 'Y' too`. Product did not switch. Verify that `newExpiryDate: Y` when `newPan: Y`.
590-12	`Product has been successfully switched but card reissue failed: card has pending reissue records`. There is an emboss record in `status: Y` with the same product ID as the new product ID. This is a common status during testing when switching the same account repeatedly between products. If the existing emboss record is the desired emboss record, take no action. That card will be sent to the cardholder. If you are testing, call Activate Card to activate the existing emboss record and then call Reissue Card to complete the reissue.
590-13	`Product has been successfully switched but card reissue failed: Card reissue cannot be processed`. Contact Galileo for troubleshooting.

xxxxxxxxxx
curl --request POST \
     --url https://api-corename.env.gpsrv.com/intserv/4.0/switchProduct \
     --header 'accept: application/json' \
     --header 'content-type: application/x-www-form-urlencoded' \
     --header 'response-content-type: json' \
     --data doReissue=N \
     --data newPan=null \
     --data newExpiryDate=null \
     --data emboss=null \
     --data oldCardStatus=null