Instant Issue

Create Bulk Card Order

Use the Create Bulk Card Order endpoint to initiate a request for a batch of instant-issue cards. Consult the <a href="doc:instant-issue-cards" target="_blank">Instant-Issue Cards</a> guide for instructions on using this endpoint.

post/createBulkCardOrder

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/createBulkCardOrder
  • 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"

prodIdinteger required

A unique product identifier from SoFi Tech Solutions. Pattern: Integer Example: 501

numberOfCardsinteger required

Number of cards to be created. Pattern: Positive integer Example: 1000

embossWithstring nullable

Optional string to be printed on the first emboss line of the cards. Pattern: Max 20 alphanumeric characters Example: "Bob's cards"

shipToNamestring required

In-care-of name for the address where the bulk card order is to be shipped. Pattern: Max 40 alphanumeric characters Example: "c"

shipToAddressstring required

Street address where the bulk order is to be shipped. Pattern: Max 40 alphanumeric characters Example: "33 Maple Street"

shipToCitystring required

City where the bulk order is to be shipped. Pattern: Max 20 alphanumeric characters Example: "Salt Lake City"

shipToStateOrProvincestring required

State or province where the bulk order is to be shipped. Pattern: 2-character state or province code Example: "UT"

shipToPostalCodestring required

Postal code where the bulk order is to be shipped Pattern: 12345, 12345-6789, or K1A-1A1 Example: "84121"

locationstring required

Location identifier as returned by <a href="ref:post_createlocation" target="_blank">Create Location</a> (location) or <a href="ref:post_getlocations" target="_blank">Get Locations</a> (location_id or provider_specified_id). Pattern: Integer if location or location_id; max 15 characters if provider_specified_id Example: "a455-3483"

locationType0 | 1

Type of ID in location:

  • 0 — SoFi Tech Solutions location ID
  • 1 — Partner location ID

Pattern: Integer Example: 1

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "prodId": 501,
  "numberOfCards": 1000,
  "embossWith": "Bob's cards",
  "shipToName": "Bob's cards",
  "shipToAddress": "33 Maple Street",
  "shipToCity": "Salt Lake City",
  "shipToStateOrProvince": "UT",
  "shipToPostalCode": "84121",
  "location": "a455-3483",
  "locationType": 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.