Accounts and Cards

Add Card

Use the Add Card endpoint to add a new card (<glossary:PAN> and <glossary:CAD>) to an existing <glossary:PRN>. Cards that are created with this endpoint are active upon creation, and the account status is updated to the second position of XAACT. SoFi Tech Solutions recommends that you have only one active card per PRN. As needed, ensure that any previous card has been marked lost, stolen, canceled, or any status but N.

Do not use this endpoint to create multiple spending cards that share a central balance. For that use case, SoFi Tech Solutions recommends <a href="doc:real-time-funding" target="_blank">Real-Time Funding</a> or <a href="doc:corporate-credit" target="_blank">Corporate Credit</a> for large numbers of cards, or for small numbers of cards you can create <a href="doc:about-accounts#joint-accounts-and-shared-balances" target="_blank">one primary and multiple secondary accounts</a> that share a balance.

Use this endpoint in scenarios such as these:

  • Replacing a virtual card that is lost, stolen, or expired
  • Adding another virtual card to a PRN
  • Replacing an instant-issue card at a storefront (for card programs with a retail integration)
  • Replacing a personalized card
post/addCard

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/addCard
  • 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> or <glossary:PAN> of the account. Do not use the <glossary:CAD>. Pattern: PAN or PRN Example: "074103447228"

prodIdinteger required

Product ID of the card in accountNo. Pattern: Integer Example: "501"

newAccountNostring nullable

The <glossary:PAN>, <glossary:PRN> or package ID of the instant-issue card to add. Pass this parameter only for instant-issue cards. Pattern: PAN or PRN or Package ID Example: "123456789012"

creditLimitnumber nullable

Credit limit for card-based spending control. This is available only for credit programs. Pattern: Monetary amount greater than 0. Example: 500.25

singleUse'Y' | 'N'

Spending control to limit the card to one purchase transaction. This is available only for credit programs. Pattern: String Example: "Y"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "newAccountNo": "123456789012",
  "creditLimit": 500.25,
  "singleUse": "Y"
}

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.