Activate Card

Activate a newly issued card. This API must be called in response to an activation request by the cardholder.

Request
Security:
path Parameters
card_proxy
required
string
version
required
string
Request Body schema: application/json
status
string (CardStatus)
Enum: "ACTIVE" "SUSPEND" "LOST" "STOLEN" "CLOSED" "FCLOSED" "PENDING" "DAMAGED" "FORGET"
reason_code
string or null

Optional Additional info to be sent by partner

reason_description
string or null

Optional Additional info to be sent by partner

override_status
boolean

Optional parameter to override card status change rules. Defaults to FALSE, and is ignored for Card Activation event.

Responses
200

Returns the card details

400

Bad request

401

Unauthorized

404

Card not found

500

Server Error

post/api/{version}/cards/{card_proxy}/activate
Request samples
application/json
{
  • "status": "ACTIVE",
  • "reason_code": "string",
  • "reason_description": "string",
  • "override_status": true
}
Response samples
application/json
{
  • "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",
  • "card_tracking_detail": {
    • "fulfillment_house_name": "Arroweye",
    • "card_requested": "0001-01-01T00:00:00",
    • "card_shipment_date": "0001-01-01T00:00:00",
    • "card_delivery_method": "USPS",
    • "card_delivery_tracking_number": "1234365465",
    • "card_package_name": "TestPlacardPkg"
    },
  • "sys_utcinserted": "0001-01-01T00:00:00",
  • "sys_utcupdated": "0001-01-01T00:00:00"
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.