Create Card

Create a person and a card. If the person is already created, send an existing Person GUID without sending the person details.

Request
Security:
path Parameters
version
required
string
Request Body schema: application/json
required
object (PersonDTO)
wallet_guid
string <uuid>

Wallet GUID of the person, if the person is already created, and the wallet has to be specified where the new card is to be created. Can be skipped for a new person.

program_guid
required
string <uuid>

Program unique identifier.

months_until_expire
integer <int64>

Number of months when card will expire. Can be skipped if the expiry months is configured for the program as part of program setup.

object (CardFulfillment)

Data related to the fulfillment/embossing file.

wallet_name
string or null

Name of the Wallet.

account_name
string or null

Name of the Account.

inventory_manager_guid
string or null <uuid>

The Inventory Manager person to bulk send created cards to. Passing this guid adds the card to a bulk personalized fulfillment order.

revenue_account_guid
string or null <uuid>

If shipping fees are applied this the account that the fee revenue funds are to be collected in.

Responses
201

Returns the newly created Card

400

Bad request

401

Unauthorized

404

Program not found

500

Server Error

post/api/{version}/cards
Request samples
application/json
{
  • "person": {
    • "person_guid": "00000000-0000-0000-0000-000000000000",
    • "birth_date": "1975-02-28",
    • "email": "john.smith@example.com",
    • "first_name": "John",
    • "last_name": "Smith",
    • "mobile_number": "+19540123456",
    • "base_address": {
      • "city": "Fort Lauderdale",
      • "country": "USA",
      • "address_line1": "222333 Sample road",
      • "postal_code": "33309",
      • "state": "FL"
      },
    • "client_reference_id": "OM39125",
    • "address_lat": 0,
    • "address_lon": 0,
    • "ledger_balance": 0
    },
  • "wallet_guid": "00000000-0000-0000-0000-000000000000",
  • "program_guid": "bb6e9a04-ca42-4f32-b149-ad39ab3aa079",
  • "months_until_expire": 0
}
Response samples
application/json
{
  • "person": {
    • "person_guid": "00000000-0000-0000-0000-000000000000",
    • "birth_date": "1975-02-28",
    • "email": "john.smith@example.com",
    • "first_name": "John",
    • "last_name": "Smith",
    • "mobile_number": "+19540123456",
    • "base_address": {
      • "city": "Fort Lauderdale",
      • "country": "USA",
      • "address_line1": "222333 Sample road",
      • "postal_code": "33309",
      • "state": "FL"
      },
    • "client_reference_id": "OM39125",
    • "address_lat": 0,
    • "address_lon": 0,
    • "ledger_balance": 0
    },
  • "program_guid": "bb6e9a04-ca42-4f32-b149-ad39ab3aa079",
  • "card": {
    • "card_number": "5340920000000007",
    • "card_proxy": "cproxy0000000000001",
    • "mask_card_pan": "534092XXXXXX0007",
    • "wallet_guid": "05a28e5a-01a6-4a3e-8ce3-ca30fc09e5ae",
    • "issuance_type": "FULL",
    • "card_condition": "ORIGINAL",
    • "card_status": "PENDING",
    • "activation_method": "ONLOAD",
    • "expiration_date": "2212",
    • "logical_expiration_date": "0001-01-01T00:00:00",
    • "person_card_status": "ACTIVE",
    • "sys_utcinserted": "0001-01-01T00:00:00",
    • "sys_utcupdated": "0001-01-01T00:00:00"
    },
  • "fulfillment_data": { }
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.