Required fields list

api reference returns the country specific fields you need to submit when requesting a quote the attributes in the response are required for the quote with the parameters defined in the request for this call (except where indicated in the table below) the values provided describe the required responses for example, for lastname the value is ^ {1,255} , indicating that the regular expression characters are permitted, up to 255 characters maximum the bankcountrycode is fr , as provided in the request { "name" "endpoint /international/v1/meta/quote requirements", "method" "get", "url" "https //sandbox crbcos com/international/v1/meta/quote requirements", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "g8ia4wm6rtqr4l9fpzqg1", "language" "curl", "code" "curl location 'https //sandbox crbcos com/international/v1/meta/quote requirements?filter currency=gbp\&filter beneficiarycountrycode=us\&filter bankcountrycode=gb\&filter entitytype=individual' \\\\\n data ''", "customlabel" "" }, { "id" " ns1988xpop5y9nnpymdc", "language" "nodejs", "code" "var https = require('follow redirects') https;\nvar fs = require('fs');\n\nvar options = {\n 'method' 'get',\n 'hostname' 'sandbox crbcos com',\n 'path' '/international/v1/meta/quote requirements?filter currency=gbp\&filter beneficiarycountrycode=us\&filter bankcountrycode=gb\&filter entitytype=individual',\n 'headers' {\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\nreq end();", "customlabel" "" }, { "id" "0j3s7fzehk4jhp8cfmid4", "language" "python", "code" "import requests\n\nurl = \\"https //sandbox crbcos com/international/v1/meta/quote requirements?filter currency=gbp\&filter beneficiarycountrycode=us\&filter bankcountrycode=gb\&filter entitytype=individual\\"\n\npayload = \\"\\"\nheaders = {}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "fqwhv7lt4ufgfm8lsqcaa", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/international/v1/meta/quote requirements?filter currency=gbp\&filter beneficiarycountrycode=us\&filter bankcountrycode=gb\&filter entitytype=individual\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" }, { "id" "wktnnwt wud99yhiodl2b", "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/international/v1/meta/quote requirements?filter currency=gbp\&filter beneficiarycountrycode=us\&filter bankcountrycode=gb\&filter entitytype=individual\\"\n method = \\"get\\"\n\n payload = strings newreader(``)\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 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" "g8ia4wm6rtqr4l9fpzqg1" }, "results" { "languages" \[ { "id" "i0gtwmksfelwmebteqifj", "language" "200", "customlabel" "", "code" "\[\n {\n \\"firstname\\" \\"^(\[^0 9]{2,255})$\\",\n \\"lastname\\" \\"^(\[^0 9]{2,255})$\\",\n \\"currency\\" \\"gbp\\",\n \\"address\\" \\"^ {1,255}\\",\n \\"city\\" \\"^ {1,255}\\",\n \\"postalcode\\" \\"^ {1,12}$\\",\n \\"countrycode\\" \\"us\\",\n \\"routingcodetype1\\" \\"sortcode\\",\n \\"routingcodevalue1\\" \\"^\\\\\\\d{6}$\\",\n \\"bankname\\" \\"^ {1,255}\\",\n \\"bankcountrycode\\" \\"gb\\",\n \\"receiveraccountnumber\\" \\"^\\\\\\\d{8}$\\",\n \\"entitytype\\" \\"individual\\",\n \\"paymentnetwork\\" \\"regular\\",\n \\"priority\\" false\n }\n]" } ], "selectedlanguageid" "i0gtwmksfelwmebteqifj" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "currency", "kind" "required", "type" "string", "description" "currency the customer is converting funds into 3 letter iso currency code ", "" "currency the customer is converting funds into 3 letter iso currency code " }, { "name" "beneficiarycountrycode", "kind" "required", "type" "string", "description" "two letter iso home bank country code for a company entity, the country where it's registered for an individual, the country where they're based ", "" "two letter iso home bank country code for a company entity, the country where it's registered for an individual, the country where they're based " }, { "name" "bankcountrycode", "kind" "required", "type" "string", "description" "two letter iso transfer bank country code for a company entity, the country where it's registered for an individual, the country where they're based ", "" "two letter iso transfer bank country code for a company entity, the country where it's registered for an individual, the country where they're based " }, { "name" "entitytype", "kind" "optional", "type" "string", "description" "legal status of the entity, whether beneficiary or originator \n individual\n company\n the default value is individual ", "children" \[] }, { "name" "priority", "kind" "optional", "type" "boolean", "description" "true if the transfer is via swift otherwise false if you don't supply a value, the default is false ", "children" \[] }, { "name" "pagenumber", "kind" "optional", "type" "integer", "description" "number of items per page in a paginated response ", "" "number of items per page in a paginated response " }, { "name" "pagesize", "kind" "optional", "type" "integer", "description" "number of items per page in a paginated response ", "" "number of items per page in a paginated response " } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" }, "response" \[ { "name" "firstname", "kind" "optional", "type" "string", "description" "first name of the beneficiary of the funds required if entitytype is individual " }, { "name" "lastname", "kind" "optional", "type" "string", "description" "last name of the beneficiary of the funds required if entitytype is individual ", "children" \[] }, { "name" "companyname", "kind" "optional", "type" "string", "description" "name of the beneficiary company required if entitytype is company ", "children" \[] }, { "name" "currency", "kind" "optional", "type" "string", "description" "currency the customer is converting funds into 3 letter iso currency code ", "children" \[] }, { "name" "address", "kind" "optional", "type" "string", "description" "complete beneficiary street address ", "children" \[] }, { "name" "city", "kind" "optional", "type" "string", "description" "beneficiary city ", "children" \[] }, { "name" "stateprovince", "kind" "optional", "type" "string", "description" "beneficiary state or province", "children" \[] }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "beneficiary postal or zip code ", "children" \[] }, { "name" "countrycode", "kind" "optional", "type" "string", "description" "two letter iso country code for a company entity, the country where it's registered for an individual, the country where they're based ", "children" \[] }, { "name" "routingcodetype1", "kind" "optional", "type" "string", "description" "local payment routing system type if supplied, you must also give the actual code for routingcodevalue1 \n\n sortcode (uk, ireland)\n aba (united states)\n bsbcode (australia)\n institutionno\n bankcode\n branchcode\n clabe (mexico)\n cnaps (china)\n ifsc", "children" \[] }, { "name" "routingcodevalue1", "kind" "optional", "type" "string", "description" "routing code of the routing code type \nrequired if you supply a value for routingcodetype1 ", "children" \[] }, { "name" "routingcodetype2", "kind" "optional", "type" "string", "description" "sometimes certain corridors will require 2 routing codes in that case, use this attribute for the second code type if supplied, you must also give the actual code for routingcodevalue2 \n\n sortcode (uk, ireland)\n aba (united states)\n bsbcode (australia)\n institutionno\n bankcode\n branchcode\n clabe (mexico)\n cnaps (china)\n ifsc", "children" \[] }, { "name" "routingcodevalue2", "kind" "optional", "type" "string", "description" "routing code of the routing code type \nrequired if you supplied a value for routingcodetype2 ", "children" \[] }, { "name" "bicswift", "kind" "optional", "type" "string", "description" "bic/swift code of the beneficiary fi", "children" \[] }, { "name" "iban", "kind" "optional", "type" "string", "description" "iban number of the beneficiary fi", "children" \[] }, { "name" "bankname", "kind" "optional", "type" "string", "description" "name of the beneficiary's bank", "children" \[] }, { "name" "bankcountrycode", "kind" "optional", "type" "string", "description" "two letter code for the country where the beneficiary's bank account is held", "children" \[] }, { "name" "bankaddress", "kind" "optional", "type" "string", "description" "street address of the beneficiary's bank", "children" \[] }, { "name" "receiveraccountnumber", "kind" "optional", "type" "string", "description" "account number of the beneficiary", "children" \[] }, { "name" "entitytype", "kind" "optional", "type" "string", "description" "legal status of the entity, whether beneficiary or originator \n\n individual\n company\n\nthe default value is individual ", "children" \[] }, { "name" "paymentnetwork", "kind" "optional", "type" "string", "description" " regular\n priority", "children" \[] }, { "name" "priority", "kind" "optional", "type" "boolean", "description" "true if the transfer is via swift otherwise false if you don't supply a value, the default is false ", "children" \[] } ], "hastryitout" false, "autogeneratedanchorslug" "endpoint internationalv1metaquote requirements", "legacyhash" "asjihnjs0uonlrznnxnbq" } for additional information, refer to our docid\ mz2n7dqz5peg7vglhdowm tutorial