Payments
...
OFAC APIs
OFAC scan by IDs
1 min
{ "name" "endpoint /api/ofacscan/{scanid}/{sourcesenderid}", "method" "get", "url" "https //pushtopaystaging crbnj net/api/ofacscan/{scanid}/{sourcesenderid}", "description" "returns details showing compliance with international transaction screening requirements the api makes the request based on the scanid and the sourcesender (partner) identifier ", "tab" "examples", "examples" { "languages" \[ { "id" "4tlt8fkq7a8asi8s241qr", "language" "curl", "code" "curl l x get 'https //pushtopaystaging crbnj net/api/ofacscan/5c90e10f e1c1 4094 981b 0c0cda2766e9/37c62197 a158 4110 a013 b305008b2d43' ^\n h 'content type application/json' ^\n h 'authorization bearer token' ^\n d '{\n \\"requestid\\" \\"57c39d38 f780 4917 babe ff67fb44b882\\",\n \\"cardtoken\\" \\"dc57d6a268374505bc7ea37a461bb69d000000\\" \n}'", "customlabel" "" }, { "id" "6rircfhbu5xehneg8jfp1", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //pushtopaystaging crbnj net/api/ofacscan/5c90e10f e1c1 4094 981b 0c0cda2766e9/37c62197 a158 4110 a013 b305008b2d43',\n 'headers' {\n 'content type' 'application/json',\n 'authorization' 'bearer token'\n },\n body json stringify({\n \\"requestid\\" \\"57c39d38 f780 4917 babe ff67fb44b882\\",\n \\"cardtoken\\" \\"dc57d6a268374505bc7ea37a461bb69d000000\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "rkgt6mrx4wq72iennaea1", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //pushtopaystaging crbnj net/api/ofacscan/5c90e10f e1c1 4094 981b 0c0cda2766e9/37c62197 a158 4110 a013 b305008b2d43\\"\n\npayload = json dumps({\n \\"requestid\\" \\"57c39d38 f780 4917 babe ff67fb44b882\\",\n \\"cardtoken\\" \\"dc57d6a268374505bc7ea37a461bb69d000000\\"\n})\nheaders = {\n 'content type' 'application/json',\n 'authorization' 'bearer token'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "lco bhluyj kurcos9e96", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //pushtopaystaging crbnj net/api/ofacscan/5c90e10f e1c1 4094 981b 0c0cda2766e9/37c62197 a158 4110 a013 b305008b2d43\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest\[\\"authorization\\"] = \\"bearer token\\"\nrequest body = json dump({\n \\"requestid\\" \\"57c39d38 f780 4917 babe ff67fb44b882\\",\n \\"cardtoken\\" \\"dc57d6a268374505bc7ea37a461bb69d000000\\"\n})\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" }, { "id" "wezrd4gd7dpqmbg69 1bv", "language" "go", "code" "package main\n\nimport (\n \\"fmt\\"\n \\"strings\\"\n \\"net/http\"\n \\"io\\"\n)\n\nfunc main() {\n\n url = \\"https //pushtopaystaging crbnj net/api/ofacscan/5c90e10f e1c1 4094 981b 0c0cda2766e9/37c62197 a158 4110 a013 b305008b2d43\\"\n method = \\"get\\"\n\n payload = strings newreader(`{`+\\"\n\\"+`\n \\"requestid\\" \\"57c39d38 f780 4917 babe ff67fb44b882\\",`+\\"\n\\"+`\n \\"cardtoken\\" \\"dc57d6a268374505bc7ea37a461bb69d000000\\" `+\\"\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(\\"content type\\", \\"application/json\\")\n req header add(\\"authorization\\", \\"bearer token\\")\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" "4tlt8fkq7a8asi8s241qr" }, "results" { "languages" \[ { "id" "i7wxtf6ddersqeozqdz f", "language" "200", "customlabel" "", "code" "{\n \\"version\\" \\"1 0 0 0\\",\n \\"result\\" {\n \\"requestid\\" \\"5c90e10f e1c1 4094 981b 0c0cda2766e9\\",\n \\"creditcardtoken\\" \\"dc57d6a268374505bc7ea37a461bb69d000000\\",\n \\"error\\" null,\n \\"requestedat\\" \\"2025 07 02t10 38 05 657\\",\n \\"respondedat\\" \\"2025 07 02t10 38 09 04\\",\n \\"updatedat\\" \\"2025 07 02t10 38 09 04\\",\n \\"status\\" \\"allowed\\"\n },\n \\"issuccessfull\\" true,\n \\"issuccessful\\" true\n}" } ], "selectedlanguageid" "i7wxtf6ddersqeozqdz f" }, "request" { "pathparameters" \[ { "name" "scanid", "kind" "required", "type" "string", "description" "matches the requestid found in the response use this guid to identify this scan at a later time \nnote this is the requestid you sent in a specific ofacscan call ", "" "matches the requestid found in the response use this guid to identify this scan at a later time \nnote this is the requestid you sent in a specific ofacscan call " }, { "name" "sourcesenderid", "kind" "required", "type" "string", "description" "the guid that identifies the merchant partner", "" "required" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" }, "response" \[ { "name" "requestid", "kind" "optional", "type" "string", "description" "matches the requestid found in the request for information on international transaction screening" }, { "name" "creditcardtoken", "kind" "optional", "type" "string", "description" "created when intially signing up a card a randomly generated string of characters that relates to the consumer's payment card (15 to 38 alphanumeric characters) matches the creditcardtoken ", "children" \[] }, { "name" "error", "kind" "optional", "type" "string", "description" "a numeric code that describes any error that could happen during the ofac compliance check", "children" \[] }, { "name" "requestedat", "kind" "optional", "type" "string", "description" "the date and time you requested the ofac transaction \nin this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "respondedat", "kind" "optional", "type" "string", "description" "the actual date and time the ofac service sent the response \nin this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "updatedat", "kind" "optional", "type" "string", "description" "the date and time cross river received the ofac status change after checking for cardholders that could be matches (“hits”) verifies whether transaction was allowed or rejected status changes not yet available \nin this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" " hit either the entity is a suspect on the ofac list, or the check is still in progress \n\n allowed the entity can transact ", "children" \[] } ] }