Payments
...
Transaction mgmt APIs
Request funds
1 min
{ "name" "endpoint /api/pulltransaction/", "method" "post", "url" "https //pullfromcardapistg crbnj net/api/pulltransaction/", "description" "pulls funds from a registered card \nyou also use this call for account funding transactions (aft), which pull funds from a specific account for use in a non merchant account for example, use this to load a prepaid card, top up a wallet, or fund a person to person (p2p) money transfer \nthe api response includes the card token, amount transferred, and a transaction status that indicates success or failure ", "tab" "examples", "examples" { "languages" \[ { "id" "zoynkx92ua8fjh58r pfe", "language" "curl", "code" "curl l 'https //pullfromcardapistg crbnj net/api/pulltransaction' ^\n h 'content type application/json' ^\n h 'authorization bearer token' ^\n d '{\n \\"requestid\\" \\"f6ef8097 7602 451a 8b37 e568e2d628ae\\",\n \\"cardtoken\\" \\"a5d4b6aa33a64f718a49b18fe0cdc6af000000\\",\n \\"amount\\" 200,\n \\"sourcesendername\\" \\"my company\\"\n}'", "customlabel" "" }, { "id" "3moce0pdehc1g2h0v7t9 ", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' 'https //pullfromcardapistg crbnj net/api/pulltransaction',\n 'headers' {\n 'content type' 'application/json',\n 'authorization' 'bearer eyjhbgcioijsuzi1niisimtpzci6ijdqrej4dgvldl9imxhprk9xeehvn19rrkdxncising1dci6ijdqrej4dgvldl9imxhprk9xeehvn19rrkdxncisinr5cci6ikpxvcj9 eyjpc3mioijodhrwczovl29hdxrodgvzdc5jcmjuai5uzxqilcjuymyioje3nte0mzk1mdqsimlhdci6mtc1mtqzotuwncwizxhwijoxnzuxndqzmta0lcjhdwqiolsiy3jiyxbpiiwiahr0chm6ly9vyxv0ahrlc3quy3jibmoubmv0l3jlc291cmnlcyjdlcjzy29wzsi6wyjjcmjhcgkixswiy2xpzw50x2lkijoiufrqrvjouk1tdgddbgllbnqilcjyb2xlijoic2vjuhrwzufwavn0z0v4dcisimp0asi6iky4ruu2qziyouqynky5otgzrjc4nevemkzcmum0mdcxin0 nkb4rvviw vdnokv5ncgmrompcznbdac5wod7cijirrana1hpt7x4ymbwag2vqtahc5vffbcpsbakzsogyim9iian194p2cghzatcne5uauivqyj2xgnhbr0h8pak1a0j3rsbeoikwcuwi83hpwudy pvxw9fzxsqskiwkpp6u5jiintjjwim0ugx9xfusu3szoamj9rwkwpq 93lnciggxuwfqono3etwzlz8pfmyutbm031ebuobf8ckd0atbkah5m1pcza13xytsbnscinfbvsy0uiqoilok5w jaw40rusop 8pbp4aj 7qlhzppicobaitualpv zubgb33wg'\n },\n body json stringify({\n \\"requestid\\" \\"e9fb0813 fa52 4b4c a0d2 705fc0478dcc\\",\n \\"cardtoken\\" \\"a5d4b6aa33a64f718a49b18fe0cdc6af000000\\",\n \\"amount\\" 200,\n \\"sourcesendername\\" \\"my company\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "xh yizosvjyg3uk jlhc ", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //pullfromcardapistg crbnj net/api/pulltransaction\\"\n\npayload = json dumps({\n \\"requestid\\" \\"31c621ba 95db 4176 afb3 40f5ed09d4ce\\",\n \\"cardtoken\\" \\"a5d4b6aa33a64f718a49b18fe0cdc6af000000\\",\n \\"amount\\" 200,\n \\"sourcesendername\\" \\"my company\\"\n})\nheaders = {\n 'content type' 'application/json',\n 'authorization' 'bearer eyjhbgcioijsuzi1niisimtpzci6ijdqrej4dgvldl9imxhprk9xeehvn19rrkdxncising1dci6ijdqrej4dgvldl9imxhprk9xeehvn19rrkdxncisinr5cci6ikpxvcj9 eyjpc3mioijodhrwczovl29hdxrodgvzdc5jcmjuai5uzxqilcjuymyioje3nte0mzk1mdqsimlhdci6mtc1mtqzotuwncwizxhwijoxnzuxndqzmta0lcjhdwqiolsiy3jiyxbpiiwiahr0chm6ly9vyxv0ahrlc3quy3jibmoubmv0l3jlc291cmnlcyjdlcjzy29wzsi6wyjjcmjhcgkixswiy2xpzw50x2lkijoiufrqrvjouk1tdgddbgllbnqilcjyb2xlijoic2vjuhrwzufwavn0z0v4dcisimp0asi6iky4ruu2qziyouqynky5otgzrjc4nevemkzcmum0mdcxin0 nkb4rvviw vdnokv5ncgmrompcznbdac5wod7cijirrana1hpt7x4ymbwag2vqtahc5vffbcpsbakzsogyim9iian194p2cghzatcne5uauivqyj2xgnhbr0h8pak1a0j3rsbeoikwcuwi83hpwudy pvxw9fzxsqskiwkpp6u5jiintjjwim0ugx9xfusu3szoamj9rwkwpq 93lnciggxuwfqono3etwzlz8pfmyutbm031ebuobf8ckd0atbkah5m1pcza13xytsbnscinfbvsy0uiqoilok5w jaw40rusop 8pbp4aj 7qlhzppicobaitualpv zubgb33wg'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "tuxybm 3fpfhtugab fm ", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //pullfromcardapistg crbnj net/api/pulltransaction\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest\[\\"authorization\\"] = \\"bearer token\\"\nrequest body = json dump({\n \\"requestid\\" \\"bc569ee7 d19c 4c94 8ec9 97604b07024e\\",\n \\"cardtoken\\" \\"a5d4b6aa33a64f718a49b18fe0cdc6af000000\\",\n \\"amount\\" 200,\n \\"sourcesendername\\" \\"my company\\"\n})\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" }, { "id" "jaavj53d7t967kkoycgy4", "language" "go", "code" "package main\n\nimport (\n \\"fmt\\"\n \\"strings\\"\n \\"net/http\"\n \\"io\\"\n)\n\nfunc main() {\n\n url = \\"https //pullfromcardapistg crbnj net/api/pulltransaction\\"\n method = \\"post\\"\n\n payload = strings newreader(`{`+\\"\n\\"+`\n \\"requestid\\" \\"9c17a55c 2bcf 45b9 94ad 532cbf588aa6\\",`+\\"\n\\"+`\n \\"cardtoken\\" \\"a5d4b6aa33a64f718a49b18fe0cdc6af000000\\",`+\\"\n\\"+`\n \\"amount\\" 200,`+\\"\n\\"+`\n \\"sourcesendername\\" \\"my company\\"`+\\"\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" "zoynkx92ua8fjh58r pfe" }, "results" { "languages" \[ { "id" "km32rfn hozt8m6poxysh", "language" "200", "customlabel" "", "code" "{\n \\"version\\" \\"1 0 0 0\\",\n \\"result\\" {\n \\"transactionrequestid\\" \\"174d1bfa be7e 4bdc b74e 983118b84a36\\",\n \\"amount\\" 200,\n \\"originalamount\\" 200,\n \\"transactionrequestedat\\" \\"2025 07 02t07 22 27 881564z\\",\n \\"transactionstatus\\" \\"succeeded\\",\n \\"errordescription\\" null,\n \\"creditcardid\\" \\"a5d4b6aa33a64f718a49b18fe0cdc6af000000\\",\n \\"railid\\" \\"visadirect\\",\n \\"network\\" \\"visa\\",\n \\"retrievalreferenceid\\" \\"518307216716\\",\n \\"actualtransactiondoneat\\" \\"2025 07 02t07 22 27 9133011z\\",\n \\"requestapproved\\" true,\n \\"responsereceived\\" true,\n \\"responsecode\\" \\"00\\",\n \\"responsedescription\\" \\"approved\\",\n \\"tracenumber\\" \\"216716\\",\n \\"error\\" null,\n \\"requestername\\" null,\n \\"requestermcc\\" null,\n \\"programid\\" null,\n \\"businesstype\\" \\"fd\\"\n },\n \\"issuccessfull\\" true,\n \\"issuccessful\\" true\n}" } ], "selectedlanguageid" "km32rfn hozt8m6poxysh" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "merchanttransactionsidentifiersid", "kind" "optional", "type" "string", "description" "identifier of the merchant's transaction", "" "identifier of the merchant's transaction" }, { "name" "requesterid", "kind" "optional", "type" "string", "description" "the merchant partner unique identifier 32 hexadecimal characters ", "" "optional" }, { "name" "requestername", "kind" "optional", "type" "string", "description" "the name of the merchant", "" "optional" }, { "name" "requestermcc", "kind" "optional", "type" "string", "description" "merchant category code (mcc) 4 digits that a credit card issuer uses to categorize consumer transactions for their card ", "" "optional" }, { "name" "cvv", "kind" "optional", "type" "string", "description" "personal customer code on the card note add the cvv to a function call only when you add a card (post /api/card) the api never returns cvv when you perform a get or put call ", "children" \[] }, { "name" "acceptpartialamount", "kind" "optional", "type" "boolean", "description" "this field is sent only to participating issuers \n\nenter a value of true if partially approved transactions can be accepted \n\nfalse partial authorization not supported (default)\n\ntrue partial authorization supported", "children" \[] }, { "name" "requestid", "kind" "required", "type" "string", "description" "the guid that enables the application to link request with response", "children" \[] }, { "name" "cardtoken", "kind" "required", "type" "string", "description" "a randomly generated string of characters that relates to the consumer's payment card (15 38 alphanumeric characters) matches the creditcardtoken in the response ", "children" \[] }, { "name" "amount", "kind" "required", "type" "integer", "description" "the amount to be transferred, in cents for example, 10001 = $100 01 ", "" "integer" }, { "name" "programid", "kind" "optional", "type" "integer", "description" "populate this attribute when you want to connect a transaction to a given sub merchant network program id (visa mvv, mastercard mcid) \n\notherwise, your merchant level program id is added automatically you don't need to enter it ", "children" \[] }, { "name" "sourceaddress", "kind" "optional", "type" "object", "description" "use this field to append online transaction data to the statement descriptor, for example to use a sub merchant address instead of the merchant address", "children" \[ { "name" "sourcecity", "kind" "optional", "type" "string", "description" "city full name" }, { "name" "sourcecountrycode", "kind" "optional", "type" "string", "description" "2 letter iso country code" }, { "name" "sourcestate", "kind" "optional", "type" "string", "description" "state name we recommend you enter the 2 character state code " } ], "schema" \[ { "name" "sourcecity", "kind" "optional", "type" "string", "description" "city full name" }, { "name" "sourcecountrycode", "kind" "optional", "type" "string", "description" "2 letter iso country code" }, { "name" "sourcestate", "kind" "optional", "type" "string", "description" "state name we recommend you enter the 2 character state code " } ] }, { "name" "correspondingentity", "kind" "optional", "type" "object", "description" "the name and address details of the sender of a push transaction or receiver of a pull transaction \n\nimportant this attribute is required in transactions that are account to account (a2a) or person to person (p2p) ", "children" \[ { "name" "firstname", "kind" "required", "type" "string", "description" "the first name of the sender of a push transaction or receiver of a pull transaction maximum 35 characters " }, { "name" "lastname", "kind" "required", "type" "string", "description" "the last name of the sender of a push transaction or receiver of a pull transaction maximum 35 characters " }, { "name" "accountnumber", "kind" "required", "type" "string", "description" "the account number of the sender or receiver in a transaction from 13 to 19 alphanumeric characters " }, { "name" "address", "kind" "optional", "type" "object", "description" "the address of the sender of a push transaction or receiver of a pull transaction", "children" \[ { "name" "addressline1", "kind" "required", "type" "string", "description" "street address of transaction sender or receiver maximum 99 characters" }, { "name" "city", "kind" "required", "type" "string", "description" "city of transaction sender or receiver maximum 25 characters " }, { "name" "state", "kind" "optional", "type" "string", "description" "2 letter code of the state of transaction sender or receiver" }, { "name" "countrycode", "kind" "required", "type" "string", "description" "2 letter code of the country of transaction sender or receiver" }, { "name" "zipcode", "kind" "required", "type" "string", "description" "5 digit us postal code (\\"zip code\\") of transaction sender or receiver" } ] } ] }, { "name" "businesstype", "kind" "optional", "type" "string", "description" " one of bb, fd, aa, pp, bi, cd, ft, wt, cp", "" " one of bb, fd, aa, pp, bi, cd, ft, wt, cp" } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "response" \[ { "name" "transactionrequestid", "kind" "optional", "type" "string", "description" "unique customer generated transaction request" }, { "name" "amount", "kind" "optional", "type" "integer", "description" "the amount to be transferred, in cents for example, 10001 = $100 01 \n\nif the consumer is enabled for partial authorization, this field will present the actual amount approved by the card issuer (that was pulled from the cardholder account) ", "children" \[] }, { "name" "originalamount", "kind" "optional", "type" "integer", "description" "this attribute appears in a partially authorized aft transaction \n\nthe original transaction amount (amount value in the aft request), represented in the transaction currency (sendercurrencycode value in aft request) \n\nif partial authorization is not enabled, the value be the requested and approved transaction amount ", "children" \[] }, { "name" "transactionrequestedat", "kind" "optional", "type" "string", "description" "date and time of the request (gmt)", "children" \[] }, { "name" "transactionstatus", "kind" "optional", "type" "string", "description" "transaction status \n\n pending\n succeeded \n failed\n rejected", "children" \[] }, { "name" "errordescription", "kind" "optional", "type" "string", "description" "a description of the error, if relevant", "children" \[] }, { "name" "creditcardid", "kind" "optional", "type" "string", "description" "card token of the signed up debit card", "children" \[] }, { "name" "railid", "kind" "optional", "type" "string", "description" "the payment processor used to perform the transaction \n\n rs2\n mcsend\n tabapay\n visadirect", "children" \[] }, { "name" "network", "kind" "optional", "type" "string", "description" "name of the payment card network", "children" \[] }, { "name" "retrievalreferenceid", "kind" "optional", "type" "string", "description" "the number cross river creates that is passed to the rail to assist in tracing a transaction after it left our system", "children" \[] }, { "name" "actualtransactiondoneat", "kind" "optional", "type" "string", "description" "the date and time the transaction was sent to the payment processor", "children" \[] }, { "name" "requestapproved", "kind" "optional", "type" "boolean", "description" "true if a request was approved, otherwise false", "children" \[] }, { "name" "responsereceived", "kind" "optional", "type" "boolean", "description" "true if a response was received, otherwise false", "children" \[] }, { "name" "responsecode", "kind" "optional", "type" "string", "description" "a 2 digit code signifying the transaction result (approved or decline) for example, 00 means successful ", "children" \[] }, { "name" "responsedescription", "kind" "optional", "type" "string", "description" "a string describing the transaction result for example, approved ", "children" \[] }, { "name" "tracenumber", "kind" "optional", "type" "string", "description" "a unique number assigned to a transaction from the time it leaves the merchant bank until it arrives at the cardholder bank", "children" \[] }, { "name" "error", "kind" "optional", "type" "string", "description" "a description of the error, if relevant", "children" \[] }, { "name" "requestername", "kind" "optional", "type" "string", "description" "merchant name", "children" \[] }, { "name" "requestermcc", "kind" "optional", "type" "string", "description" "merchant category code (mcc) 4 digits that a credit card issuer uses to categorize consumer transactions for their card ", "children" \[] }, { "name" "programid", "kind" "optional", "type" "string", "description" "connects a transaction to a given sub merchant network program id (visa mvv, mastercard mcid)", "children" \[] }, { "name" "businesstype", "kind" "optional", "type" "string", "description" " one of bb, fd, aa, pp, bi, cd, ft, wt, cp", "children" \[] } ] } business types