GAgalileo-ft
Instant Issue

Get Bulk Card Order

Use Get Bulk Card Order to retrieve the details of an existing bulk card order that was created with the <a href="ref:post_createbulkcardorder" target="_blank">Create Bulk Card Order</a> endpoint. Consult the <a href="doc:instant-issue-cards" target="_blank">Instant-Issue Cards</a> guide for instructions on using this endpoint.

post/getBulkCardOrder

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

orderIdinteger required

The order ID (order_id) as returned by the <a href="ref:post_createbulkcardorder" target="_blank">Create Bulk Card Order</a> endpoint. Pattern: Positive integer Example: 5068

returnAllCards0 | 1 nullable

Specifies whether to return a list of all cards in the order, in the cards object:

  • 0 — Do not return cards
  • 1 — Return all cards

Pattern: Integer Example: 0

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "orderId": 5068
}

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.