Create Bulk Orders

Create a person and a bulk order on Qolo platform. If the person is already created, send an existing Person GUID.

Request
Security:
Bearer
path Parameters
version
required
string
Request Body schema: application/json
package_guid
string <uuid>

Package guid

emboss_line3
string or null <= 26 characters

Third line

emboss_line4
string or null <= 26 characters

Fourth line

shipping_method
string (ShippingMethod)

Shipping method to be used for the Physical card. Must match with what is configured for the program, else will error out.
STDMAIL - Standard Mail (USPS Standard)
STDEXP - Standard Expedited shipment (USPS Expedited)
UPSSTD - UPS Standard
UPSGROUND - UPS Ground
USPSPRI - USPS Priority
EXPRESS2DAY - Express 2 day delivery (UPS2Day)
EXPRESSOVERNIGHT - Overnight delivery (UPS1Day)
STDMAILINT - Standard International Mail (USPS International)
EXPRESS2DAYINT - Priority International (USPS)
EXPRESS1DAYINT - UPS World Wide Saver Intl.

Enum: "STDMAIL" "STDEXP" "UPSSTD" "UPSGROUND" "USPSPRI" "EXPRESS2DAY" "EXPRESSOVERNIGHT" "STDMAILINT" "EXPRESS2DAYINT" "EXPRESS1DAYINT"
order_guid
string or null <uuid>

Order guid

wallet_guid
string or null <uuid>

Wallet guid

program_guid
required
string <uuid>

Program guid

order_type
string (OrderType)

Type of order.
D2C - Direct to Customer(Default); used for individual personalized card
BULKC - Bulk card with no carrier
BULKCC - Bulk card with carriers in envelopes
BULK - Equates to BULKC or BULKCC based on program setup at the fulfillment house.

Enum: "DTC" "BULKC" "BULKCC" "BULK"
order_count
integer <int32>

Order count

order_status
string or null <= 40 characters

Order status

required
object (PersonDTO)
bulk_issuance_type
string (BulkIssuanceType)
Enum: "FULL" "ONETIMELOAD"
carrier
string or null <= 100 characters

Carrier type

location_name
required
string [ 1 .. 48 ] characters

location name

iin_brand
string (IinBrand)

Card scheme to be used if multiple card schemes are configured for the program.Can be skipped to equate to what is configured for the program.

Enum: "VISA" "MASTERCARD" "DISCOVER" "AMEX"
revenue_account_guid
string or null <uuid>
Responses
201

Returns the newly bulkorder

400

Bad request

401

Unauthorized

404

Program not found

500

Server Error

post/api/{version}/bulkorders
Request samples
application/json
{
  • "package_guid": "bbcfa7f4-7eee-4d1b-9f7d-736ad8949479",
  • "emboss_line3": "string",
  • "emboss_line4": "string",
  • "shipping_method": "STDMAIL",
  • "order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
  • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
  • "order_type": "DTC",
  • "order_count": 0,
  • "order_status": "string",
  • "person": {
    • "identifications": [
      • {
        • "govt_id_type": "NOTPROVIDED",
        • "govt_id_number": "string"
        }
      ],
    • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
    • "birth_date": "string",
    • "email": "string",
    • "first_name": "string",
    • "middle_name": "string",
    • "last_name": "string",
    • "additional_data": {
      • "property1": "string",
      • "property2": "string"
      },
    • "mobile_number": "string",
    • "home_number": "string",
    • "office_number": "string",
    • "base_address": {
      • "city": "string",
      • "country": "str",
      • "address_line1": "string",
      • "address_line2": "string",
      • "postal_code": "string",
      • "state": "string"
      },
    • "mailing_address": {
      • "city": "string",
      • "country": "str",
      • "address_line1": "string",
      • "address_line2": "string",
      • "postal_code": "string",
      • "state": "string"
      },
    • "billing_address": {
      • "city": "string",
      • "country": "str",
      • "address_line1": "string",
      • "address_line2": "string",
      • "postal_code": "string",
      • "state": "string"
      },
    • "nationality": "str",
    • "ip_address": "string",
    • "person_status": "INCOMPLETE",
    • "client_reference_id": "string",
    • "verfication_mode": "string",
    • "verfication_level": "string",
    • "person_forget_mode": "string",
    • "person_forget_mode_date": "string",
    • "market_notification_optin": "string",
    • "market_notification_optin_date": "string",
    • "address_lat": 0,
    • "address_lon": 0,
    • "contact_type": "string",
    • "profile_dd_mode": "string",
    • "request_code": "string",
    • "wallet_id": "string",
    • "title": "string",
    • "mask_govt_id_number": "string",
    • "comments": "string",
    • "jurisdiction_state": "string",
    • "jurisdiction_country": "str",
    • "beneficial_ownership": 100,
    • "person_relations": [
      • {
        • "holder_person_guid": "67b4ee47-03be-4fa4-8a21-68a2b2312803",
        • "related_person_guid": "ad395ead-8b71-46c4-b7c0-1c41ae432595",
        • "person_relationship": "string",
        • "sys_utcinserted": "2019-08-24T14:15:22Z",
        • "sys_utcupdated": "2019-08-24T14:15:22Z"
        }
      ],
    • "mask_account_number": "string",
    • "ledger_balance": 0,
    • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f"
    },
  • "bulk_issuance_type": "FULL",
  • "carrier": "string",
  • "location_name": "string",
  • "iin_brand": "VISA",
  • "revenue_account_guid": "be5859f8-2def-455a-a2d1-a8fb86ef9998"
}
Response samples
application/json
{
  • "package_guid": "bbcfa7f4-7eee-4d1b-9f7d-736ad8949479",
  • "order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
  • "order_status": "string",
  • "person": {
    • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
    • "first_name": "string",
    • "middle_name": "string",
    • "last_name": "string",
    • "mailing_city": "string",
    • "mailing_country": "str",
    • "mailing_address_line1": "string",
    • "address_line2": "string",
    • "postal_code": "string",
    • "state": "string",
    • "location_name": "string",
    • "email_address": "string",
    • "mobile_number": "string",
    • "office_number": "string"
    },
  • "revenue_account_guid": "be5859f8-2def-455a-a2d1-a8fb86ef9998"
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.