Accounts and Cards

Activate Card

Use the Activate Card endpoint to activate a physical card that has an emboss record in status: Y. Do not use this endpoint to activate a virtual card; instead, use the <a href="ref:post_modifystatus" target="_blank">Modify Status</a> endpoint with type: 7.

Consult the <a href="doc:activate-card-procedure" target="_blank">Activating a Card</a> procedure for more information.

If you are not PCI compliant, you can use this endpoint only under certain circumstances. See <a href="doc:setting-up-a-card-program#pci-compliance" target="_blank">PCI compliance</a> in Setting Up a Card Program for details.

For Digital First cards, calling this endpoint removes account features 20 or 21 to activate the physical card. See <a href="doc:setup-for-digital-first#removing-the-block" target="_blank">Removing the block</a> for details.

post/activateCard

Request

Base URL
api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
URL
api-{corename}.{env}.gpsrv.com/intserv/4.0/activateCard
Auth
none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

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

apiTransKeystring required

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

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>.. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

accountNostring required

The <glossary:PRN>, <glossary:PAN> or <glossary:CAD> of the account. For card-specific endpoints such as this one, the CAD is preferred. Do not use the PRN if more than one card has ever been associated with this account. Pattern: PAN, PRN, or CAD Example: "074103447228"

cardExpiryDatestring required

The expiry date provided by the cardholder. This value is compared to the expiry date in the system. Pattern: YYYY-MM Example: "2019-01"

cardSecurityCodestring nullable

The <glossary:CVV> value provided by the cardholder. This value is compared to the CVV in the system. Pattern: 3 digits Example: "123"

cardNumberLastFourstring nullable

If accountNo contains a PRN, and multiple cards are associated with this account, use this value to ensure that the correct card is selected. Pattern: 4 digits Example: "0789"

deactivateTemporaryCardsinteger nullable

If temporary cards were issued, this controls whether to deactivate the temporary cards:

1 — Deactivate
0 — Do not deactivate

Pattern: Integer Example: 1

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "cardExpiryDate": "2019-01",
  "cardSecurityCode": "123",
  "cardNumberLastFour": "0789",
  "deactivateTemporaryCards": 1
}

Response

status_codeinteger nullable required

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

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

Changes

No recorded changes to this operation across all 2 revisions of this API.