Create new card

relevant webhooks for this endpoint be sure you have registered docid\ bn5xtgkjogbe ctwomcbs for this webhook cards card created docid\ padkatuyio5w0ysaexxwl api reference to create a card, you must supply a valid deposit account number along with other card specific information the initial card status of a newly submitted card is unactivated when the card is successfully created the order status is orderpending { "name" "endpoint /cardmanagement/v1/cards", "method" "post", "url" "https //sandbox crbcos com/cardmanagement/v1/cards", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "hiyb6hxbzbif03ihcjxah", "language" "curl", "code" "curl location 'https //sandbox crbcos com/cardmanagement/v1/cards' \\\\\n header 'idempotency key b06ab5cc 553a 4fe4 ad78 751b5ff81f0e' \\\\\n data raw '{\n \\"accountnumber\\" \\"158560897007\\",\n \\"customerid\\" \\"e2599a17 d1e2 476c 9672 b2ff008fa575\\",\n \\"configurationid\\" \\"b2251a28 c218 4e2e a787 b2f700ef0ecd\\",\n \\"firstname\\" \\"daly\\",\n \\"lastname\\" \\"khol\\",\n \\"phone\\" {\n \\"phonetype\\" \\"home\\",\n \\"phonenumber\\" \\"7185551234\\"\n },\n \\"emailaddress\\" \\"dkhol\@gmail com\\",\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 \\"nameoncard\\" \\"daly khol\\",\n \\"shippingtype\\" \\"normal\\",\n \\"clientidentifier\\" \\"b06ab5cc 553a 4fe4 ad78 751b5ff81f00\\"\n}", "customlabel" "" }, { "id" "nchn8pasf2mjxbfwkb0y4", "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',\n 'headers' {\n 'idempotency key' 'b06ab5cc 553a 4fe4 ad78 751b5ff81f0e'\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 \\\\\\"accountnumber\\\\\\" \\\\\\"158560897007\\\\\\",\\\r\\\n \\\\\\"customerid\\\\\\" \\\\\\"e2599a17 d1e2 476c 9672 b2ff008fa575\\\\\\",\\\r\\\n \\\\\\"configurationid\\\\\\" \\\\\\"b2251a28 c218 4e2e a787 b2f700ef0ecd\\\\\\",\\\r\\\n \\\\\\"firstname\\\\\\" \\\\\\"daly\\\\\\",\\\r\\\n \\\\\\"lastname\\\\\\" \\\\\\"khol\\\\\\",\\\r\\\n \\\\\\"phone\\\\\\" {\\\r\\\n \\\\\\"phonetype\\\\\\" \\\\\\"home\\\\\\",\\\r\\\n \\\\\\"phonenumber\\\\\\" \\\\\\"7185551234\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"emailaddress\\\\\\" \\\\\\"dkhol\@gmail com\\\\\\",\\\r\\\n \\\\\\"shippingaddress\\\\\\" {\\\r\\\n \\\\\\"street1\\\\\\" \\\\\\"1 roshar ave\\\\\\",\\\r\\\n \\\\\\"city\\\\\\" \\\\\\"roshar\\\\\\",\\\r\\\n \\\\\\"state\\\\\\" \\\\\\"ny\\\\\\",\\\r\\\n \\\\\\"postalcode\\\\\\" \\\\\\"10001\\\\\\",\\\r\\\n \\\\\\"countrycode\\\\\\" \\\\\\"us\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"billingaddress\\\\\\" {\\\r\\\n \\\\\\"street1\\\\\\" \\\\\\"1 roshar ave\\\\\\",\\\r\\\n \\\\\\"city\\\\\\" \\\\\\"roshar\\\\\\",\\\r\\\n \\\\\\"state\\\\\\" \\\\\\"ny\\\\\\",\\\r\\\n \\\\\\"postalcode\\\\\\" \\\\\\"10001\\\\\\",\\\r\\\n \\\\\\"countrycode\\\\\\" \\\\\\"us\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"nameoncard\\\\\\" \\\\\\"daly khol\\\\\\",\\\r\\\n \\\\\\"shippingtype\\\\\\" \\\\\\"normal\\\\\\",\\\r\\\n \\\\\\"clientidentifier\\\\\\" \\\\\\"b06ab5cc 553a 4fe4 ad78 751b5ff81f00\\\\\\"\\\r\\\n}\\\r\\\n\\\r\\\n\\";\n \nreq write(postdata);\n \nreq end();", "customlabel" "" }, { "id" "3rq2tay2mrme1s3oyiro8", "language" "python", "code" "import requests\n \nurl = \\"https //sandbox crbcos com/cardmanagement/v1/cards\\"\n \npayload = \\"{\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"158560897007\\\\\\",\\\r\\\n \\\\\\"customerid\\\\\\" \\\\\\"e2599a17 d1e2 476c 9672 b2ff008fa575\\\\\\",\\\r\\\n \\\\\\"configurationid\\\\\\" \\\\\\"b2251a28 c218 4e2e a787 b2f700ef0ecd\\\\\\",\\\r\\\n \\\\\\"firstname\\\\\\" \\\\\\"daly\\\\\\",\\\r\\\n \\\\\\"lastname\\\\\\" \\\\\\"khol\\\\\\",\\\r\\\n \\\\\\"phone\\\\\\" {\\\r\\\n \\\\\\"phonetype\\\\\\" \\\\\\"home\\\\\\",\\\r\\\n \\\\\\"phonenumber\\\\\\" \\\\\\"7185551234\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"emailaddress\\\\\\" \\\\\\"dkhol\@gmail com\\\\\\",\\\r\\\n \\\\\\"shippingaddress\\\\\\" {\\\r\\\n \\\\\\"street1\\\\\\" \\\\\\"1 roshar ave\\\\\\",\\\r\\\n \\\\\\"city\\\\\\" \\\\\\"roshar\\\\\\",\\\r\\\n \\\\\\"state\\\\\\" \\\\\\"ny\\\\\\",\\\r\\\n \\\\\\"postalcode\\\\\\" \\\\\\"10001\\\\\\",\\\r\\\n \\\\\\"countrycode\\\\\\" \\\\\\"us\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"billingaddress\\\\\\" {\\\r\\\n \\\\\\"street1\\\\\\" \\\\\\"1 roshar ave\\\\\\",\\\r\\\n \\\\\\"city\\\\\\" \\\\\\"roshar\\\\\\",\\\r\\\n \\\\\\"state\\\\\\" \\\\\\"ny\\\\\\",\\\r\\\n \\\\\\"postalcode\\\\\\" \\\\\\"10001\\\\\\",\\\r\\\n \\\\\\"countrycode\\\\\\" \\\\\\"us\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"nameoncard\\\\\\" \\\\\\"daly khol\\\\\\",\\\r\\\n \\\\\\"shippingtype\\\\\\" \\\\\\"normal\\\\\\",\\\r\\\n \\\\\\"clientidentifier\\\\\\" \\\\\\"b06ab5cc 553a 4fe4 ad78 751b5ff81f00\\\\\\"\\\r\\\n}\\\r\\\n\\\r\\\n\\"\nheaders = {\n 'idempotency key' 'b06ab5cc 553a 4fe4 ad78 751b5ff81f0e'\n}\n \nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n \nprint(response text)", "customlabel" "" }, { "id" "mdax0c0lkbripliydwfke", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n \nurl = uri(\\"https //sandbox crbcos com/cardmanagement/v1/cards\\")\n \nhttps = net http new(url host, url port)\nhttps use ssl = true\n \nrequest = net http post new(url)\nrequest\[\\"idempotency key\\"] = \\"b06ab5cc 553a 4fe4 ad78 751b5ff81f0e\\"\nrequest body = \\"{\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"158560897007\\\\\\",\\\r\\\n \\\\\\"customerid\\\\\\" \\\\\\"e2599a17 d1e2 476c 9672 b2ff008fa575\\\\\\",\\\r\\\n \\\\\\"configurationid\\\\\\" \\\\\\"b2251a28 c218 4e2e a787 b2f700ef0ecd\\\\\\",\\\r\\\n \\\\\\"firstname\\\\\\" \\\\\\"daly\\\\\\",\\\r\\\n \\\\\\"lastname\\\\\\" \\\\\\"khol\\\\\\",\\\r\\\n \\\\\\"phone\\\\\\" {\\\r\\\n \\\\\\"phonetype\\\\\\" \\\\\\"home\\\\\\",\\\r\\\n \\\\\\"phonenumber\\\\\\" \\\\\\"7185551234\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"emailaddress\\\\\\" \\\\\\"dkhol\@gmail com\\\\\\",\\\r\\\n \\\\\\"shippingaddress\\\\\\" {\\\r\\\n \\\\\\"street1\\\\\\" \\\\\\"1 roshar ave\\\\\\",\\\r\\\n \\\\\\"city\\\\\\" \\\\\\"roshar\\\\\\",\\\r\\\n \\\\\\"state\\\\\\" \\\\\\"ny\\\\\\",\\\r\\\n \\\\\\"postalcode\\\\\\" \\\\\\"10001\\\\\\",\\\r\\\n \\\\\\"countrycode\\\\\\" \\\\\\"us\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"billingaddress\\\\\\" {\\\r\\\n \\\\\\"street1\\\\\\" \\\\\\"1 roshar ave\\\\\\",\\\r\\\n \\\\\\"city\\\\\\" \\\\\\"roshar\\\\\\",\\\r\\\n \\\\\\"state\\\\\\" \\\\\\"ny\\\\\\",\\\r\\\n \\\\\\"postalcode\\\\\\" \\\\\\"10001\\\\\\",\\\r\\\n \\\\\\"countrycode\\\\\\" \\\\\\"us\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"nameoncard\\\\\\" \\\\\\"daly khol\\\\\\",\\\r\\\n \\\\\\"shippingtype\\\\\\" \\\\\\"normal\\\\\\",\\\r\\\n \\\\\\"clientidentifier\\\\\\" \\\\\\"b06ab5cc 553a 4fe4 ad78 751b5ff81f00\\\\\\"\\\r\\\n}\\\r\\\n\\\r\\\n\\"\n \nresponse = https request(request)\nputs response read body", "customlabel" "" }, { "id" "k qjegnqwf13ivu2jxigc", "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\\"\n method = \\"post\\"\n \n payload = strings newreader(`{`+\\" \\"+`\n \\"accountnumber\\" \\"158560897007\\",`+\\" \\"+`\n \\"customerid\\" \\"e2599a17 d1e2 476c 9672 b2ff008fa575\\",`+\\" \\"+`\n \\"configurationid\\" \\"b2251a28 c218 4e2e a787 b2f700ef0ecd\\",`+\\" \\"+`\n \\"firstname\\" \\"daly\\",`+\\" \\"+`\n \\"lastname\\" \\"khol\\",`+\\" \\"+`\n \\"phone\\" {`+\\" \\"+`\n \\"phonetype\\" \\"home\\",`+\\" \\"+`\n \\"phonenumber\\" \\"7185551234\\"`+\\" \\"+`\n },`+\\" \\"+`\n \\"emailaddress\\" \\"dkhol\@gmail com\\",`+\\" \\"+`\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 \\"nameoncard\\" \\"daly khol\\",`+\\" \\"+`\n \\"shippingtype\\" \\"normal\\",`+\\" \\"+`\n \\"clientidentifier\\" \\"b06ab5cc 553a 4fe4 ad78 751b5ff81f00\\"`+\\" \\"+`\n}`+\\" \\"+`\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(\\"idempotency key\\", \\"b06ab5cc 553a 4fe4 ad78 751b5ff81f0e\\")\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\\" \\"8c6a53e0 83ad 4b76 b446 b300006a3e6a\\",\n \\"productid\\" \\"57146944 b145 4326 884d b2f700ecf688\\",\n \\"partnerid\\" \\"19222b81 0e1e 452d a842 b2f1011c16f3\\",\n \\"accountnumber\\" \\"158560897007\\",\n \\"status\\" \\"unactivated\\",\n \\"statusreasoncode\\" \\"notset\\",\n \\"processorcardstatus\\" \\"i\\",\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 \\"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 18t02 26 49 6169047 04 00\\",\n \\"lastmodifiedat\\" \\"2025 06 18t02 26 49 6169047 04 00\\"\n}", "customlabel" "" } ], "selectedlanguageid" "kcrcuayhepl8dhvegmp34" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "accountnumber", "kind" "required", "type" "string", "description" "cardholder's deposit account number", "" "cardholder's deposit account number" }, { "name" "customerid", "kind" "required", "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 ", "" "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 " }, { "name" "configurationid", "kind" "required", "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 ", "" "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 " }, { "name" "firstname", "kind" "required", "type" "string", "description" "cardholder first name \n60 characters maximum ", "" "cardholder first name \n60 characters maximum " }, { "name" "middlename", "kind" "optional", "type" "string", "description" "cardholder middle name \n60 characters maximum ", "" "cardholder middle name \n60 characters maximum " }, { "name" "lastname", "kind" "required", "type" "string", "description" "cardholder last name \n60 characters maximum ", "" "cardholder last name \n60 characters maximum " }, { "name" "suffix", "kind" "optional", "type" "string", "description" "cardholder name suffix \n60 characters maximum ", "" "cardholder name suffix \n60 characters maximum " }, { "name" "phone", "kind" "optional", "type" "object", "description" "details of the cardholder phone contact information", "children" \[ { "name" "phonetype", "kind" "required", "type" "string", "description" "phone number is for \n home\n mobile\n work" }, { "name" "phonenumber", "kind" "required", "type" "string", "description" "cardholder phone number 10 15 digits, no spaces or other characters " } ] }, { "name" "emailaddress", "kind" "optional", "type" "string", "description" "cardholder email address \n60 characters maximum ", "" "cardholder email address \n60 characters maximum " }, { "name" "shippingaddress", "kind" "required", "type" "object", "description" "address to which a physical card is shipped", "children" \[ { "name" "street1", "kind" "required", "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 \n60 characters maximum" }, { "name" "city", "kind" "required", "type" "string", "description" "name of the cardholder's city \n60 characters maximum " }, { "name" "state", "kind" "required", "type" "string", "description" "cardholder's 2 character state code" }, { "name" "postalcode", "kind" "required", "type" "string", "description" "cardholder's us postal (zip) code \n10 characters maximum " }, { "name" "countrycode", "kind" "required", "type" "string", "description" "cardholder 2 character iso country code" } ], "schema" \[ { "name" "street1", "kind" "required", "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 \n60 characters maximum" }, { "name" "city", "kind" "required", "type" "string", "description" "name of the cardholder's city \n60 characters maximum " }, { "name" "state", "kind" "required", "type" "string", "description" "cardholder's 2 character state code" }, { "name" "postalcode", "kind" "required", "type" "string", "description" "cardholder's us postal (zip) code \n10 characters maximum " }, { "name" "countrycode", "kind" "required", "type" "string", "description" "cardholder 2 character iso country code" } ] }, { "name" "billingaddress", "kind" "required", "type" "object", "description" "address to send credit card bills", "children" \[ { "name" "street1", "kind" "required", "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 \n60 characters maximum " }, { "name" "street2", "kind" "optional", "type" "string", "description" "additional field for address information\n\n60 characters maximum" }, { "name" "city", "kind" "required", "type" "string", "description" "name of the cardholder's city\n\n60 characters maximum" }, { "name" "state", "kind" "required", "type" "string", "description" "cardholder's 2 character state code" }, { "name" "postalcode", "kind" "required", "type" "string", "description" "cardholder's us postal (zip) code" }, { "name" "countrycode", "kind" "required", "type" "string", "description" "cardholder 2 character iso country code" } ], "schema" \[ { "name" "street1", "kind" "required", "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 \n60 characters maximum " }, { "name" "street2", "kind" "optional", "type" "string", "description" "additional field for address information\n\n60 characters maximum" }, { "name" "city", "kind" "required", "type" "string", "description" "name of the cardholder's city\n\n60 characters maximum" }, { "name" "state", "kind" "required", "type" "string", "description" "cardholder's 2 character state code" }, { "name" "postalcode", "kind" "required", "type" "string", "description" "cardholder's us postal (zip) code" }, { "name" "countrycode", "kind" "required", "type" "string", "description" "cardholder 2 character iso country code" } ] }, { "name" "nameoncard", "kind" "required", "type" "string", "description" "cardholder name as it appears on the card \n23 characters maximum ", "" "cardholder name as it appears on the card \n23 characters maximum " }, { "name" "companynameoncard", "kind" "optional", "type" "string", "description" "if the card is connected to a business account, the cardholder company name \n23 characters maximum ", "" "if the card is connected to a business account, the cardholder company name \n23 characters maximum " }, { "name" "shippingtype", "kind" "required", "type" "string", "description" "how the card is shipped \n normal\n expedited", "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 \n50 characters maximum ", "" "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" "identifier associated to the card design to use when overriding a program's default card design", "" "identifier associated to the card design to use when overriding a program's default card design" } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "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 see also here ", "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\n notset\n damaged\n expired\n lost\n fraudcompromised\n return\n newenrollment\n stolen\n adminblocked", "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\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 riverid 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 \n50 characters maximum ", "children" \[] }, { "name" "processorcustomerid", "kind" "optional", "type" "string", "description" "processor's unique id for the cardholder", "children" \[] }, { "name" "carddesignid", "kind" "optional", "type" "string", "description" "identifier associated to the card design to use when overriding a program's default card design", "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 cardmanagementv1cards", "legacyhash" "x sphgtvjw6sa3mdft10" }