Search Cards

Retrieve list of cards based on search criteria. Search based on person_guid, wallet_guid, or program_guid.

Request

Security:

Bearer

path Parameters

version

required

string

query Parameters

person_guid	string <uuid> Person's unique identifier
wallet_guid	string <uuid> Wallet GUID of the person
program_guid	string <uuid> Program unique identifier
card_statuses	Array of strings (CardStatus) List of Card statuses Items Enum: "ACTIVE" "SUSPEND" "LOST" "STOLEN" "CLOSED" "FCLOSED" "PENDING" "DAMAGED" "FORGET"
issuance_types	Array of strings (IssuanceType) List of Card Issuance types Items Enum: "FULL" "VIRTUALONETIME" "VIRTUAL" "VIRTUALTOKENALLOWED" "TOKEN" "ONETIMELOAD" "OTHER"
card_condition	string (CardCondition) Card condition Enum: "ORIGINAL" "REISSUE" "REPLACE" "RENEW"
expiration_date_start	string <date-time> Expiration start date
expiration_date_end	string <date-time> Expiration end date
card_product	string <= 64 characters Card product construct
base_iin	string Base IIN associated to card
card_last4	string <= 4 characters Last 4 digits of the card number
start_index	integer <int32> Start index used for pagination of the results
limit	integer <int32> Limit number of results to retrieve (Will be defaulted to 25 if none specified)

Responses

200

Returns the Card

400

Bad request

401

Unauthorized

500

Server Error

get/api/{version}/cards

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  'https://qvapikeybank.qolopay.com/api/{version}/cards?person_guid=497f6eca-6276-4993-bfeb-53cbbbba6f08&wallet_guid=497f6eca-6276-4993-bfeb-53cbbbba6f08&program_guid=497f6eca-6276-4993-bfeb-53cbbbba6f08&card_statuses=ACTIVE&issuance_types=FULL&card_condition=ORIGINAL&expiration_date_start=2019-08-24T14%3A15%3A22Z&expiration_date_end=2019-08-24T14%3A15%3A22Z&card_product=string&base_iin=string&card_last4=stri&start_index=0&limit=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Response samples

application/json

{"count": 0,
"start_index": 0,
"end_index": 0,
"has_more": true,
"data": [{"card_number": "string",
"card_proxy": "string",
"mask_card_pan": "string",
"wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
"wallet_id": "string",
"issuance_type": "FULL",
"base_iin": "string",
"card_condition": "ORIGINAL",
"card_status": "ACTIVE",
"activation_date": "2019-08-24T14:15:22Z",
"activation_method": "ONLOAD",
"expiration_date": "string",
"cvx2": "string",
"logical_expiration_date": "2019-08-24T14:15:22Z",
"person_card_status": "ACTIVE",
"card_tracking_detail": {"fulfillment_house_name": "string",
"card_requested": "2019-08-24T14:15:22Z",
"card_shipment_date": "2019-08-24T14:15:22Z",
"card_delivery_method": "string",
"card_delivery_tracking_number": "string",
"card_package_name": "string",
"card_order_status": "string",
"digital_package_name": "string",
"digital_package_id": "string"
},
"status_change_nonmon_detail": {"nonmon_guid": "3df16cd2-de7f-4e81-936e-7604855d1fd7",
"txn_date": "2019-08-24T14:15:22Z",
"channel_name": "string",
"request_code": "string",
"reason_code": "string",
"response_code": "string",
"person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
"hash_account_number": "string",
"remarks": "string",
"account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
"journal_guid": "019b8be6-224f-4e54-91ec-2a471754d334",
"support_user_guid": "334ad5b0-1427-4c28-aac8-2d6e9614b4d0",
"source_code": "string",
"source_user_guid": "0aaedba8-146e-40a6-ad5f-54c512699647",
"reference_number": "string",
"outsort_guid": "eef602a5-424d-4eae-b4d8-4521969d8873",
"order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
"processing_start_date": "2019-08-24T14:15:22Z",
"processing_end_date": "2019-08-24T14:15:22Z",
"memo_code": "string"
},
"sys_utcinserted": "2019-08-24T14:15:22Z",
"sys_utcupdated": "2019-08-24T14:15:22Z",
"person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
"supplemental_details": {"invoices": [{"invoice_number": "string",
"invoice_amount": 0,
"invoice_status": "ACTIVE",
"invoice_date": "2019-08-24T14:15:22Z",
"invoice_description": "string",
"payment_due_reference_number": "string",
"payment_due_amount": 0
}
]
},
"memo_code": "string",
"first_name": "string",
"last_name": "string"
}
],
"check_statuses": ["string"
]
}