Replace Card

Call this API end point to replace a card, identified by card proxy.

Request
Security:
Bearer
path Parameters
card_proxy
required
string

card proxy

version
required
string
Request Body schema: application/json

replace card request

reason_code
string or null

Reason code to replace card

status
string (ReplaceCardStatus)
Enum: "ACTIVE" "SUSPEND" "LOST" "STOLEN" "PENDING" "DAMAGED"
new_card_proxy
string or null
operation
string (ReplaceCardOperation)
Enum: "REPLACE" "RENEW"
object (ReplaceFulfillmentOrderInfo)
card_months_until_expire
integer or null <int32>

Sets new card's expiration. Adds months from current date.

revenue_account_guid
string or null <uuid>
inventory_manager_guid
string or null <uuid>

This value specifies bulk shipping for replaced or renewed cards. It identifies a person record with the role of inventory_manager, to whom the cards will be shipped. The bulk shipment will be sent to the address associated with this person.

Responses
200

Returns the newly created Card

400

Bad request

401

Unauthorized

404

Card not found

500

Server Error

post/api/{version}/cards/{card_proxy}/replace
Request samples
application/json
{
  • "reason_code": "string",
  • "status": "ACTIVE",
  • "new_card_proxy": "string",
  • "operation": "REPLACE",
  • "replace_fulfillment_order_info": {
    • "package_guid": "bbcfa7f4-7eee-4d1b-9f7d-736ad8949479",
    • "third_line": "string",
    • "fourth_line": "string",
    • "shipping_method": "STDMAIL",
    • "order_type": "DTC",
    • "signature_required": true,
    • "discretionary_track_data": "string",
    • "pin_mailer_flag": true,
    • "message_1": "string",
    • "message_2": "string",
    • "message_3": "string",
    • "message_4": "string",
    • "message_5": "string",
    • "message_6": "string",
    • "message_7": "string",
    • "message_8": "string",
    • "fleet_card": {
      • "assignment_type": "DRIVER",
      • "restriction": "NONE",
      • "product_prompts": "ID_ODOMETER"
      }
    },
  • "card_months_until_expire": 0,
  • "revenue_account_guid": "be5859f8-2def-455a-a2d1-a8fb86ef9998",
  • "inventory_manager_guid": "15383299-9c3b-4e85-8263-0631f6f8890b"
}
Response samples
application/json
{
  • "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"
    },
  • "sys_utcinserted": "2019-08-24T14:15:22Z",
  • "sys_utcupdated": "2019-08-24T14:15:22Z",
  • "FulfillmentOrderInfo": {
    • "package_guid": "bbcfa7f4-7eee-4d1b-9f7d-736ad8949479",
    • "third_line": "string",
    • "fourth_line": "string",
    • "shipping_method": "STDMAIL",
    • "order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
    • "order_type": "DTC",
    • "signature_required": true,
    • "tracking_number": "string",
    • "discretionary_track_data": "string",
    • "order_status": "string",
    • "pin_mailer_flag": true,
    • "message_1": "string",
    • "message_2": "string",
    • "message_3": "string",
    • "message_4": "string",
    • "message_5": "string",
    • "message_6": "string",
    • "message_7": "string",
    • "message_8": "string",
    • "digital_package_guid": "a05ed577-3f52-4584-a35b-7241dbf7341c",
    • "fleet_card": {
      • "assignment_type": "DRIVER",
      • "restriction": "NONE",
      • "product_prompts": "ID_ODOMETER"
      }
    }
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.