Replace card by ID

relevant webhooks for this endpoint be sure you have registered docid\ bn5xtgkjogbe ctwomcbs for this webhook cards card replaced docid\ padkatuyio5w0ysaexxwl api reference order a replacement for damaged, lost or stolen cards using this endpoint damaged cards remain active until the cardholder activates the replacement card lost or stolen cards are immediately closed and a replacement card is issued { "name" "endpoint /cardmanagement/v1/cards/{id}/replace", "method" "post", "url" "https //sandbox crbcos com/cardmanagement/v1/cards/{id}/replace", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "hiyb6hxbzbif03ihcjxah", "language" "curl", "code" "curl location globoff 'https //sandbox crbcos com/cardmanagement/v1/cards/{id}/replace?id=8c6a53e0 83ad 4b76 b446 b300006a3e6a' \\\\\n header 'id 8c6a53e0 83ad 4b76 b446 b300006a3e6a' \\\\\n data '{\n \\"replacereason\\" \\"damaged\\",\n \\"nameoncard\\" \\"daly khol\\",\n \\"shippingtype\\" \\"normal\\",\n \\"clientidentifier\\" \\"b06ab5cc 553a 4fe4 ad78 751b5ff81f00\\"\n}'", "customlabel" "" }, { "id" "7ei dvlr b mqrvnrtxfg", "language" "nodejs", "code" "var https = require('follow redirects') https;\nvar fs = require('fs');\n\nvar options = {\n 'method' 'post',\n 'hostname' 'sandbox crbcos com',\n 'path' '/cardmanagement/v1/cards/{id}/replace?id=8c6a53e0 83ad 4b76 b446 b300006a3e6a',\n 'headers' {\n 'id' '8c6a53e0 83ad 4b76 b446 b300006a3e6a'\n },\n 'maxredirects' 20\n};\n\nvar req = https request(options, function (res) {\n var chunks = \[];\n\n res on(\\"data\\", function (chunk) {\n chunks push(chunk);\n });\n\n res on(\\"end\\", function (chunk) {\n var body = buffer concat(chunks);\n console log(body tostring());\n });\n\n res on(\\"error\\", function (error) {\n console error(error);\n });\n});\n\nvar postdata = \\"{\\\r\\\n \\\\\\"replacereason\\\\\\" \\\\\\"damaged\\\\\\",\\\r\\\n \\\\\\"nameoncard\\\\\\" \\\\\\"daly khol\\\\\\",\\\r\\\n \\\\\\"shippingtype\\\\\\" \\\\\\"normal\\\\\\",\\\r\\\n \\\\\\"clientidentifier\\\\\\" \\\\\\"b06ab5cc 553a 4fe4 ad78 751b5ff81f00\\\\\\"\\\r\\\n}\\";\n\nreq write(postdata);\n\nreq end();", "customlabel" "" }, { "id" "tczjabzdzq p8mkr6buen", "language" "python", "code" "import requests\n\nurl = \\"https //sandbox crbcos com/cardmanagement/v1/cards/{id}/replace?id=8c6a53e0 83ad 4b76 b446 b300006a3e6a\\"\n\npayload = \\"{\\\r\\\n \\\\\\"replacereason\\\\\\" \\\\\\"damaged\\\\\\",\\\r\\\n \\\\\\"nameoncard\\\\\\" \\\\\\"daly khol\\\\\\",\\\r\\\n \\\\\\"shippingtype\\\\\\" \\\\\\"normal\\\\\\",\\\r\\\n \\\\\\"clientidentifier\\\\\\" \\\\\\"b06ab5cc 553a 4fe4 ad78 751b5ff81f00\\\\\\"\\\r\\\n}\\"\nheaders = {\n 'id' '8c6a53e0 83ad 4b76 b446 b300006a3e6a'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "uuxnvvgfhszcz9 fc fs5", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/cardmanagement/v1/cards/{id}/replace?id=8c6a53e0 83ad 4b76 b446 b300006a3e6a\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"id\\"] = \\"8c6a53e0 83ad 4b76 b446 b300006a3e6a\\"\nrequest body = \\"{\\\r\\\n \\\\\\"replacereason\\\\\\" \\\\\\"damaged\\\\\\",\\\r\\\n \\\\\\"nameoncard\\\\\\" \\\\\\"daly khol\\\\\\",\\\r\\\n \\\\\\"shippingtype\\\\\\" \\\\\\"normal\\\\\\",\\\r\\\n \\\\\\"clientidentifier\\\\\\" \\\\\\"b06ab5cc 553a 4fe4 ad78 751b5ff81f00\\\\\\"\\\r\\\n}\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" }, { "id" "ggaurwwolb0vkdvtxvreb", "language" "go", "code" "package main\n\nimport (\n \\"fmt\\"\n \\"strings\\"\n \\"net/http\"\n \\"io\\"\n)\n\nfunc main() {\n\n url = \\"https //sandbox crbcos com/cardmanagement/v1/cards/{id}/replace?id=8c6a53e0 83ad 4b76 b446 b300006a3e6a\\"\n method = \\"post\\"\n\n payload = strings newreader(`{`+\\"\n\\"+`\n \\"replacereason\\" \\"damaged\\",`+\\"\n\\"+`\n \\"nameoncard\\" \\"daly khol\\",`+\\"\n\\"+`\n \\"shippingtype\\" \\"normal\\",`+\\"\n\\"+`\n \\"clientidentifier\\" \\"b06ab5cc 553a 4fe4 ad78 751b5ff81f00\\"`+\\"\n\\"+`\n}`)\n\n client = \&http client {\n }\n req, err = http newrequest(method, url, payload)\n\n if err != nil {\n fmt println(err)\n return\n }\n req header add(\\"id\\", \\"8c6a53e0 83ad 4b76 b446 b300006a3e6a\\")\n\n res, err = client do(req)\n if err != nil {\n fmt println(err)\n return\n }\n defer res body close()\n\n body, err = io readall(res body)\n if err != nil {\n fmt println(err)\n return\n }\n fmt println(string(body))\n}", "customlabel" "" } ], "selectedlanguageid" "hiyb6hxbzbif03ihcjxah" }, "results" { "languages" \[ { "id" "kcrcuayhepl8dhvegmp34", "language" "200", "code" "{\n \\"id\\" \\"1c243431 23b8 407c afa4 b30000abbe0d\\",\n \\"productid\\" \\"57146944 b145 4326 884d b2f700ecf688\\",\n \\"partnerid\\" \\"19222b81 0e1e 452d a842 b2f1011c16f3\\",\n \\"accountnumber\\" \\"158560897007\\",\n \\"status\\" \\"unactivated\\",\n \\"statusreasoncode\\" \\"notset\\",\n \\"firstname\\" \\"daly\\",\n \\"lastname\\" \\"khol\\",\n \\"shippingaddress\\" {\n \\"street1\\" \\"1 roshar ave\\",\n \\"city\\" \\"roshar\\",\n \\"state\\" \\"ny\\",\n \\"postalcode\\" \\"10001\\",\n \\"countrycode\\" \\"us\\"\n },\n \\"billingaddress\\" {\n \\"street1\\" \\"1 roshar ave\\",\n \\"city\\" \\"roshar\\",\n \\"state\\" \\"ny\\",\n \\"postalcode\\" \\"10001\\",\n \\"countrycode\\" \\"us\\"\n },\n \\"phone\\" {\n \\"phonetype\\" \\"home\\",\n \\"phonenumber\\" \\"7185551234\\"\n },\n \\"emailaddress\\" \\"dkhol\@gmail com\\",\n \\"nameoncard\\" \\"daly khol\\",\n \\"previouscardid\\" \\"8c6a53e0 83ad 4b76 b446 b300006a3e6a\\",\n \\"ispinset\\" false,\n \\"adminblocked\\" false,\n \\"fraudsuspect\\" false,\n \\"configurationid\\" \\"b2251a28 c218 4e2e a787 b2f700ef0ecd\\",\n \\"category\\" \\"debit\\",\n \\"paymentinstrument\\" \\"physicalcombo\\",\n \\"processor\\" \\"p1\\",\n \\"shippingtype\\" \\"normal\\",\n \\"orderstatus\\" \\"orderpending\\",\n \\"replacementstatus\\" \\"notapplicable\\",\n \\"customerid\\" \\"e2599a17 d1e2 476c 9672 b2ff008fa575\\",\n \\"clientidentifier\\" \\"b06ab5cc 553a 4fe4 ad78 751b5ff81f00\\",\n \\"createdat\\" \\"2025 06 18t06 25 17 6960428 04 00\\",\n \\"lastmodifiedat\\" \\"2025 06 18t06 25 17 6960428 04 00\\"\n}", "customlabel" "" } ], "selectedlanguageid" "kcrcuayhepl8dhvegmp34" }, "request" { "pathparameters" \[ { "name" "id", "kind" "required", "type" "string", "description" "guid format card id in the cross river system, which is the id attribute value of the response to create a card this is not the number that appears on the card ", "" "required" }, { "name" "request", "kind" "required", "type" "object", "description" "array containing details about the request to replace the card ", "" "array containing details about the request to replace the card ", "children" \[ { "name" "replacereason", "kind" "required", "type" "string", "description" "reason can be \n damaged\n lost\n fraudcompromised\n returned\n expired\n stolen" }, { "name" "nameoncard", "kind" "required", "type" "string", "description" "full cardholder name as written on card" }, { "name" "shippingtype", "kind" "required", "type" "string", "description" "values can be \n normal\n expedited" }, { "name" "clientidentifier", "kind" "optional", "type" "string", "description" "use this attribute to add your own unique identifying string to a payment call or cos record this attribute is useful for idempotency purposes \n50 characters maximum " }, { "name" "carddesignid", "kind" "optional", "type" "string", "description" "maximum length of 36 " } ], "schema" \[ { "name" "replacereason", "kind" "required", "type" "string", "description" "reason can be \n damaged\n lost\n fraudcompromised\n returned\n expired\n stolen" }, { "name" "nameoncard", "kind" "required", "type" "string", "description" "full cardholder name as written on card" }, { "name" "shippingtype", "kind" "required", "type" "string", "description" "values can be \n normal\n expedited" }, { "name" "clientidentifier", "kind" "optional", "type" "string", "description" "use this attribute to add your own unique identifying string to a payment call or cos record this attribute is useful for idempotency purposes \n50 characters maximum " }, { "name" "carddesignid", "kind" "optional", "type" "string", "description" "maximum length of 36 " } ] } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" }, "response" \[ { "name" "id", "kind" "optional", "type" "string", "description" "guid format card id in the cross river system, which is the id attribute value of the response to create a card this is not the number that appears on the card " }, { "name" "productid", "kind" "optional", "type" "string", "description" "product id of the cardholder deposit account this id is in the guid format ", "children" \[] }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "your unique id in the cross river system this id is in guid format ", "children" \[] }, { "name" "processorcardid", "kind" "optional", "type" "string", "description" "card processor's unique identifier", "children" \[] }, { "name" "accountnumber", "kind" "optional", "type" "string", "description" "deposit account number associated with the card", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" "card activation status \n\n unactivated\n active\n suspended\n closed", "children" \[] }, { "name" "statusreasoncode", "kind" "optional", "type" "string", "description" "reason for the card status \n notset\n damaged\n expired\n lost\n fraudcompromised\n return\n newenrollment\n stolen\n adminblocked\n fraudblocked", "children" \[] }, { "name" "processorcardstatus", "kind" "optional", "type" "string", "description" "status of the card in the processor's system", "children" \[] }, { "name" "firstname", "kind" "optional", "type" "string", "description" "cardholder first name", "children" \[] }, { "name" "middlename", "kind" "optional", "type" "string", "description" "cardholder middle name", "children" \[] }, { "name" "lastname", "kind" "optional", "type" "string", "description" "cardholder last name", "children" \[] }, { "name" "suffix", "kind" "optional", "type" "string", "description" "cardholder name suffix", "children" \[] }, { "name" "birthdate", "kind" "optional", "type" "string", "description" "cardholder birthdate", "children" \[] }, { "name" "shippingaddress", "kind" "optional", "type" "object", "description" "address where a physical card is sent", "children" \[ { "name" "street1", "kind" "optional", "type" "string", "description" "primary location details of cardholder this needs to be a street name and house or building number do not enter a po box do not use any punctuation 60 characters maximum " }, { "name" "street2", "kind" "optional", "type" "string", "description" "additional field for address information" }, { "name" "city ", "kind" "optional", "type" "string", "description" "name of the cardholder's city" }, { "name" "state", "kind" "optional", "type" "string", "description" "cardholder's 2 character state code" }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "cardholder's us postal (zip) code" }, { "name" "countrycode", "kind" "optional", "type" "string", "description" "cardholder 2 character iso country code" } ] }, { "name" "billingaddress", "kind" "optional", "type" "object", "description" "address where the credit card bills are sent", "children" \[ { "name" "street1", "kind" "optional", "type" "string", "description" "primary location details of cardholder this needs to be a street name and house or building number do not enter a po box do not use any punctuation 60 characters maximum " }, { "name" "street2", "kind" "optional", "type" "string", "description" "additional field for address information" }, { "name" "city", "kind" "optional", "type" "string", "description" "name of the cardholder's city" }, { "name" "state", "kind" "optional", "type" "string", "description" "cardholder's 2 character state code" }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "cardholder's us postal (zip) code" }, { "name" "countrycode", "kind" "optional", "type" "string", "description" "cardholder 2 character iso country code" } ] }, { "name" "phone", "kind" "optional", "type" "object", "description" "information about the cardholder's phone (type and number)", "children" \[ { "name" "phonetype", "kind" "optional", "type" "string", "description" "phone number is for \n home\n mobile\n work" }, { "name" "phonenumber", "kind" "optional", "type" "string", "description" "cardholder phone number 10 15 digits, no spaces or other characters " } ] }, { "name" "emailaddress", "kind" "optional", "type" "string", "description" "cardholder email address", "children" \[] }, { "name" "nameoncard", "kind" "optional", "type" "string", "description" "full cardholder name as written on card", "children" \[] }, { "name" "companynameoncard", "kind" "optional", "type" "string", "description" "if defined, the name of the cardholder company", "children" \[] }, { "name" "panlastfour", "kind" "optional", "type" "string", "description" "last 4 digits of the pan, the primary account number, which appears on the physical card", "children" \[] }, { "name" "previouscardid", "kind" "optional", "type" "string", "description" "id of the previous card if the current card is a replacement", "children" \[] }, { "name" "ispinset", "kind" "optional", "type" "boolean", "description" "true if the pin number is set for the card, otherwise false ", "children" \[] }, { "name" "expirationdate", "kind" "optional", "type" "string", "description" "card expiration date format yyyy mm dd", "children" \[] }, { "name" "adminblocked", "kind" "optional", "type" "boolean", "description" "true if the card has been blocked by the administrator, otherwise false this block cannot be removed ", "children" \[] }, { "name" "fraudsuspect", "kind" "optional", "type" "boolean", "description" "true, if the card was blocked by the processor due to potential fraud, otherwise false ", "children" \[] }, { "name" "configurationid", "kind" "optional", "type" "string", "description" "unique id for the card configuration profile the card is based on you get this id from cross river this id is in guid format ", "children" \[] }, { "name" "category", "kind" "optional", "type" "string", "description" "type of card \n debit\n credit\n prepaid", "children" \[] }, { "name" "paymentinstrument", "kind" "optional", "type" "string", "description" "card payment instrument type \n physicalmsr\n physicalicc\n physicalcontactless\n physicalcombo\n virtualpan", "children" \[] }, { "name" "processor", "kind" "optional", "type" "string", "description" "the name of the card processor \n i2c\n p1", "children" \[] }, { "name" "shippingtype", "kind" "optional", "type" "string", "description" "how the card is shipped \n normal\n expedited", "children" \[] }, { "name" "orderstatus", "kind" "optional", "type" "string", "description" "status of the card order \n orderpending (0)\n completed (1)\n failed (2)\n authorizing (3)\n authorizationfailed (4)\n authorizationcompleted (5)", "children" \[] }, { "name" "replacementstatus", "kind" "optional", "type" "string", "description" "indicates whether the card is a replacement card and the status of the replacement \n notapplicable\n pending\n completed\n failed", "children" \[] }, { "name" "customerid", "kind" "optional", "type" "string", "description" "the unique cross river id assigned to a customer when the customer record is created you need this id to take action for a specific customer for example, when opening an account or adding an address to a customer record \nthe id is in guid format ", "children" \[] }, { "name" "clientidentifier", "kind" "optional", "type" "string", "description" "use this attribute to add your own unique identifying string to a payment call or cos record this attribute is useful for idempotency purposes ", "children" \[] }, { "name" "processorcustomerid", "kind" "optional", "type" "string", "description" "processor's unique id for the cardholder", "children" \[] }, { "name" "createdat", "kind" "optional", "type" "string", "description" "date and time when the card was created in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "suspendedat", "kind" "optional", "type" "string", "description" "date and time when the card was suspended if not suspended, null in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "closedat", "kind" "optional", "type" "string", "description" "date and time the card was closed if not closed, null in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "initialactivation", "kind" "optional", "type" "string", "description" "date the card was activated the time is set to midnight at the start of that day ", "children" \[] }, { "name" "activatedat", "kind" "optional", "type" "string", "description" "exact date and time the card was activated in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "openedat", "kind" "optional", "type" "string", "description" "null", "children" \[] }, { "name" "lastmodifiedat", "kind" "optional", "type" "string", "description" "internal cross river value date and time the database entry was last modified in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] } ], "hastryitout" false, "autogeneratedanchorslug" "endpoint cardmanagementv1cardsidreplace", "legacyhash" "x sphgtvjw6sa3mdft10" }